MediaConnect / Client / update_gateway_instance

update_gateway_instance#

MediaConnect.Client.update_gateway_instance(**kwargs)#

Updates the configuration of an existing Gateway Instance.

See also: AWS API Documentation

Request Syntax

response = client.update_gateway_instance(
    BridgePlacement='AVAILABLE'|'LOCKED',
    GatewayInstanceArn='string'
)
Parameters:

  • 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.

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

Return type:

dict

Returns:

Response Syntax

{
    'BridgePlacement': 'AVAILABLE'|'LOCKED',
    'GatewayInstanceArn': 'string'
}

Response Structure

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

    • 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.

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

Exceptions

  • 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