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

GetSegmentDefinition

Gets a segment definition from the domain.

Request Syntax


GET /domains/DomainName/segment-definitions/SegmentDefinitionName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

SegmentDefinitionName

The unique name of the segment definition.

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

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "SegmentDefinitionArn": "string",
   "SegmentDefinitionName": "string",
   "SegmentGroups": { 
      "Groups": [ 
         { 
            "Dimensions": [ 
               { ... }
            ],
            "SourceSegments": [ 
               { 
                  "SegmentDefinitionName": "string"
               }
            ],
            "SourceType": "string",
            "Type": "string"
         }
      ],
      "Include": "string"
   },
   "Tags": { 
      "string" : "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.

CreatedAt

The timestamp of when the segment definition was created.

Type: Timestamp

Description

The description of the segment definition.

Type: String

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

DisplayName

The display name of the segment definition.

Type: String

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

SegmentDefinitionArn

The arn of the segment definition.

Type: String

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

SegmentDefinitionName

The name of the segment definition.

Type: String

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

Pattern: ^[a-zA-Z0-9_-]+$

SegmentGroups

The segment criteria associated with this definition.

Type: SegmentGroup object

Tags

The tags used to organize, track, or control access for this resource.

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:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

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