URI HTTP methods Schemas Properties See also

Gateway instance: describe, update, deregister

URI

/v1/gateway-instances/gatewayInstanceArn

HTTP methods

GET

Operation ID: DescribeGatewayInstance

Displays the details of an instance.

Path parameters
Name	Type	Required	Description
`gatewayInstanceArn`	String	True	The ARN of the gateway instance that you want to describe.

Responses
Status code	Response model	Description
`200`	`DescribeGatewayInstanceResponse`	AWS Elemental MediaConnect returned the instance 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.

PUT

Operation ID: UpdateGatewayInstance

Updates the configuration of an existing Gateway Instance.

Path parameters
Name	Type	Required	Description
`gatewayInstanceArn`	String	True	The ARN of the gateway instance that you want to describe.

Responses
Status code	Response model	Description
`200`	`UpdateGatewayInstanceResponse`	AWS Elemental MediaConnect is applying the instance state.
`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: DeregisterGatewayInstance

Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.

Path parameters
Name	Type	Required	Description
`gatewayInstanceArn`	String	True	The ARN of the gateway instance that you want to describe.

Query parameters
Name	Type	Required	Description
`force`	String	False	Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.

Responses
Status code	Response model	Description
`202`	`DeregisterGatewayInstanceResponse`	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

Request bodies


{
  "bridgePlacement": enum
}

Response bodies


{
  "gatewayInstance": {
    "instanceId": "string",
    "instanceState": enum,
    "instanceMessages": [
      {
        "code": "string",
        "resourceName": "string",
        "message": "string"
      }
    ],
    "connectionStatus": enum,
    "gatewayInstanceArn": "string",
    "runningBridgeCount": integer,
    "bridgePlacement": enum,
    "gatewayArn": "string"
  }
}


{
  "gatewayInstanceArn": "string",
  "bridgePlacement": enum
}


{
  "instanceState": enum,
  "gatewayInstanceArn": "string"
}


{
  "message": "string"
}

Properties

DeregisterGatewayInstanceResponse

The gateway instance deregistration was successful.

Property Type Required Description

Property	Type	Required	Description
`gatewayInstanceArn`	string	True	The Amazon Resource Name (ARN) of the instance.
`instanceState`	string Values: `REGISTERING \| ACTIVE \| DEREGISTERING \| DEREGISTERED \| REGISTRATION_ERROR \| DEREGISTRATION_ERROR`	True	The status of the instance.

gatewayInstanceArn

string

True

The Amazon Resource Name (ARN) of the instance.

instanceState

string

True

The status of the instance.

DescribeGatewayInstanceResponse

The result of a successful DescribeGatewayInstance request.

Property	Type	Required	Description
`gatewayInstance`	GatewayInstance	True