Instance
The Amazon Connect instance.
Contents
- Arn
-
The Amazon Resource Name (ARN) of the instance.
Type: String
Required: No
- CreatedTime
-
When the instance was created.
Type: Timestamp
Required: No
- Id
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- IdentityManagementType
-
The identity management type.
Type: String
Valid Values:
SAML | CONNECT_MANAGED | EXISTING_DIRECTORYRequired: No
- InboundCallsEnabled
-
Whether inbound calls are enabled.
Type: Boolean
Required: No
- InstanceAccessUrl
-
This URL allows contact center users to access the Amazon Connect admin website.
Type: String
Required: No
- InstanceAlias
-
The alias of instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 45.
Pattern:
^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$Required: No
- InstanceStatus
-
The state of the instance.
Type: String
Valid Values:
CREATION_IN_PROGRESS | ACTIVE | CREATION_FAILEDRequired: No
- OutboundCallsEnabled
-
Whether outbound calls are enabled.
Type: Boolean
Required: No
- ServiceRole
-
The service role of the instance.
Type: String
Required: No
- StatusReason
-
Relevant details why the instance was not successfully created.
Type: InstanceStatusReason object
Required: No
- Tags
-
The tags of an instance.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$Value Length Constraints: Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
