Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListTrafficDistributionGroups

Lists traffic distribution groups.

Request Syntax


GET /traffic-distribution-groups?instanceId=InstanceId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

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}$

MaxResults

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 10.

NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TrafficDistributionGroupSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "InstanceArn": "string",
         "IsDefault": boolean,
         "Name": "string",
         "Status": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

If there are additional results, this is the token for the next set of results.

Type: String

TrafficDistributionGroupSummaryList

A list of traffic distribution groups.

Type: Array of TrafficDistributionGroupSummary objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429