GetEventStream - Amazon Connect
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetEventStream

Returns information about the specified event stream in a specific domain.

Request Syntax

GET /domains/DomainName/event-streams/EventStreamName 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

EventStreamName

The name of the event stream provided during create operations.

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,
   "DestinationDetails": { 
      "Message": "string",
      "Status": "string",
      "UnhealthySince": number,
      "Uri": "string"
   },
   "DomainName": "string",
   "EventStreamArn": "string",
   "State": "string",
   "StoppedSince": number,
   "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 export was created.

Type: Timestamp

DestinationDetails

Details regarding the Kinesis stream.

Type: EventStreamDestinationDetails object

DomainName

The unique name of the domain.

Type: String

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

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

EventStreamArn

A unique identifier for the event stream.

Type: String

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

State

The operational state of destination stream for export.

Type: String

Valid Values: RUNNING | STOPPED

StoppedSince

The timestamp when the State changed to STOPPED.

Type: Timestamp

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: