ListDomainConfigurations

class IoT.Paginator.ListDomainConfigurations

paginator = client.get_paginator('list_domain_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_domain_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    serviceType='DATA'|'CREDENTIAL_PROVIDER'|'JOBS',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• serviceType (string) -- The type of service delivered by the endpoint.
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'domainConfigurations': [
        {
            'domainConfigurationName': 'string',
            'domainConfigurationArn': 'string',
            'serviceType': 'DATA'|'CREDENTIAL_PROVIDER'|'JOBS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • domainConfigurations (list) --

    A list of objects that contain summary information about the user's domain configurations.

    • (dict) --

      The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain. A domain configuration can be associated with an Amazon Web Services-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.

      • Data
      • Jobs
      • CredentialProvider

      • domainConfigurationName (string) --

        The name of the domain configuration. This value must be unique to a region.

      • domainConfigurationArn (string) --

        The ARN of the domain configuration.

      • serviceType (string) --

        The type of service delivered by the endpoint.

  • NextToken (string) --

    A token to resume pagination.