openapi: 3.0.0 info: version: 2015-05-28 x-release: v4 title: AWS IoT Accept Certificate Transfer Billing Groups 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. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.

The service endpoints that expose this API are listed in Amazon Web Services IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.

The service name used by Amazon Web Services Signature Version 4 to sign the request is: execute-api.

For more information about how IoT works, see the Developer Guide.

For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.

' 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: Billing Groups paths: /billing-groups/addThingToBillingGroup: 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' put: operationId: AddThingToBillingGroup description:

Adds a thing to a billing group.

Requires permission to access the AddThingToBillingGroup action.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AddThingToBillingGroupResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object properties: billingGroupName: description:

The name of the billing group.

This call is asynchronous. It might take several seconds for the detachment to propagate.

type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 billingGroupArn: description: The ARN of the billing group. type: string thingName: description: The name of the thing to be added to the billing group. type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 thingArn: description: The ARN of the thing to be added to the billing group. type: string summary: Amazon IoT Core Add Thing to Billing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Billing Groups /billing-groups/{billingGroupName}: 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: CreateBillingGroup description:

Creates a billing group.

Requires permission to access the CreateBillingGroup action.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateBillingGroupResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' parameters: - name: billingGroupName in: path required: true description: The name you wish to give to the billing group. schema: type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object properties: billingGroupProperties: description: The properties of a billing group. type: object properties: billingGroupDescription: allOf: - $ref: '#/components/schemas/BillingGroupDescription' - description: The description of the billing group. tags: description: Metadata which can be used to manage the billing group. type: array items: $ref: '#/components/schemas/Tag' summary: Amazon IoT Core Create Billing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Billing Groups delete: operationId: DeleteBillingGroup description:

Deletes the billing group.

Requires permission to access the DeleteBillingGroup action.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteBillingGroupResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: VersionConflictException content: application/json: schema: $ref: '#/components/schemas/VersionConflictException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' parameters: - name: billingGroupName in: path required: true description: The name of the billing group. schema: type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 - name: expectedVersion in: query required: false description: The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException. schema: type: integer summary: Amazon IoT Core Delete Billing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Billing Groups get: operationId: DescribeBillingGroup description:

Returns information about a billing group.

Requires permission to access the DescribeBillingGroup action.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeBillingGroupResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: - name: billingGroupName in: path required: true description: The name of the billing group. schema: type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 summary: Amazon IoT Core Describe Billing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Billing Groups patch: operationId: UpdateBillingGroup description:

Updates information about the billing group.

Requires permission to access the UpdateBillingGroup action.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateBillingGroupResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: VersionConflictException content: application/json: schema: $ref: '#/components/schemas/VersionConflictException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '484': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: - name: billingGroupName in: path required: true description: The name of the billing group. schema: type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 requestBody: required: true content: application/json: schema: type: object required: - billingGroupProperties properties: billingGroupProperties: description: The properties of a billing group. type: object properties: billingGroupDescription: allOf: - $ref: '#/components/schemas/BillingGroupDescription' - description: The description of the billing group. expectedVersion: description: The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException. type: integer summary: Amazon IoT Core Update Billing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Billing Groups /billing-groups: 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: ListBillingGroups description:

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups action.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListBillingGroupsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: nextToken in: query required: false description: To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results. schema: type: string - name: maxResults in: query required: false description: The maximum number of results to return per request. schema: type: integer minimum: 1 maximum: 250 - name: namePrefixFilter in: query required: false description: Limit the results to billing groups whose names have the given prefix. schema: type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 summary: Amazon IoT Core List Billing Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Billing Groups /billing-groups/{billingGroupName}/things: 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: ListThingsInBillingGroup description:

Lists the things you have added to the given billing group.

Requires permission to access the ListThingsInBillingGroup action.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListThingsInBillingGroupResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' parameters: - name: billingGroupName in: path required: true description: The name of the billing group. schema: type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 - name: nextToken in: query required: false description: To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results. schema: type: string - name: maxResults in: query required: false description: The maximum number of results to return per request. schema: type: integer minimum: 1 maximum: 250 summary: Amazon IoT Core List Things in Billing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Billing Groups /billing-groups/removeThingFromBillingGroup: 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' put: operationId: RemoveThingFromBillingGroup description:

