The Domain Configurations API from Amazon IoT Core — 2 operation(s) for domain configurations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-iot-core-domain-configurations-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 2015-05-28
x-release: v4
title: AWS IoT Domain Configurations API
description: 'IoT
IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud.'
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: iot
x-aws-signingName: iot
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-2015-05-28.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://iot.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT multi-region endpoint
- url: https://iot.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT multi-region endpoint
- url: http://iot.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
- url: https://iot.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Domain Configurations
paths:
/domainConfigurations/{domainConfigurationName}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateDomainConfiguration
description: 'Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDomainConfigurationResponse'
'480':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'481':
description: CertificateValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateValidationException'
'482':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'483':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'484':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'485':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'486':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'487':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: domainConfigurationName
in: path
required: true
description: The name of the domain configuration. This value must be unique to a region.
schema:
type: string
pattern: '[\w.-]+'
minLength: 1
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
domainName:
description: The name of the domain.
type: string
pattern: '[\s\S]*'
minLength: 1
maxLength: 253
serverCertificateArns:
description: The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.
type: array
items:
$ref: '#/components/schemas/AcmCertificateArn'
minItems: 0
maxItems: 1
validationCertificateArn:
description: The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.
type: string
pattern: arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\d{1}:\d{12}:certificate/[a-zA-Z0-9/-]+
minLength: 1
maxLength: 2048
authorizerConfig:
description: An object that specifies the authorization service for a domain.
type: object
properties:
defaultAuthorizerName:
allOf:
- $ref: '#/components/schemas/AuthorizerName'
- description: The name of the authorization service for a domain configuration.
allowAuthorizerOverride:
allOf:
- $ref: '#/components/schemas/AllowAuthorizerOverride'
- description: A Boolean that specifies whether the domain configuration's authorization service can be overridden.
serviceType:
description: <p>The type of service delivered by the endpoint.</p> <note> <p>Amazon Web Services IoT Core currently supports only the <code>DATA</code> service type.</p> </note>
type: string
enum:
- DATA
- CREDENTIAL_PROVIDER
- JOBS
tags:
description: '<p>Metadata which can be used to manage the domain configuration.</p> <note> <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p> <p>For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."</p> <p>For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."</p> </note>'
type: array
items:
$ref: '#/components/schemas/Tag'
summary: Amazon IoT Core Create Domain Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Domain Configurations
delete:
operationId: DeleteDomainConfiguration
description: 'Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDomainConfigurationResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'483':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'484':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'485':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
parameters:
- name: domainConfigurationName
in: path
required: true
description: The name of the domain configuration to be deleted.
schema:
type: string
pattern: '[\w.-]+'
minLength: 1
maxLength: 128
summary: Amazon IoT Core Delete Domain Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Domain Configurations
get:
operationId: DescribeDomainConfiguration
description: 'Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeDomainConfigurationResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'485':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
parameters:
- name: domainConfigurationName
in: path
required: true
description: The name of the domain configuration.
schema:
type: string
pattern: '[\w.:-]+'
minLength: 1
maxLength: 128
summary: Amazon IoT Core Describe Domain Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Domain Configurations
put:
operationId: UpdateDomainConfiguration
description: 'Updates values stored in the domain configuration. Domain configurations for default endpoints can''t be updated.
Requires permission to access the UpdateDomainConfiguration action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDomainConfigurationResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: CertificateValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/CertificateValidationException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'485':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'486':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
parameters:
- name: domainConfigurationName
in: path
required: true
description: The name of the domain configuration to be updated.
schema:
type: string
pattern: '[\w.:-]+'
minLength: 1
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
authorizerConfig:
description: An object that specifies the authorization service for a domain.
type: object
properties:
defaultAuthorizerName:
allOf:
- $ref: '#/components/schemas/AuthorizerName'
- description: The name of the authorization service for a domain configuration.
allowAuthorizerOverride:
allOf:
- $ref: '#/components/schemas/AllowAuthorizerOverride'
- description: A Boolean that specifies whether the domain configuration's authorization service can be overridden.
domainConfigurationStatus:
description: The status to which the domain configuration should be updated.
type: string
enum:
- ENABLED
- DISABLED
removeAuthorizerConfig:
description: Removes the authorization configuration from a domain.
type: boolean
summary: Amazon IoT Core Update Domain Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Domain Configurations
/domainConfigurations:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListDomainConfigurations
description: '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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDomainConfigurationsResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'483':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'484':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
parameters:
- name: marker
in: query
required: false
description: The marker for the next set of results.
schema:
type: string
pattern: '[A-Za-z0-9+/]+={0,2}'
maxLength: 1024
- name: pageSize
in: query
required: false
description: The result page size.
schema:
type: integer
minimum: 1
maximum: 250
- name: serviceType
in: query
required: false
description: The type of service delivered by the endpoint.
schema:
type: string
enum:
- DATA
- CREDENTIAL_PROVIDER
- JOBS
summary: Amazon IoT Core List Domain Configurations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Domain Configurations
components:
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
schemas:
DomainConfigurations:
type: array
items:
$ref: '#/components/schemas/DomainConfigurationSummary'
DomainName:
type: string
pattern: '[\s\S]*'
minLength: 1
maxLength: 253
ServiceUnavailableException: {}
ResourceNotFoundException: {}
ReservedDomainConfigurationName:
type: string
pattern: '[\w.:-]+'
minLength: 1
maxLength: 128
InternalFailureException: {}
CreateDomainConfigurationResponse:
type: object
properties:
domainConfigurationName:
allOf:
- $ref: '#/components/schemas/DomainConfigurationName'
- description: The name of the domain configuration.
domainConfigurationArn:
allOf:
- $ref: '#/components/schemas/DomainConfigurationArn'
- description: The ARN of the domain configuration.
DomainConfigurationStatus:
type: string
enum:
- ENABLED
- DISABLED
AuthorizerName:
type: string
pattern: '[\w=,@-]+'
minLength: 1
maxLength: 128
DomainConfigurationName:
type: string
pattern: '[\w.-]+'
minLength: 1
maxLength: 128
AuthorizerConfig:
type: object
properties:
defaultAuthorizerName:
allOf:
- $ref: '#/components/schemas/AuthorizerName'
- description: The name of the authorization service for a domain configuration.
allowAuthorizerOverride:
allOf:
- $ref: '#/components/schemas/AllowAuthorizerOverride'
- description: A Boolean that specifies whether the domain configuration's authorization service can be overridden.
description: An object that specifies the authorization service for a domain.
ResourceAlreadyExistsException: {}
UpdateDomainConfigurationResponse:
type: object
properties:
domainConfigurationName:
allOf:
- $ref: '#/components/schemas/ReservedDomainConfigurationName'
- description: The name of the domain configuration that was updated.
domainConfigurationArn:
allOf:
- $ref: '#/components/schemas/DomainConfigurationArn'
- description: The ARN of the domain configuration that was updated.
UnauthorizedException: {}
AcmCertificateArn:
type: string
pattern: arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\d{1}:\d{12}:certificate/[a-zA-Z0-9/-]+
minLength: 1
maxLength: 2048
ServerCertificates:
type: array
items:
$ref: '#/components/schemas/ServerCertificateSummary'
InvalidRequestException: {}
ThrottlingException: {}
AllowAuthorizerOverride:
type: boolean
ListDomainConfigurationsResponse:
type: object
properties:
domainConfigurations:
allOf:
- $ref: '#/components/schemas/DomainConfigurations'
- description: A list of objects that contain summary information about the user's domain configurations.
nextMarker:
allOf:
- $ref: '#/components/schemas/Marker'
- description: The marker for the next set of results.
ServerCertificateStatusDetail:
type: string
Tag:
type: object
required:
- Key
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The tag's key.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The tag's value.
description: A set of key/value pairs that are used to manage the resource.
DescribeDomainConfigurationResponse:
type: object
properties:
domainConfigurationName:
allOf:
- $ref: '#/components/schemas/ReservedDomainConfigurationName'
- description: The name of the domain configuration.
domainConfigurationArn:
allOf:
- $ref: '#/components/schemas/DomainConfigurationArn'
- description: The ARN of the domain configuration.
domainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: The name of the domain.
serverCertificates:
allOf:
- $ref: '#/components/schemas/ServerCertificates'
- description: A list containing summary information about the server certificate included in the domain configuration.
authorizerConfig:
allOf:
- $ref: '#/components/schemas/AuthorizerConfig'
- description: An object that specifies the authorization service for a domain.
domainConfigurationStatus:
allOf:
- $ref: '#/components/schemas/DomainConfigurationStatus'
- description: A Boolean value that specifies the current state of the domain configuration.
serviceType:
allOf:
- $ref: '#/components/schemas/ServiceType'
- description: The type of service delivered by the endpoint.
domainType:
allOf:
- $ref: '#/components/schemas/DomainType'
- description: The type of the domain.
lastStatusChangeDate:
allOf:
- $ref: '#/components/schemas/DateType'
- description: The date and time the domain configuration's status was last changed.
Marker:
type: string
pattern: '[A-Za-z0-9+/]+={0,2}'
maxLength: 1024
CertificateValidationException: {}
TagKey:
type: string
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
minLength: 1
maxLength: 128
DeleteDomainConfigurationResponse:
type: object
properties: {}
DateType:
type: string
format: date-time
DomainType:
type: string
enum:
- ENDPOINT
- AWS_MANAGED
- CUSTOMER_MANAGED
ServerCertificateSummary:
type: object
properties:
serverCertificateArn:
allOf:
- $ref: '#/components/schemas/AcmCertificateArn'
- description: The ARN of the server certificate.
serverCertificateStatus:
allOf:
- $ref: '#/components/schemas/ServerCertificateStatus'
- description: The status of the server certificate.
serverCertificateStatusDetail:
allOf:
- $ref: '#/components/schemas/ServerCertificateStatusDetail'
- description: Details that explain the status of the server certificate.
description: An object that contains information about a server certificate.
ServerCertificateStatus:
type: string
enum:
- INVALID
- VALID
DomainConfigurationSummary:
type: object
properties:
domainConfigurationName:
allOf:
- $ref: '#/components/schemas/ReservedDomainConfigurationName'
- description: The name of the domain configuration. This value must be unique to a region.
domainConfigurationArn:
allOf:
- $ref: '#/components/schemas/DomainConfigurationArn'
- description: The ARN of the domain configuration.
serviceType:
allOf:
- $ref: '#/components/schemas/ServiceType'
- description: The type of service delivered by the endpoint.
description: <p>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.</p> <ul> <li> <p>Data</p> </li> <li> <p>Jobs</p> </li> <li> <p>CredentialProvider</p> </li> </ul>
TagValue:
type: string
minLength: 0
maxLength: 256
LimitExceededException: {}
ServiceType:
type: string
enum:
- DATA
- CREDENTIAL_PROVIDER
- JOBS
DomainConfigurationArn:
type: string
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/iot/
x-hasEquivalentPaths: true