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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssoadmin/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_date ⇒ Time

The date the instance was created.

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :identity_store_arn,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions,
  :encryption_configuration_details,
  :permission_sets_enabled)
  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:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

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

#identity_store_arn ⇒ String

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

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :identity_store_arn,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions,
  :encryption_configuration_details,
  :permission_sets_enabled)
  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:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :identity_store_arn,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions,
  :encryption_configuration_details,
  :permission_sets_enabled)
  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:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

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

#name ⇒ String

Specifies the instance name.

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

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

#owner_account_id ⇒ String

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

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

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

#permission_sets_enabled ⇒ Boolean

Indicates whether permission sets are enabled for this Identity Center instance.

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

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

#primary_region ⇒ String

The primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

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

#regions ⇒ Array<Types::RegionMetadata>

The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

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

#status ⇒ String

The status of the instance.

Returns:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

class DescribeInstanceResponse < Struct.new(
  :instance_arn,
  :identity_store_id,
  :identity_store_arn,
  :owner_account_id,
  :name,
  :created_date,
  :status,
  :status_reason,
  :primary_region,
  :regions,
  :encryption_configuration_details,
  :permission_sets_enabled)
  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:



1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
 
# File 'lib/aws-sdk-ssoadmin/types.rb', line 1728

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