MediaConnect / Client / describe_gateway_instance



Displays the details of an instance.

See also: AWS API Documentation

Request Syntax

response = client.describe_gateway_instance(

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

Return type:



Response Syntax

    'GatewayInstance': {
        'BridgePlacement': 'AVAILABLE'|'LOCKED',
        'ConnectionStatus': 'CONNECTED'|'DISCONNECTED',
        'GatewayArn': 'string',
        'GatewayInstanceArn': 'string',
        'InstanceId': 'string',
        'InstanceMessages': [
                'Code': 'string',
                'Message': 'string',
                'ResourceName': 'string'
        'RunningBridgeCount': 123

Response Structure

  • (dict) – AWS Elemental MediaConnect returned the instance details successfully.

    • GatewayInstance (dict) – The settings for an instance in a gateway.

      • BridgePlacement (string) – The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.

      • ConnectionStatus (string) – The connection state of the instance.

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

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

      • InstanceId (string) – The managed instance ID generated by the SSM install. This will begin with “mi-“.

      • InstanceMessages (list) –

        • (dict) –

          • Code (string) – The error code.

          • Message (string) – The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

          • ResourceName (string) – The name of the resource.

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

      • RunningBridgeCount (integer) – The running bridge count.


  • MediaConnect.Client.exceptions.BadRequestException

  • MediaConnect.Client.exceptions.InternalServerErrorException

  • MediaConnect.Client.exceptions.ForbiddenException

  • MediaConnect.Client.exceptions.NotFoundException

  • MediaConnect.Client.exceptions.ServiceUnavailableException

  • MediaConnect.Client.exceptions.TooManyRequestsException

  • MediaConnect.Client.exceptions.ConflictException