URI HTTP methods Schemas Properties See also

Gateway: list, create

URI

/v1/gateways

HTTP methods

GET

Operation ID: ListGateways

Displays a list of gateways that are associated with this account. This request returns a paginated result.

Query parameters
Name	Type	Required	Description
`nextToken`	String	False	The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.
`maxResults`	String	False	The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.

Responses
Status code	Response model	Description
`200`	`ListGatewaysResponse`	AWS Elemental MediaConnect returned the list of gateways successfully.
`400`	`ResponseError`	The request that you submitted is not valid.
`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.

POST

Operation ID: CreateGateway

Creates a new gateway. The request must include at least one network.

Responses
Status code	Response model	Description
`201`	`DescribeGatewayResponse`	MediaConnect created the new resource successfully.
`400`	`ResponseError`	The request that you submitted is not valid.
`403`	`ResponseError`	You don't have the required permissions to perform this operation.
`409`	`ResponseError`	There was a conflict when trying to add the requested output
`420`	`ResponseError`	Your account already contains the maximum number of 20 flows per account, per Region. For more information, contact AWS Support.
`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

Request bodies


{
  "egressCidrBlocks": [
    "string"
  ],
  "name": "string",
  "networks": [
    {
      "cidrBlock": "string",
      "name": "string"
    }
  ]
}

Response bodies


{
  "gateways": [
    {
      "name": "string",
      "gatewayArn": "string",
      "gatewayState": enum
    }
  ],
  "nextToken": "string"
}


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


{
  "message": "string"
}

Properties

CreateGatewayRequest

Creates a new gateway. The request must include one network (up to 4).

Property	Type	Required	Description
`egressCidrBlocks`	Array of type string	True	The range of IP addresses that are allowed to 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.
`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 that you want to add.

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.

ListGatewaysResponse

The result of a successful ListGateways request. The response includes gateway summaries and the NextToken to use in a subsequent ListGateways request.

Property	Type	Required	Description
`gateways`	Array of type ListedGateway	True	A list of gateway summaries.
`nextToken`	string	False	The token that identifies which batch of results that you want to see. For example, you submit a ListGateways request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListGateways request a second time and specify the NextToken value.

ListedGateway

Provides a summary of a gateway, including its name, ARN, and status.

Property Type Required Description

Property	Type	Required	Description
`gatewayArn`	string	True	The ARN of the gateway.
`gatewayState`	string Values: `CREATING \| ACTIVE \| UPDATING \| ERROR \| DELETING \| DELETED`	True
`name`	string	True	The name of the gateway.

gatewayArn

string

True

The ARN of the gateway.

gatewayState

string

True

name

string

True

The name of the 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.