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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
gatewayArn | String | True | The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect Gateway. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | DiscoverGatewayPollEndpointResponse | The endpoints for the specified gateway | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | ResponseError | The request that you submitted is not valid. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | ResponseError | You don't have the required permissions to perform this operation. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | ResponseError | MediaConnect did not find the resource that you specified in the request. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ResponseError | There was a conflict when trying to add the requested output | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | ResponseError | You have exceeded the service request rate limit for your MediaConnect account. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | ResponseError | MediaConnect can't fulfill your request because it encountered an unexpected condition. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
503 | ResponseError | 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.
Property | Type | Required | Description |
---|---|---|---|
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.
Property | Type | Required | Description |
---|---|---|---|
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: