Gateway endpoints: list - AWS Elemental MediaConnect

Gateway endpoints: list

URI

/v1/endpoints/gateway/gatewayArn

HTTP methods

GET

Operation ID: DiscoverGatewayPollEndpoint

Note

This action is only used by the MediaConnect Gateway agent, and it is not intended for use outside of the agent.

Return the gateway poll endpoint(s) for the specified gateway.

Path parameters
NameTypeRequiredDescription
gatewayArnStringTrue

The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect Gateway.

Responses
Status codeResponse modelDescription
200DiscoverGatewayPollEndpointResponse

The endpoints for the specified gateway

400ResponseError

The request that you submitted is not valid.

403ResponseError

You don't have the required permissions to perform this operation.

404ResponseError

MediaConnect did not find the resource that you specified in the request.

409ResponseError

There was a conflict when trying to add the requested output

429ResponseError

You have exceeded the service request rate limit for your MediaConnect account.

500ResponseError

MediaConnect can't fulfill your request because it encountered an unexpected condition.

503ResponseError

MediaConnect is currently unavailable. Try again later.

Schemas

Response bodies

{ "websocketEndpoint": "string", "httpEndpoint": "string" }
{ "message": "string" }

Properties

DiscoverGatewayPollEndpointResponse

The result of a successful DiscoverGatewayPollEndpoint request.

PropertyTypeRequiredDescription
httpEndpoint

string

True

The http endpoint.

websocketEndpoint

string

True

The websocket endpoint.

ResponseError

An exception raised by MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.

PropertyTypeRequiredDescription
message

string

True

The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

See also

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

DiscoverGatewayPollEndpoint