AlexaForBusiness / Client / create_gateway_group

create_gateway_group#

AlexaForBusiness.Client.create_gateway_group(**kwargs)#

Creates a gateway group with the specified details.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.create_gateway_group(
    Name='string',
    Description='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the gateway group.

  • Description (string) – The description of the gateway group.

  • ClientRequestToken (string) –

    [REQUIRED]

    A unique, user-specified identifier for the request that ensures idempotency.

    This field is autopopulated if not provided.

  • Tags (list) –

    The tags to be added to the specified resource. Do not provide system tags.

    • (dict) –

      A key-value pair that can be associated with a resource.

      • Key (string) – [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) – [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type:

dict

Returns:

Response Syntax

{
    'GatewayGroupArn': 'string'
}

Response Structure

  • (dict) –

    • GatewayGroupArn (string) –

      The ARN of the created gateway group.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException

  • AlexaForBusiness.Client.exceptions.LimitExceededException