ListSegmentDefinitions
Lists all segment definitions under a domain.
Request Syntax
GET /domains/DomainName/segment-definitions?max-results=MaxResults&next-token=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- DomainName
-
The unique identifier of the domain.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9_-]+$Required: Yes
- MaxResults
-
The maximum number of objects returned per page.
Valid Range: Minimum value of 1. Maximum value of 500.
- NextToken
-
The pagination token from the previous call.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Items": [
{
"CreatedAt": number,
"Description": "string",
"DisplayName": "string",
"SegmentDefinitionArn": "string",
"SegmentDefinitionName": "string",
"Tags": {
"string" : "string"
}
}
],
"NextToken": "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.
- Items
-
List of segment definitions.
Type: Array of SegmentDefinitionItem objects
- NextToken
-
The pagination token from the previous call.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- BadRequestException
-
The input you provided is invalid.
HTTP Status Code: 400
- InternalServerException
-
An internal service error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource does not exist, or access was denied.
HTTP Status Code: 404
- ThrottlingException
-
You exceeded the maximum number of requests.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
