TrafficDistributionGroup - Amazon Connect

TrafficDistributionGroup

Information about a traffic distribution group.

Contents

Arn

The Amazon Resource Name (ARN) of the traffic distribution group.

Type: String

Pattern: ^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: No

Description

The description of the traffic distribution group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 250.

Pattern: (^[\S].*[\S]$)|(^[\S]$)

Required: No

Id

The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: No

InstanceArn

The Amazon Resource Name (ARN).

Type: String

Pattern: arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9-]{1}:[0-9]{1,20}:instance/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: No

IsDefault

Whether this is the default traffic distribution group created during instance replication. The default traffic distribution group cannot be deleted by the DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as part of the process for deleting a replica.

Note

The SignInConfig distribution is available only on a default TrafficDistributionGroup (see the IsDefault parameter in the TrafficDistributionGroup data type). If you call UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup, an InvalidRequestException is returned.

Type: Boolean

Required: No

Name

The name of the traffic distribution group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (^[\S].*[\S]$)|(^[\S]$)

Required: No

Status

The status of the traffic distribution group.

Type: String

Valid Values: CREATION_IN_PROGRESS | ACTIVE | CREATION_FAILED | PENDING_DELETION | DELETION_FAILED | UPDATE_IN_PROGRESS

Required: No

Tags

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

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: