/AWS1/CL_SSADESCRINSTRESPONSE¶
DescribeInstanceResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_instancearn TYPE /AWS1/SSAINSTANCEARN /AWS1/SSAINSTANCEARN¶
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.
iv_identitystoreid TYPE /AWS1/SSAID /AWS1/SSAID¶
The identifier of the identity store that is connected to the instance of IAM Identity Center.
iv_owneraccountid TYPE /AWS1/SSAACCOUNTID /AWS1/SSAACCOUNTID¶
The identifier of the Amazon Web Services account for which the instance was created.
iv_name TYPE /AWS1/SSANAMETYPE /AWS1/SSANAMETYPE¶
Specifies the instance name.
iv_createddate TYPE /AWS1/SSADATE /AWS1/SSADATE¶
The date the instance was created.
iv_status TYPE /AWS1/SSAINSTANCESTATUS /AWS1/SSAINSTANCESTATUS¶
The status of the instance.
iv_statusreason TYPE /AWS1/SSAREASON /AWS1/SSAREASON¶
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.
io_encryptionconfdetails TYPE REF TO /AWS1/CL_SSAENCCONFDETAILS /AWS1/CL_SSAENCCONFDETAILS¶
Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.
Queryable Attributes¶
InstanceArn¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCEARN() |
Getter for INSTANCEARN, with configurable default |
ASK_INSTANCEARN() |
Getter for INSTANCEARN w/ exceptions if field has no value |
HAS_INSTANCEARN() |
Determine if INSTANCEARN has a value |
IdentityStoreId¶
The identifier of the identity store that is connected to the instance of IAM Identity Center.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IDENTITYSTOREID() |
Getter for IDENTITYSTOREID, with configurable default |
ASK_IDENTITYSTOREID() |
Getter for IDENTITYSTOREID w/ exceptions if field has no val |
HAS_IDENTITYSTOREID() |
Determine if IDENTITYSTOREID has a value |
OwnerAccountId¶
The identifier of the Amazon Web Services account for which the instance was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OWNERACCOUNTID() |
Getter for OWNERACCOUNTID, with configurable default |
ASK_OWNERACCOUNTID() |
Getter for OWNERACCOUNTID w/ exceptions if field has no valu |
HAS_OWNERACCOUNTID() |
Determine if OWNERACCOUNTID has a value |
Name¶
Specifies the instance name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
CreatedDate¶
The date the instance was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDDATE() |
Getter for CREATEDDATE, with configurable default |
ASK_CREATEDDATE() |
Getter for CREATEDDATE w/ exceptions if field has no value |
HAS_CREATEDDATE() |
Determine if CREATEDDATE has a value |
Status¶
The status of the instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
StatusReason¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |
EncryptionConfigurationDetails¶
Contains the encryption configuration for your IAM Identity Center instance, including the encryption status, KMS key type, and KMS key ARN.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENCRYPTIONCONFDETAILS() |
Getter for ENCRYPTIONCONFDETAILS |