Alexa For Business

Deletes a gateway group.

See also: AWS API Documentation

Request Syntax

client.delete_gateway_group(
    GatewayGroupArn='string'
)

type GatewayGroupArn

string

param GatewayGroupArn

[REQUIRED]

The ARN of the gateway group to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Retrieves the details of a gateway group.

See also: AWS API Documentation

Request Syntax

client.get_gateway_group(
    GatewayGroupArn='string'
)

type GatewayGroupArn

string

param GatewayGroupArn

[REQUIRED]

The ARN of the gateway group to get.

rtype

dict

returns

Response Syntax

{
    'GatewayGroup': {
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string'
    }
}

Response Structure

• (dict) --

  • GatewayGroup (dict) --

    The details of the gateway group.

    • Arn (string) --

      The ARN of the gateway group.

    • Name (string) --

      The name of the gateway group.

    • Description (string) --

      The description of the gateway group.

Creates a gateway group with the specified details.

See also: AWS API Documentation

Request Syntax

client.create_gateway_group(
    Name='string',
    Description='string',
    ClientRequestToken='string'
)

type Name

string

param Name

[REQUIRED]

The name of the gateway group.

type Description

string

param Description

The description of the gateway group.

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

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

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'GatewayGroupArn': 'string'
}

Response Structure

• (dict) --

  • GatewayGroupArn (string) --

    The ARN of the created gateway group.

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

See also: AWS API Documentation

Request Syntax

client.list_gateway_groups(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

The token used to paginate though multiple pages of gateway group summaries.

type MaxResults

integer

param MaxResults

The maximum number of gateway group summaries to return. The default is 50.

rtype

dict

returns

Response Syntax

{
    'GatewayGroups': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • GatewayGroups (list) --

    The gateway groups in the list.

    • (dict) --

      The summary of a gateway group.

      • Arn (string) --

        The ARN of the gateway group.

      • Name (string) --

        The name of the gateway group.

      • Description (string) --

        The description of the gateway group.

  • NextToken (string) --

    The token used to paginate though multiple pages of gateway group summaries.

Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

See also: AWS API Documentation

Request Syntax

client.update_gateway_group(
    GatewayGroupArn='string',
    Name='string',
    Description='string'
)

type GatewayGroupArn

string

param GatewayGroupArn

[REQUIRED]

The ARN of the gateway group to update.

type Name

string

param Name

The updated name of the gateway group.

type Description

string

param Description

The updated description of the gateway group.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

See also: AWS API Documentation

Request Syntax

client.update_gateway(
    GatewayArn='string',
    Name='string',
    Description='string',
    SoftwareVersion='string'
)

type GatewayArn

string

param GatewayArn

[REQUIRED]

The ARN of the gateway to update.

type Name

string

param Name

The updated name of the gateway.

type Description

string

param Description

The updated description of the gateway.

type SoftwareVersion

string

param SoftwareVersion

The updated software version of the gateway. The gateway automatically updates its software version during normal operation.

rtype

dict

returns

Response Syntax

{}

Response Structure

• (dict) --

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

See also: AWS API Documentation

Request Syntax

client.list_gateways(
    GatewayGroupArn='string',
    NextToken='string',
    MaxResults=123
)

type GatewayGroupArn

string

param GatewayGroupArn

The gateway group ARN for which to list gateways.

type NextToken

string

param NextToken

The token used to paginate though multiple pages of gateway summaries.

type MaxResults

integer

param MaxResults

The maximum number of gateway summaries to return. The default is 50.

rtype

dict

returns

Response Syntax

{
    'Gateways': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Description': 'string',
            'GatewayGroupArn': 'string',
            'SoftwareVersion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Gateways (list) --

    The gateways in the list.

    • (dict) --

      The summary of a gateway.

      • Arn (string) --

        The ARN of the gateway.

      • Name (string) --

        The name of the gateway.

      • Description (string) --

        The description of the gateway.

      • GatewayGroupArn (string) --

        The ARN of the gateway group that the gateway is associated to.

      • SoftwareVersion (string) --

        The software version of the gateway. The gateway automatically updates its software version during normal operation.

  • NextToken (string) --

    The token used to paginate though multiple pages of gateway summaries.

Retrieves the details of a gateway.

See also: AWS API Documentation

Request Syntax

client.get_gateway(
    GatewayArn='string'
)

type GatewayArn

string

param GatewayArn

[REQUIRED]

The ARN of the gateway to get.

rtype

dict

returns

Response Syntax

{
    'Gateway': {
        'Arn': 'string',
        'Name': 'string',
        'Description': 'string',
        'GatewayGroupArn': 'string',
        'SoftwareVersion': 'string'
    }
}

Response Structure

• (dict) --

  • Gateway (dict) --

    The details of the gateway.

    • Arn (string) --

      The ARN of the gateway.

    • Name (string) --

      The name of the gateway.

    • Description (string) --

      The description of the gateway.

    • GatewayGroupArn (string) --

      The ARN of the gateway group that the gateway is associated to.

    • SoftwareVersion (string) --

      The software version of the gateway. The gateway automatically updates its software version during normal operation.