Removes the given thing from the billing group.

Requires permission to access the RemoveThingFromBillingGroup action.

This call is asynchronous. It might take several seconds for the detachment to propagate.

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RemoveThingFromBillingGroupResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '482': description: InternalFailureException content: application/json: schema: $ref: '#/components/schemas/InternalFailureException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' parameters: [] requestBody: required: true content: application/json: schema: type: object properties: billingGroupName: description: The name of the billing group. type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 billingGroupArn: description: The ARN of the billing group. type: string thingName: description: The name of the thing to be removed from the billing group. type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 thingArn: description: The ARN of the thing to be removed from the billing group. type: string summary: Amazon IoT Core Remove Thing from Billing Group x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Billing Groups components: schemas: ResourceNotFoundException: {} BillingGroupMetadata: type: object properties: creationDate: allOf: - $ref: '#/components/schemas/CreationDate' - description: The date the billing group was created. description: Additional information about the billing group. Version: type: integer ThingGroupArn: type: string AddThingToBillingGroupResponse: type: object properties: {} TagKey: type: string pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ minLength: 1 maxLength: 128 ListThingsInBillingGroupResponse: type: object properties: things: allOf: - $ref: '#/components/schemas/ThingNameList' - description: A list of things in the billing group. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token to use to get the next set of results. Will not be returned if operation has returned all results. ThrottlingException: {} BillingGroupProperties: type: object properties: billingGroupDescription: allOf: - $ref: '#/components/schemas/BillingGroupDescription' - description: The description of the billing group. description: The properties of a billing group. ListBillingGroupsResponse: type: object properties: billingGroups: allOf: - $ref: '#/components/schemas/BillingGroupNameAndArnList' - description: The list of billing groups. nextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: The token to use to get the next set of results, or null if there are no additional results. DescribeBillingGroupResponse: type: object properties: billingGroupName: allOf: - $ref: '#/components/schemas/BillingGroupName' - description: The name of the billing group. billingGroupId: allOf: - $ref: '#/components/schemas/BillingGroupId' - description: The ID of the billing group. billingGroupArn: allOf: - $ref: '#/components/schemas/BillingGroupArn' - description: The ARN of the billing group. version: allOf: - $ref: '#/components/schemas/Version' - description: The version of the billing group. billingGroupProperties: allOf: - $ref: '#/components/schemas/BillingGroupProperties' - description: The properties of the billing group. billingGroupMetadata: allOf: - $ref: '#/components/schemas/BillingGroupMetadata' - description: Additional information about the billing group. InvalidRequestException: {} BillingGroupName: type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 ThingGroupName: type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 InternalFailureException: {} CreateBillingGroupResponse: type: object properties: billingGroupName: allOf: - $ref: '#/components/schemas/BillingGroupName' - description: The name you gave to the billing group. billingGroupArn: allOf: - $ref: '#/components/schemas/BillingGroupArn' - description: The ARN of the billing group. billingGroupId: allOf: - $ref: '#/components/schemas/BillingGroupId' - description: The ID of the billing group. NextToken: type: string BillingGroupId: type: string pattern: '[a-zA-Z0-9\-]+' minLength: 1 maxLength: 128 BillingGroupDescription: type: string pattern: '[\p{Graph}\x20]*' maxLength: 2028 UpdateBillingGroupResponse: type: object properties: version: allOf: - $ref: '#/components/schemas/Version' - description: The latest version of the billing group. 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. ResourceAlreadyExistsException: {} RemoveThingFromBillingGroupResponse: type: object properties: {} ThingNameList: type: array items: $ref: '#/components/schemas/ThingName' CreationDate: type: string format: date-time TagValue: type: string minLength: 0 maxLength: 256 BillingGroupArn: type: string DeleteBillingGroupResponse: type: object properties: {} BillingGroupNameAndArnList: type: array items: $ref: '#/components/schemas/GroupNameAndArn' VersionConflictException: {} ThingName: type: string pattern: '[a-zA-Z0-9:_-]+' minLength: 1 maxLength: 128 GroupNameAndArn: type: object properties: groupName: allOf: - $ref: '#/components/schemas/ThingGroupName' - description: The group name. groupArn: allOf: - $ref: '#/components/schemas/ThingGroupArn' - description: The group ARN. description: The name and ARN of a group. parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false 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