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

GetSegmentSubscription

Returns the current subscription configuration, execution schedule, and status for segment membership events.

Request Syntax


GET /domains/DomainName/segment-definitions/SegmentDefinitionName/subscriptions 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

{
   "LastUpdatedAt": number,
   "Message": "string",
   "ScheduleConfiguration": { 
      "Interval": number,
      "Unit": "string"
   },
   "ScheduledExecutions": { 
      "LastExecutedAt": number,
      "NextExecutedAt": number
   },
   "StartedAt": number,
   "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.

LastUpdatedAt

The timestamp of the most recent configuration change.

Type: Timestamp

Message

A status message providing additional context, such as a failure reason.

Type: String

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

ScheduleConfiguration

The schedule configuration for periodic membership event notifications.

Type: ScheduleConfiguration object

ScheduledExecutions

Information about scheduled execution timestamps.

Type: ScheduledExecutions object

StartedAt

The timestamp of when the subscription was first started.

Type: Timestamp

Status

The current lifecycle status of the subscription. The following are valid values:

STARTING: Initial snapshot is in progress.
RUNNING: Notifications are active and running.
STOPPED: Notifications have been stopped.
FAILED: Notifications failed (for example, the Amazon Kinesis data stream became inaccessible).

Type: String

Valid Values: STARTING | RUNNING | STOPPED | FAILED

Errors

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

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