MediaConnect / Client / deregister_gateway_instance

deregister_gateway_instance#

MediaConnect.Client.deregister_gateway_instance(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.deregister_gateway_instance(
    Force=True|False,
    GatewayInstanceArn='string'
)
Parameters:

  • Force (boolean) – Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.

  • GatewayInstanceArn (string) – [REQUIRED] The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayInstanceArn': 'string',
    'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR'
}

Response Structure

  • (dict) – AWS Elemental MediaConnect is deleting the instance.

    • GatewayInstanceArn (string) – The Amazon Resource Name (ARN) of the instance.

    • InstanceState (string) – The status of the instance.

Exceptions