ListTrafficDistributionGroupUsers
Lists traffic distribution group users.
Request Syntax
GET /traffic-distribution-group/TrafficDistributionGroupId
/user?maxResults=MaxResults
&nextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- 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.
- TrafficDistributionGroupId
-
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.
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: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"TrafficDistributionGroupUserSummaryList": [
{
"UserId": "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
- TrafficDistributionGroupUserSummaryList
-
A list of traffic distribution group users.
Type: Array of TrafficDistributionGroupUserSummary 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
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
Examples
Example
The following example lists traffic distribution group users.
Sample Request
GET connect.[region].amazonaws.com/traffic-distribution-group/[traffic_distribution_group_id]/user
Sample Response
{
"TrafficDistributionGroupUserSummaryList": [
{
"UserId": "[user_id]"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: