[ aws . iot ]

list-domain-configurations

Description

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

Note

The domain configuration feature is in public preview and is subject to change.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-domain-configurations
[--marker <value>]
[--page-size <value>]
[--service-type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--marker (string)

The marker for the next set of results.

--page-size (integer)

The result page size.

--service-type (string)

The type of service delivered by the endpoint.

Possible values:

• DATA

• CREDENTIAL_PROVIDER

• JOBS

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To list domain configurations

The following list-domain-configurations example lists the domain configurations in your AWS account that have the specified service type.

aws iot list-domain-configurations \
    --service-type "DATA"

Output:

{
    "domainConfigurations":
    [
        {
            "domainConfigurationName": "additionalDataDomain",
            "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh",
            "serviceType": "DATA"
        },

        {
            "domainConfigurationName": "iot:Jobs",
            "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:Jobs",
            "serviceType": "JOBS"
        },
        {
            "domainConfigurationName": "iot:Data-ATS",
            "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:Data-ATS",
            "serviceType": "DATA"
        },
        {
            "domainConfigurationName": "iot:CredentialProvider",
            "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/iot:CredentialProvider",
            "serviceType": "CREDENTIAL_PROVIDER"
        }
    ]
}

For more information, see Configurable Endpoints in the AWS IoT Developer Guide.

Output

domainConfigurations -> (list)

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

(structure)

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 AWS-managed domain (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.

• Data

• Jobs

• CredentialProvider

Note

The domain configuration feature is in public preview and is subject to change.

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.