Class: Aws::FinSpaceData::Types::User

Inherits:

Struct

• Object
• Struct
• Aws::FinSpaceData::Types::User

Defined in:

gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb

Overview

The details of the user.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:first_name, :last_name, :email_address]

Instance Attribute Summary

• #api_access ⇒ String

  Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

• #api_access_principal_arn ⇒ String

  The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user.

• #create_time ⇒ Integer

  The timestamp at which the user was created in FinSpace.

• #email_address ⇒ String

  The email address of the user.

• #first_name ⇒ String

  The first name of the user.

• #last_disabled_time ⇒ Integer

  Describes the last time the user was deactivated.

• #last_enabled_time ⇒ Integer

  Describes the last time the user was activated.

• #last_login_time ⇒ Integer

  Describes the last time that the user logged into their account.

• #last_modified_time ⇒ Integer

  Describes the last time the user was updated.

• #last_name ⇒ String

  The last name of the user.

• #status ⇒ String

  The current status of the user.

• #type ⇒ String

  Indicates the type of user.

• #user_id ⇒ String

  The unique identifier for the user.

Instance Attribute Details

#api_access ⇒ String

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

• ENABLED – The user has permissions to use the APIs.

• DISABLED – The user does not have permissions to use any APIs.

Returns:

• (String)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#api_access_principal_arn ⇒ String

The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

Returns:

• (String)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#create_time ⇒ Integer

The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#email_address ⇒ String

The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

Returns:

• (String)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#first_name ⇒ String

The first name of the user.

Returns:

• (String)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#last_disabled_time ⇒ Integer

Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#last_enabled_time ⇒ Integer

Describes the last time the user was activated. The value is determined as epoch time in milliseconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#last_login_time ⇒ Integer

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#last_modified_time ⇒ Integer

Describes the last time the user was updated. The value is determined as epoch time in milliseconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#last_name ⇒ String

The last name of the user.

Returns:

• (String)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#status ⇒ String

The current status of the user.

• CREATING – The user creation is in progress.

• ENABLED – The user is created and is currently active.

• DISABLED – The user is currently inactive.

Returns:

• (String)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#type ⇒ String

Indicates the type of user.

• SUPER_USER – A user with permission to all the functionality and data in FinSpace.

• APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

Returns:

• (String)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#user_id ⇒ String

The unique identifier for the user.

Returns:

• (String)

# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 2721

class User < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :create_time,
  :last_enabled_time,
  :last_disabled_time,
  :last_modified_time,
  :last_login_time)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end