Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeGateway

Describes a gateway, including its configuration, status, and the type-specific infrastructure settings that it uses.

Request Syntax


{
   "gateway": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

gateway

The name or Amazon Resource Name (ARN) of the gateway to describe.

Type: String

Required: Yes

Response Syntax


{
   "gateway": { 
      "accessType": "string",
      "configuration": { ... },
      "createdAt": number,
      "deletionProtection": boolean,
      "failures": [ 
         { 
            "arn": "string",
            "errors": [ 
               { 
                  "code": "string",
                  "message": "string",
                  "operation": "string"
               }
            ]
         }
      ],
      "gatewayArn": "string",
      "infrastructureRoleArn": "string",
      "name": "string",
      "propagateTags": "string",
      "status": "string",
      "statusReason": "string",
      "tags": [ 
         { 
            "key": "string",
            "value": "string"
         }
      ],
      "updatedAt": number
   }
}

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.

gateway

The details of the gateway.

Type: Gateway object

Errors

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

AccessDeniedException

You don't have authorization to perform the requested action.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

ClientException

These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

GatewayNotFoundException

The specified gateway wasn't found. Check that the gateway name or ARN is correct and that the gateway exists in your account and Region.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

InvalidParameterException

The specified parameter isn't valid. Review the available parameters for the API request.

For more information about service event errors, see Amazon ECS service event messages.

message: Message that describes the cause of the exception.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

message: Message that describes the cause of the exception.

HTTP Status Code: 500

UnsupportedFeatureException

The specified task isn't supported in this Region.

message: Message that describes the cause of the exception.

HTTP Status Code: 400