Chime / Client / list_voice_connector_groups

list_voice_connector_groups#

Chime.Client.list_voice_connector_groups(**kwargs)#

Lists the Amazon Chime Voice Connector groups for the administrator’s AWS account.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, ListVoiceConnectorGroups, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

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.list_voice_connector_groups(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – The token to use to retrieve the next page of results.

  • MaxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceConnectorGroups': [
        {
            'VoiceConnectorGroupId': 'string',
            'Name': 'string',
            'VoiceConnectorItems': [
                {
                    'VoiceConnectorId': 'string',
                    'Priority': 123
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'VoiceConnectorGroupArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • VoiceConnectorGroups (list) –

      The details of the Amazon Chime Voice Connector groups.

      • (dict) –

        The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice Connectors. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

        • VoiceConnectorGroupId (string) –

          The Amazon Chime Voice Connector group ID.

        • Name (string) –

          The name of the Amazon Chime Voice Connector group.

        • VoiceConnectorItems (list) –

          The Amazon Chime Voice Connectors to which to route inbound calls.

          • (dict) –

            For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

            • VoiceConnectorId (string) –

              The Amazon Chime Voice Connector ID.

            • Priority (integer) –

              The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

        • CreatedTimestamp (datetime) –

          The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) –

          The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.

        • VoiceConnectorGroupArn (string) –

          The ARN of the specified Amazon Chime Voice Connector group.

    • NextToken (string) –

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException