Module Values.DescribeInstanceResponseSource

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.

Sourcetype nonrec t = {
  1. instanceArn : InstanceArn.t option;
    (*

    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.

    *)
  2. identityStoreId : Id.t option;
    (*

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

    *)
  3. ownerAccountId : AccountId.t option;
    (*

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

    *)
  4. name : NameType.t option;
    (*

    Specifies the instance name.

    *)
  5. createdDate : Date.t option;
    (*

    The date the instance was created.

    *)
  6. status : InstanceStatus.t option;
    (*

    The status of the instance.

    *)
  7. statusReason : Reason.t option;
    (*

    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.

    *)
  8. encryptionConfigurationDetails : EncryptionConfigurationDetails.t option;
    (*

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

    *)
}
Sourcetype nonrec error = [
  1. | `AccessDeniedException of AccessDeniedException.t
  2. | `InternalServerException of InternalServerException.t
  3. | `ThrottlingException of ThrottlingException.t
  4. | `ValidationException of ValidationException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?instanceArn:??? -> ?identityStoreId:??? -> ?ownerAccountId:??? -> ?name:??? -> ?createdDate:??? -> ?status:??? -> ?statusReason:??? -> ?encryptionConfigurationDetails:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `AccessDeniedException of AccessDeniedException.t | `InternalServerException of InternalServerException.t | `ThrottlingException of ThrottlingException.t | `Unknown_operation_error of string * string option | `ValidationException of ValidationException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of InstanceArn.t | `Structure of (string * [> `Enum of string | `String of KmsKeyArn.t ]) list | `Timestamp of Date.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t