Class: Aws::SSOAdmin::Types::DescribeInstanceResponse

Inherits:

Struct

• Object
• Struct
• Aws::SSOAdmin::Types::DescribeInstanceResponse

Defined in:

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

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_date ⇒ Time

  The date the instance was created.

• #encryption_configuration_details ⇒ Types::EncryptionConfigurationDetails

  Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.

• #identity_store_id ⇒ String

  The identifier of the identity store that is connected to the instance of IAM Identity Center.

• #instance_arn ⇒ String

  The ARN of the instance of IAM Identity Center under which the operation will run.

• #name ⇒ String

  Specifies the instance name.

• #owner_account_id ⇒ String

  The identifier of the Amazon Web Services account for which the instance was created.

• #status ⇒ String

  The status of the instance.

• #status_reason ⇒ String

  Provides additional context about the current status of the IAM Identity Center instance.

Instance Attribute Details

#created_date ⇒ Time

The date the instance was created.

Returns:

• (Time)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 1634

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :encryption_configuration_details)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configuration_details ⇒ Types::EncryptionConfigurationDetails

Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.

Returns:

• (Types::EncryptionConfigurationDetails)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 1634

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :encryption_configuration_details)
  SENSITIVE = []
  include Aws::Structure
end

#identity_store_id ⇒ String

The identifier of the identity store that is connected to the instance of IAM Identity Center.

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 1634

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :encryption_configuration_details)
  SENSITIVE = []
  include Aws::Structure
end

#instance_arn ⇒ String

The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 1634

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :encryption_configuration_details)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Specifies the instance name.

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 1634

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :encryption_configuration_details)
  SENSITIVE = []
  include Aws::Structure
end

#owner_account_id ⇒ String

The identifier of the Amazon Web Services account for which the instance was created.

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 1634

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :encryption_configuration_details)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the instance.

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 1634

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :encryption_configuration_details)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

Provides additional context about the current status of the IAM Identity Center instance. This field is particularly useful when an instance is in a non-ACTIVE state, such as CREATE_FAILED. When an instance fails to create or update, this field contains information about the cause, which may include issues with KMS key configuration, permission problems with the specified KMS key, or service-related errors.

Returns:

• (String)

# File 'gems/aws-sdk-ssoadmin/lib/aws-sdk-ssoadmin/types.rb', line 1634

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :encryption_configuration_details)
  SENSITIVE = []
  include Aws::Structure
end