list_domain_configurations

IoT.Client.list_domain_configurations(**kwargs)

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

Requires permission to access the ListDomainConfigurations action.

See also: AWS API Documentation

Request Syntax

response = client.list_domain_configurations(
    marker='string',
    pageSize=123,
    serviceType='DATA'|'CREDENTIAL_PROVIDER'|'JOBS'
)

Parameters

• marker (string) -- The marker for the next set of results.
• pageSize (integer) -- The result page size.
• serviceType (string) -- The type of service delivered by the endpoint.

Return type

dict

Returns

Response Syntax

{
    'domainConfigurations': [
        {
            'domainConfigurationName': 'string',
            'domainConfigurationArn': 'string',
            'serviceType': 'DATA'|'CREDENTIAL_PROVIDER'|'JOBS'
        },
    ],
    'nextMarker': '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.

  • nextMarker (string) --

    The marker for the next set of results.

Exceptions

• IoT.Client.exceptions.InvalidRequestException
• IoT.Client.exceptions.ThrottlingException
• IoT.Client.exceptions.UnauthorizedException
• IoT.Client.exceptions.ServiceUnavailableException
• IoT.Client.exceptions.InternalFailureException