MediaConnect / Client / describe_gateway_instance

describe_gateway_instance#

MediaConnect.Client.describe_gateway_instance(**kwargs)#

Displays the details of an instance.

Request Syntax

response = client.describe_gateway_instance(
    GatewayInstanceArn='string'
)

Parameters:

GatewayInstanceArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the gateway instance that you want to describe.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayInstance': {
        'BridgePlacement': 'AVAILABLE'|'LOCKED',
        'ConnectionStatus': 'CONNECTED'|'DISCONNECTED',
        'GatewayArn': 'string',
        'GatewayInstanceArn': 'string',
        'InstanceId': 'string',
        'InstanceMessages': [
            {
                'Code': 'string',
                'Message': 'string',
                'ResourceName': 'string'
            },
        ],
        'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR',
        'RunningBridgeCount': 123
    }
}

Response Structure

(dict) –
- GatewayInstance (dict) –
  
  The gateway instance that you requested a description of.
  - 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 deployed to this instance.
  - ConnectionStatus (string) –
    
    The connection state of the instance.
  - GatewayArn (string) –
    
    The Amazon Resource Name (ARN) of the instance.
  - GatewayInstanceArn (string) –
    
    The ARN of the gateway.
  - InstanceId (string) –
    
    The instance ID generated by the SSM install. This will begin with “mi-“.
  - InstanceMessages (list) –
    
    Messages with information about the gateway.
    - (dict) –
      
      The details of an error message.
      - 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.

Exceptions

MediaConnect.Client.exceptions.BadRequestException
MediaConnect.Client.exceptions.TooManyRequestsException
MediaConnect.Client.exceptions.ConflictException
MediaConnect.Client.exceptions.InternalServerErrorException
MediaConnect.Client.exceptions.ForbiddenException
MediaConnect.Client.exceptions.NotFoundException
MediaConnect.Client.exceptions.ServiceUnavailableException