MediaConnect / Client / create_gateway

create_gateway#

MediaConnect.Client.create_gateway(**kwargs)#

Creates a new gateway. The request must include at least one network (up to 4).

See also: AWS API Documentation

Request Syntax

response = client.create_gateway(
    EgressCidrBlocks=[
        'string',
    ],
    Name='string',
    Networks=[
        {
            'CidrBlock': 'string',
            'Name': 'string'
        },
    ]
)
Parameters:

  • EgressCidrBlocks (list) –

    [REQUIRED] The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

    • (string) –

  • Name (string) – [REQUIRED] The name of the gateway. This name can not be modified after the gateway is created.

  • Networks (list) –

    [REQUIRED] The list of networks that you want to add.

    • (dict) – The network settings for a gateway.

      • CidrBlock (string) – [REQUIRED] A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

      • Name (string) – [REQUIRED] The name of the network. This name is used to reference the network and must be unique among networks in this gateway.

Return type:

dict

Returns:

Response Syntax

{
    'Gateway': {
        'EgressCidrBlocks': [
            'string',
        ],
        'GatewayArn': 'string',
        'GatewayMessages': [
            {
                'Code': 'string',
                'Message': 'string',
                'ResourceName': 'string'
            },
        ],
        'GatewayState': 'CREATING'|'ACTIVE'|'UPDATING'|'ERROR'|'DELETING'|'DELETED',
        'Name': 'string',
        'Networks': [
            {
                'CidrBlock': 'string',
                'Name': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) – AWS Elemental MediaConnect created the new gateway successfully.

    • Gateway (dict) – The settings for a gateway, including its networks.

      • EgressCidrBlocks (list) – The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

        • (string) –

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

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

      • GatewayState (string) – The current status of the gateway.

      • Name (string) – The name of the gateway. This name can not be modified after the gateway is created.

      • Networks (list) – The list of networks in the gateway.

        • (dict) – The network settings for a gateway.

          • CidrBlock (string) – A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.

          • Name (string) – The name of the network. This name is used to reference the network and must be unique among networks in this gateway.

Exceptions

  • MediaConnect.Client.exceptions.CreateGateway420Exception

  • MediaConnect.Client.exceptions.BadRequestException

  • MediaConnect.Client.exceptions.InternalServerErrorException

  • MediaConnect.Client.exceptions.ForbiddenException

  • MediaConnect.Client.exceptions.ServiceUnavailableException

  • MediaConnect.Client.exceptions.TooManyRequestsException

  • MediaConnect.Client.exceptions.ConflictException