URI HTTP methods Schemas Properties See also

Gateway: describe, delete

URI

/v1/gateways/gatewayArn

HTTP methods

GET

Operation ID: DescribeGateway

Displays the details of a gateway. The response includes the gateway ARN, name, and CIDR blocks, as well as details about the networks.

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`	`DescribeGatewayResponse`	AWS Elemental MediaConnect returned the gateway details successfully.
`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.

DELETE

Operation ID: DeleteGateway

Deletes a gateway. Before you can delete a gateway, you must deregister its instances and delete its bridges.

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`	`DeleteGatewayResponse`	AWS Elemental MediaConnect deleted the gateway.
`202`	`DeleteGatewayResponse`	MediaConnect is starting the flow.
`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


{
  "gateway": {
    "egressCidrBlocks": [
      "string"
    ],
    "gatewayMessages": [
      {
        "code": "string",
        "resourceName": "string",
        "message": "string"
      }
    ],
    "name": "string",
    "networks": [
      {
        "cidrBlock": "string",
        "name": "string"
      }
    ],
    "gatewayArn": "string",
    "gatewayState": enum
  }
}


{
  "gatewayArn": "string"
}


{
  "message": "string"
}

Properties

DeleteGatewayResponse

The result of a successful DeleteGateway request.

Property	Type	Required	Description
`gatewayArn`	string	True	The ARN of the gateway that was deleted.

DescribeGatewayResponse

The result of a successful DescribeGateway request.

Property	Type	Required	Description
`gateway`	Gateway	True

Gateway

The settings for a gateway, including its networks.

Property	Type	Required	Description
`egressCidrBlocks`	Array of type string	True	The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
`gatewayArn`	string	True	The Amazon Resource Name (ARN) of the gateway.
`gatewayMessages`	Array of type MessageDetail	False
`gatewayState`	string Values: `CREATING \| ACTIVE \| UPDATING \| ERROR \| DELETING \| DELETED`	False	The current status of the gateway.
`name`	string	True	The name of the gateway. This name can not be modified after the gateway is created.
`networks`	Array of type GatewayNetwork	True	The list of networks in the gateway.

GatewayNetwork

The network settings for a gateway.

Property	Type	Required	Description
`cidrBlock`	string	True	A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
`name`	string	True	The name of the network. This name is used to reference the network and must be unique among networks in this gateway.

MessageDetail

Property	Type	Required	Description
`code`	string	True	The error code.
`message`	string	True	The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
`resourceName`	string	False	The name of the resource.

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.