Returns the details of an instance of IAM Identity Center¶

Description¶

Returns the details of an instance of IAM Identity Center. The status can be one of the following:

CREATE_IN_PROGRESS - The instance is in the process of being created. When the instance is ready for use, DescribeInstance returns the status of ACTIVE. While the instance is in the CREATE_IN_PROGRESS state, you can call only DescribeInstance and DeleteInstance operations.
DELETE_IN_PROGRESS - The instance is being deleted. Returns AccessDeniedException after the delete operation completes.
ACTIVE - The instance is active.

Usage¶

ssoadmin_describe_instance(InstanceArn)

Arguments¶

InstanceArn

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

Value¶

A list with the following syntax:

list(
  InstanceArn = "string",
  IdentityStoreId = "string",
  IdentityStoreArn = "string",
  OwnerAccountId = "string",
  Name = "string",
  CreatedDate = as.POSIXct(
    "2015-01-01"
  ),
  Status = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"DELETE_IN_PROGRESS"|"ACTIVE",
  StatusReason = "string",
  PrimaryRegion = "string",
  Regions = list(
    list(
      RegionName = "string",
      Status = "ACTIVE"|"ADDING"|"REMOVING",
      AddedDate = as.POSIXct(
        "2015-01-01"
      ),
      IsPrimaryRegion = TRUE|FALSE
    )
  ),
  EncryptionConfigurationDetails = list(
    KeyType = "AWS_OWNED_KMS_KEY"|"CUSTOMER_MANAGED_KEY",
    KmsKeyArn = "string",
    EncryptionStatus = "UPDATING"|"ENABLED"|"UPDATE_FAILED",
    EncryptionStatusReason = "string"
  ),
  PermissionSetsEnabled = TRUE|FALSE
)

Request syntax¶

svc$describe_instance(
  InstanceArn = "string"
)