universal-s3
Version:
Universal S3 SDK for JavaScript, available for Node.js backends
2,141 lines • 164 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2015-05-28",
"endpointPrefix": "iot",
"protocol": "rest-json",
"serviceFullName": "AWS IoT",
"serviceId": "IoT",
"signatureVersion": "v4",
"signingName": "execute-api",
"uid": "iot-2015-05-28"
},
"operations": {
"AcceptCertificateTransfer": {
"http": {
"method": "PATCH",
"requestUri": "/accept-certificate-transfer/{certificateId}"
},
"input": {
"type": "structure",
"required": [
"certificateId"
],
"members": {
"certificateId": {
"location": "uri",
"locationName": "certificateId"
},
"setAsActive": {
"location": "querystring",
"locationName": "setAsActive",
"type": "boolean"
}
}
}
},
"AddThingToBillingGroup": {
"http": {
"method": "PUT",
"requestUri": "/billing-groups/addThingToBillingGroup"
},
"input": {
"type": "structure",
"members": {
"billingGroupName": {},
"billingGroupArn": {},
"thingName": {},
"thingArn": {}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AddThingToThingGroup": {
"http": {
"method": "PUT",
"requestUri": "/thing-groups/addThingToThingGroup"
},
"input": {
"type": "structure",
"members": {
"thingGroupName": {},
"thingGroupArn": {},
"thingName": {},
"thingArn": {},
"overrideDynamicGroups": {
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AssociateTargetsWithJob": {
"http": {
"requestUri": "/jobs/{jobId}/targets"
},
"input": {
"type": "structure",
"required": [
"targets",
"jobId"
],
"members": {
"targets": {
"shape": "Sg"
},
"jobId": {
"location": "uri",
"locationName": "jobId"
},
"comment": {}
}
},
"output": {
"type": "structure",
"members": {
"jobArn": {},
"jobId": {},
"description": {}
}
}
},
"AttachPolicy": {
"http": {
"method": "PUT",
"requestUri": "/target-policies/{policyName}"
},
"input": {
"type": "structure",
"required": [
"policyName",
"target"
],
"members": {
"policyName": {
"location": "uri",
"locationName": "policyName"
},
"target": {}
}
}
},
"AttachPrincipalPolicy": {
"http": {
"method": "PUT",
"requestUri": "/principal-policies/{policyName}"
},
"input": {
"type": "structure",
"required": [
"policyName",
"principal"
],
"members": {
"policyName": {
"location": "uri",
"locationName": "policyName"
},
"principal": {
"location": "header",
"locationName": "x-amzn-iot-principal"
}
}
},
"deprecated": true
},
"AttachSecurityProfile": {
"http": {
"method": "PUT",
"requestUri": "/security-profiles/{securityProfileName}/targets"
},
"input": {
"type": "structure",
"required": [
"securityProfileName",
"securityProfileTargetArn"
],
"members": {
"securityProfileName": {
"location": "uri",
"locationName": "securityProfileName"
},
"securityProfileTargetArn": {
"location": "querystring",
"locationName": "securityProfileTargetArn"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"AttachThingPrincipal": {
"http": {
"method": "PUT",
"requestUri": "/things/{thingName}/principals"
},
"input": {
"type": "structure",
"required": [
"thingName",
"principal"
],
"members": {
"thingName": {
"location": "uri",
"locationName": "thingName"
},
"principal": {
"location": "header",
"locationName": "x-amzn-principal"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"CancelAuditMitigationActionsTask": {
"http": {
"method": "PUT",
"requestUri": "/audit/mitigationactions/tasks/{taskId}/cancel"
},
"input": {
"type": "structure",
"required": [
"taskId"
],
"members": {
"taskId": {
"location": "uri",
"locationName": "taskId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"CancelAuditTask": {
"http": {
"method": "PUT",
"requestUri": "/audit/tasks/{taskId}/cancel"
},
"input": {
"type": "structure",
"required": [
"taskId"
],
"members": {
"taskId": {
"location": "uri",
"locationName": "taskId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"CancelCertificateTransfer": {
"http": {
"method": "PATCH",
"requestUri": "/cancel-certificate-transfer/{certificateId}"
},
"input": {
"type": "structure",
"required": [
"certificateId"
],
"members": {
"certificateId": {
"location": "uri",
"locationName": "certificateId"
}
}
}
},
"CancelJob": {
"http": {
"method": "PUT",
"requestUri": "/jobs/{jobId}/cancel"
},
"input": {
"type": "structure",
"required": [
"jobId"
],
"members": {
"jobId": {
"location": "uri",
"locationName": "jobId"
},
"reasonCode": {},
"comment": {},
"force": {
"location": "querystring",
"locationName": "force",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {
"jobArn": {},
"jobId": {},
"description": {}
}
}
},
"CancelJobExecution": {
"http": {
"method": "PUT",
"requestUri": "/things/{thingName}/jobs/{jobId}/cancel"
},
"input": {
"type": "structure",
"required": [
"jobId",
"thingName"
],
"members": {
"jobId": {
"location": "uri",
"locationName": "jobId"
},
"thingName": {
"location": "uri",
"locationName": "thingName"
},
"force": {
"location": "querystring",
"locationName": "force",
"type": "boolean"
},
"expectedVersion": {
"type": "long"
},
"statusDetails": {
"shape": "S1b"
}
}
}
},
"ClearDefaultAuthorizer": {
"http": {
"method": "DELETE",
"requestUri": "/default-authorizer"
},
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {}
}
},
"CreateAuthorizer": {
"http": {
"requestUri": "/authorizer/{authorizerName}"
},
"input": {
"type": "structure",
"required": [
"authorizerName",
"authorizerFunctionArn",
"tokenKeyName",
"tokenSigningPublicKeys"
],
"members": {
"authorizerName": {
"location": "uri",
"locationName": "authorizerName"
},
"authorizerFunctionArn": {},
"tokenKeyName": {},
"tokenSigningPublicKeys": {
"shape": "S1k"
},
"status": {}
}
},
"output": {
"type": "structure",
"members": {
"authorizerName": {},
"authorizerArn": {}
}
}
},
"CreateBillingGroup": {
"http": {
"requestUri": "/billing-groups/{billingGroupName}"
},
"input": {
"type": "structure",
"required": [
"billingGroupName"
],
"members": {
"billingGroupName": {
"location": "uri",
"locationName": "billingGroupName"
},
"billingGroupProperties": {
"shape": "S1r"
},
"tags": {
"shape": "S1t"
}
}
},
"output": {
"type": "structure",
"members": {
"billingGroupName": {},
"billingGroupArn": {},
"billingGroupId": {}
}
}
},
"CreateCertificateFromCsr": {
"http": {
"requestUri": "/certificates"
},
"input": {
"type": "structure",
"required": [
"certificateSigningRequest"
],
"members": {
"certificateSigningRequest": {},
"setAsActive": {
"location": "querystring",
"locationName": "setAsActive",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {
"certificateArn": {},
"certificateId": {},
"certificatePem": {}
}
}
},
"CreateDynamicThingGroup": {
"http": {
"requestUri": "/dynamic-thing-groups/{thingGroupName}"
},
"input": {
"type": "structure",
"required": [
"thingGroupName",
"queryString"
],
"members": {
"thingGroupName": {
"location": "uri",
"locationName": "thingGroupName"
},
"thingGroupProperties": {
"shape": "S25"
},
"indexName": {},
"queryString": {},
"queryVersion": {},
"tags": {
"shape": "S1t"
}
}
},
"output": {
"type": "structure",
"members": {
"thingGroupName": {},
"thingGroupArn": {},
"thingGroupId": {},
"indexName": {},
"queryString": {},
"queryVersion": {}
}
}
},
"CreateJob": {
"http": {
"method": "PUT",
"requestUri": "/jobs/{jobId}"
},
"input": {
"type": "structure",
"required": [
"jobId",
"targets"
],
"members": {
"jobId": {
"location": "uri",
"locationName": "jobId"
},
"targets": {
"shape": "Sg"
},
"documentSource": {},
"document": {},
"description": {},
"presignedUrlConfig": {
"shape": "S2k"
},
"targetSelection": {},
"jobExecutionsRolloutConfig": {
"shape": "S2o"
},
"abortConfig": {
"shape": "S2v"
},
"timeoutConfig": {
"shape": "S32"
},
"tags": {
"shape": "S1t"
}
}
},
"output": {
"type": "structure",
"members": {
"jobArn": {},
"jobId": {},
"description": {}
}
}
},
"CreateKeysAndCertificate": {
"http": {
"requestUri": "/keys-and-certificate"
},
"input": {
"type": "structure",
"members": {
"setAsActive": {
"location": "querystring",
"locationName": "setAsActive",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {
"certificateArn": {},
"certificateId": {},
"certificatePem": {},
"keyPair": {
"type": "structure",
"members": {
"PublicKey": {},
"PrivateKey": {
"type": "string",
"sensitive": true
}
}
}
}
}
},
"CreateMitigationAction": {
"http": {
"requestUri": "/mitigationactions/actions/{actionName}"
},
"input": {
"type": "structure",
"required": [
"actionName",
"roleArn",
"actionParams"
],
"members": {
"actionName": {
"location": "uri",
"locationName": "actionName"
},
"roleArn": {},
"actionParams": {
"shape": "S3c"
},
"tags": {
"shape": "S1t"
}
}
},
"output": {
"type": "structure",
"members": {
"actionArn": {},
"actionId": {}
}
}
},
"CreateOTAUpdate": {
"http": {
"requestUri": "/otaUpdates/{otaUpdateId}"
},
"input": {
"type": "structure",
"required": [
"otaUpdateId",
"targets",
"files",
"roleArn"
],
"members": {
"otaUpdateId": {
"location": "uri",
"locationName": "otaUpdateId"
},
"description": {},
"targets": {
"shape": "S3v"
},
"targetSelection": {},
"awsJobExecutionsRolloutConfig": {
"shape": "S3x"
},
"files": {
"shape": "S3z"
},
"roleArn": {},
"additionalParameters": {
"shape": "S4w"
},
"tags": {
"shape": "S1t"
}
}
},
"output": {
"type": "structure",
"members": {
"otaUpdateId": {},
"awsIotJobId": {},
"otaUpdateArn": {},
"awsIotJobArn": {},
"otaUpdateStatus": {}
}
}
},
"CreatePolicy": {
"http": {
"requestUri": "/policies/{policyName}"
},
"input": {
"type": "structure",
"required": [
"policyName",
"policyDocument"
],
"members": {
"policyName": {
"location": "uri",
"locationName": "policyName"
},
"policyDocument": {}
}
},
"output": {
"type": "structure",
"members": {
"policyName": {},
"policyArn": {},
"policyDocument": {},
"policyVersionId": {}
}
}
},
"CreatePolicyVersion": {
"http": {
"requestUri": "/policies/{policyName}/version"
},
"input": {
"type": "structure",
"required": [
"policyName",
"policyDocument"
],
"members": {
"policyName": {
"location": "uri",
"locationName": "policyName"
},
"policyDocument": {},
"setAsDefault": {
"location": "querystring",
"locationName": "setAsDefault",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {
"policyArn": {},
"policyDocument": {},
"policyVersionId": {},
"isDefaultVersion": {
"type": "boolean"
}
}
}
},
"CreateRoleAlias": {
"http": {
"requestUri": "/role-aliases/{roleAlias}"
},
"input": {
"type": "structure",
"required": [
"roleAlias",
"roleArn"
],
"members": {
"roleAlias": {
"location": "uri",
"locationName": "roleAlias"
},
"roleArn": {},
"credentialDurationSeconds": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"roleAlias": {},
"roleAliasArn": {}
}
}
},
"CreateScheduledAudit": {
"http": {
"requestUri": "/audit/scheduledaudits/{scheduledAuditName}"
},
"input": {
"type": "structure",
"required": [
"frequency",
"targetCheckNames",
"scheduledAuditName"
],
"members": {
"frequency": {},
"dayOfMonth": {},
"dayOfWeek": {},
"targetCheckNames": {
"shape": "S5k"
},
"scheduledAuditName": {
"location": "uri",
"locationName": "scheduledAuditName"
},
"tags": {
"shape": "S1t"
}
}
},
"output": {
"type": "structure",
"members": {
"scheduledAuditArn": {}
}
}
},
"CreateSecurityProfile": {
"http": {
"requestUri": "/security-profiles/{securityProfileName}"
},
"input": {
"type": "structure",
"required": [
"securityProfileName"
],
"members": {
"securityProfileName": {
"location": "uri",
"locationName": "securityProfileName"
},
"securityProfileDescription": {},
"behaviors": {
"shape": "S5r"
},
"alertTargets": {
"shape": "S68"
},
"additionalMetricsToRetain": {
"shape": "S6c"
},
"tags": {
"shape": "S1t"
}
}
},
"output": {
"type": "structure",
"members": {
"securityProfileName": {},
"securityProfileArn": {}
}
}
},
"CreateStream": {
"http": {
"requestUri": "/streams/{streamId}"
},
"input": {
"type": "structure",
"required": [
"streamId",
"files",
"roleArn"
],
"members": {
"streamId": {
"location": "uri",
"locationName": "streamId"
},
"description": {},
"files": {
"shape": "S6h"
},
"roleArn": {},
"tags": {
"shape": "S1t"
}
}
},
"output": {
"type": "structure",
"members": {
"streamId": {},
"streamArn": {},
"description": {},
"streamVersion": {
"type": "integer"
}
}
}
},
"CreateThing": {
"http": {
"requestUri": "/things/{thingName}"
},
"input": {
"type": "structure",
"required": [
"thingName"
],
"members": {
"thingName": {
"location": "uri",
"locationName": "thingName"
},
"thingTypeName": {},
"attributePayload": {
"shape": "S27"
},
"billingGroupName": {}
}
},
"output": {
"type": "structure",
"members": {
"thingName": {},
"thingArn": {},
"thingId": {}
}
}
},
"CreateThingGroup": {
"http": {
"requestUri": "/thing-groups/{thingGroupName}"
},
"input": {
"type": "structure",
"required": [
"thingGroupName"
],
"members": {
"thingGroupName": {
"location": "uri",
"locationName": "thingGroupName"
},
"parentGroupName": {},
"thingGroupProperties": {
"shape": "S25"
},
"tags": {
"shape": "S1t"
}
}
},
"output": {
"type": "structure",
"members": {
"thingGroupName": {},
"thingGroupArn": {},
"thingGroupId": {}
}
}
},
"CreateThingType": {
"http": {
"requestUri": "/thing-types/{thingTypeName}"
},
"input": {
"type": "structure",
"required": [
"thingTypeName"
],
"members": {
"thingTypeName": {
"location": "uri",
"locationName": "thingTypeName"
},
"thingTypeProperties": {
"shape": "S6t"
},
"tags": {
"shape": "S1t"
}
}
},
"output": {
"type": "structure",
"members": {
"thingTypeName": {},
"thingTypeArn": {},
"thingTypeId": {}
}
}
},
"CreateTopicRule": {
"http": {
"requestUri": "/rules/{ruleName}"
},
"input": {
"type": "structure",
"required": [
"ruleName",
"topicRulePayload"
],
"members": {
"ruleName": {
"location": "uri",
"locationName": "ruleName"
},
"topicRulePayload": {
"shape": "S71"
},
"tags": {
"location": "header",
"locationName": "x-amz-tagging"
}
},
"payload": "topicRulePayload"
}
},
"DeleteAccountAuditConfiguration": {
"http": {
"method": "DELETE",
"requestUri": "/audit/configuration"
},
"input": {
"type": "structure",
"members": {
"deleteScheduledAudits": {
"location": "querystring",
"locationName": "deleteScheduledAudits",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteAuthorizer": {
"http": {
"method": "DELETE",
"requestUri": "/authorizer/{authorizerName}"
},
"input": {
"type": "structure",
"required": [
"authorizerName"
],
"members": {
"authorizerName": {
"location": "uri",
"locationName": "authorizerName"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteBillingGroup": {
"http": {
"method": "DELETE",
"requestUri": "/billing-groups/{billingGroupName}"
},
"input": {
"type": "structure",
"required": [
"billingGroupName"
],
"members": {
"billingGroupName": {
"location": "uri",
"locationName": "billingGroupName"
},
"expectedVersion": {
"location": "querystring",
"locationName": "expectedVersion",
"type": "long"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteCACertificate": {
"http": {
"method": "DELETE",
"requestUri": "/cacertificate/{caCertificateId}"
},
"input": {
"type": "structure",
"required": [
"certificateId"
],
"members": {
"certificateId": {
"location": "uri",
"locationName": "caCertificateId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteCertificate": {
"http": {
"method": "DELETE",
"requestUri": "/certificates/{certificateId}"
},
"input": {
"type": "structure",
"required": [
"certificateId"
],
"members": {
"certificateId": {
"location": "uri",
"locationName": "certificateId"
},
"forceDelete": {
"location": "querystring",
"locationName": "forceDelete",
"type": "boolean"
}
}
}
},
"DeleteDynamicThingGroup": {
"http": {
"method": "DELETE",
"requestUri": "/dynamic-thing-groups/{thingGroupName}"
},
"input": {
"type": "structure",
"required": [
"thingGroupName"
],
"members": {
"thingGroupName": {
"location": "uri",
"locationName": "thingGroupName"
},
"expectedVersion": {
"location": "querystring",
"locationName": "expectedVersion",
"type": "long"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteJob": {
"http": {
"method": "DELETE",
"requestUri": "/jobs/{jobId}"
},
"input": {
"type": "structure",
"required": [
"jobId"
],
"members": {
"jobId": {
"location": "uri",
"locationName": "jobId"
},
"force": {
"location": "querystring",
"locationName": "force",
"type": "boolean"
}
}
}
},
"DeleteJobExecution": {
"http": {
"method": "DELETE",
"requestUri": "/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}"
},
"input": {
"type": "structure",
"required": [
"jobId",
"thingName",
"executionNumber"
],
"members": {
"jobId": {
"location": "uri",
"locationName": "jobId"
},
"thingName": {
"location": "uri",
"locationName": "thingName"
},
"executionNumber": {
"location": "uri",
"locationName": "executionNumber",
"type": "long"
},
"force": {
"location": "querystring",
"locationName": "force",
"type": "boolean"
}
}
}
},
"DeleteMitigationAction": {
"http": {
"method": "DELETE",
"requestUri": "/mitigationactions/actions/{actionName}"
},
"input": {
"type": "structure",
"required": [
"actionName"
],
"members": {
"actionName": {
"location": "uri",
"locationName": "actionName"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteOTAUpdate": {
"http": {
"method": "DELETE",
"requestUri": "/otaUpdates/{otaUpdateId}"
},
"input": {
"type": "structure",
"required": [
"otaUpdateId"
],
"members": {
"otaUpdateId": {
"location": "uri",
"locationName": "otaUpdateId"
},
"deleteStream": {
"location": "querystring",
"locationName": "deleteStream",
"type": "boolean"
},
"forceDeleteAWSJob": {
"location": "querystring",
"locationName": "forceDeleteAWSJob",
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeletePolicy": {
"http": {
"method": "DELETE",
"requestUri": "/policies/{policyName}"
},
"input": {
"type": "structure",
"required": [
"policyName"
],
"members": {
"policyName": {
"location": "uri",
"locationName": "policyName"
}
}
}
},
"DeletePolicyVersion": {
"http": {
"method": "DELETE",
"requestUri": "/policies/{policyName}/version/{policyVersionId}"
},
"input": {
"type": "structure",
"required": [
"policyName",
"policyVersionId"
],
"members": {
"policyName": {
"location": "uri",
"locationName": "policyName"
},
"policyVersionId": {
"location": "uri",
"locationName": "policyVersionId"
}
}
}
},
"DeleteRegistrationCode": {
"http": {
"method": "DELETE",
"requestUri": "/registrationcode"
},
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteRoleAlias": {
"http": {
"method": "DELETE",
"requestUri": "/role-aliases/{roleAlias}"
},
"input": {
"type": "structure",
"required": [
"roleAlias"
],
"members": {
"roleAlias": {
"location": "uri",
"locationName": "roleAlias"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteScheduledAudit": {
"http": {
"method": "DELETE",
"requestUri": "/audit/scheduledaudits/{scheduledAuditName}"
},
"input": {
"type": "structure",
"required": [
"scheduledAuditName"
],
"members": {
"scheduledAuditName": {
"location": "uri",
"locationName": "scheduledAuditName"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteSecurityProfile": {
"http": {
"method": "DELETE",
"requestUri": "/security-profiles/{securityProfileName}"
},
"input": {
"type": "structure",
"required": [
"securityProfileName"
],
"members": {
"securityProfileName": {
"location": "uri",
"locationName": "securityProfileName"
},
"expectedVersion": {
"location": "querystring",
"locationName": "expectedVersion",
"type": "long"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteStream": {
"http": {
"method": "DELETE",
"requestUri": "/streams/{streamId}"
},
"input": {
"type": "structure",
"required": [
"streamId"
],
"members": {
"streamId": {
"location": "uri",
"locationName": "streamId"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteThing": {
"http": {
"method": "DELETE",
"requestUri": "/things/{thingName}"
},
"input": {
"type": "structure",
"required": [
"thingName"
],
"members": {
"thingName": {
"location": "uri",
"locationName": "thingName"
},
"expectedVersion": {
"location": "querystring",
"locationName": "expectedVersion",
"type": "long"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteThingGroup": {
"http": {
"method": "DELETE",
"requestUri": "/thing-groups/{thingGroupName}"
},
"input": {
"type": "structure",
"required": [
"thingGroupName"
],
"members": {
"thingGroupName": {
"location": "uri",
"locationName": "thingGroupName"
},
"expectedVersion": {
"location": "querystring",
"locationName": "expectedVersion",
"type": "long"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteThingType": {
"http": {
"method": "DELETE",
"requestUri": "/thing-types/{thingTypeName}"
},
"input": {
"type": "structure",
"required": [
"thingTypeName"
],
"members": {
"thingTypeName": {
"location": "uri",
"locationName": "thingTypeName"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DeleteTopicRule": {
"http": {
"method": "DELETE",
"requestUri": "/rules/{ruleName}"
},
"input": {
"type": "structure",
"required": [
"ruleName"
],
"members": {
"ruleName": {
"location": "uri",
"locationName": "ruleName"
}
}
}
},
"DeleteV2LoggingLevel": {
"http": {
"method": "DELETE",
"requestUri": "/v2LoggingLevel"
},
"input": {
"type": "structure",
"required": [
"targetType",
"targetName"
],
"members": {
"targetType": {
"location": "querystring",
"locationName": "targetType"
},
"targetName": {
"location": "querystring",
"locationName": "targetName"
}
}
}
},
"DeprecateThingType": {
"http": {
"requestUri": "/thing-types/{thingTypeName}/deprecate"
},
"input": {
"type": "structure",
"required": [
"thingTypeName"
],
"members": {
"thingTypeName": {
"location": "uri",
"locationName": "thingTypeName"
},
"undoDeprecate": {
"type": "boolean"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"DescribeAccountAuditConfiguration": {
"http": {
"method": "GET",
"requestUri": "/audit/configuration"
},
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {
"roleArn": {},
"auditNotificationTargetConfigurations": {
"shape": "Sa4"
},
"auditCheckConfigurations": {
"shape": "Sa8"
}
}
}
},
"DescribeAuditFinding": {
"http": {
"method": "GET",
"requestUri": "/audit/findings/{findingId}"
},
"input": {
"type": "structure",
"required": [
"findingId"
],
"members": {
"findingId": {
"location": "uri",
"locationName": "findingId"
}
}
},
"output": {
"type": "structure",
"members": {
"finding": {
"shape": "Sad"
}
}
}
},
"DescribeAuditMitigationActionsTask": {
"http": {
"method": "GET",
"requestUri": "/audit/mitigationactions/tasks/{taskId}"
},
"input": {
"type": "structure",
"required": [
"taskId"
],
"members": {
"taskId": {
"location": "uri",
"locationName": "taskId"
}
}
},
"output": {
"type": "structure",
"members": {
"taskStatus": {},
"startTime": {
"type": "timestamp"
},
"endTime": {
"type": "timestamp"
},
"taskStatistics": {
"type": "map",
"key": {},
"value": {
"type": "structure",
"members": {
"totalFindingsCount": {
"type": "long"
},
"failedFindingsCount": {
"type": "long"
},
"succeededFindingsCount": {
"type": "long"
},
"skippedFindingsCount": {
"type": "long"
},
"canceledFindingsCount": {
"type": "long"
}
}
}
},
"target": {
"shape": "Sb2"
},
"auditCheckToActionsMapping": {
"shape": "Sb6"
},
"actionsDefinition": {
"type": "list",
"member": {
"type": "structure",
"members": {
"name": {},
"id": {},
"roleArn": {},
"actionParams": {
"shape": "S3c"
}
}
}
}
}
}
},
"DescribeAuditTask": {
"http": {
"method": "GET",
"requestUri": "/audit/tasks/{taskId}"
},
"input": {
"type": "structure",
"required": [
"taskId"
],
"members": {
"taskId": {
"location": "uri",
"locationName": "taskId"
}
}
},
"output": {
"type": "structure",
"members": {
"taskStatus": {},
"taskType": {},
"taskStartTime": {
"type": "timestamp"
},
"taskStatistics": {
"type": "structure",
"members": {
"totalChecks": {
"type": "integer"
},
"inProgressChecks": {
"type": "integer"
},
"waitingForDataCollectionChecks": {
"type": "integer"
},
"compliantChecks": {
"type": "integer"
},
"nonCompliantChecks": {
"type": "integer"
},
"failedChecks": {
"type": "integer"
},
"canceledChecks": {
"type": "integer"
}
}
},
"scheduledAuditName": {},
"auditDetails": {
"type": "map",
"key": {},
"value": {
"type": "structure",
"members": {
"checkRunStatus": {},
"checkCompliant": {
"type": "boolean"
},
"totalResourcesCount": {
"type": "long"
},
"nonCompliantResourcesCount": {
"type": "long"
},
"errorCode": {},
"message": {}
}
}
}
}
}
},
"DescribeAuthorizer": {
"http": {
"method": "GET",
"requestUri": "/authorizer/{authorizerName}"
},
"input": {
"type": "structure",
"required": [
"authorizerName"
],
"members": {
"authorizerName": {
"location": "uri",
"locationName": "authorizerName"
}
}
},
"output": {
"type": "structure",
"members": {
"authorizerDescription": {
"shape": "Sbw"
}
}
}
},
"DescribeBillingGroup": {
"http": {
"method": "GET",
"requestUri": "/billing-groups/{billingGroupName}"
},
"input": {
"type": "structure",
"required": [
"billingGroupName"
],
"members": {
"billingGroupName": {
"location": "uri",
"locationName": "billingGroupName"
}
}
},
"output": {
"type": "structure",
"members": {
"billingGroupName": {},
"billingGroupId": {},
"billingGroupArn": {},
"version": {
"type": "long"
},
"billingGroupProperties": {
"shape": "S1r"
},
"billingGroupMetadata": {
"type": "structure",
"members": {
"creationDate": {
"type": "timestamp"
}
}
}
}
}
},
"DescribeCACertificate": {
"http": {
"method": "GET",
"requestUri": "/cacertificate/{caCertificateId}"
},
"input": {
"type": "structure",
"required": [
"certificateId"
],
"members": {
"certificateId": {
"location": "uri",
"locationName": "caCertificateId"
}
}
},
"output": {
"type": "structure",
"members": {
"certificateDescription": {
"type": "structure",
"members": {
"certificateArn": {},
"certificateId": {},
"status": {},
"certificatePem": {},
"ownedBy": {},
"creationDate": {
"type": "timestamp"
},
"autoRegistrationStatus": {},
"lastModifiedDate": {
"type": "timestamp"
},
"customerVersion": {
"type": "integer"
},
"generationId": {},
"validity": {
"shape": "Sca"
}
}
},
"registrationConfig": {
"shape": "Scb"
}
}
}
},
"DescribeCertificate": {
"http": {
"method": "GET",
"requestUri": "/certificates/{certificateId}"
},
"input": {
"type": "structure",
"required": [
"certificateId"
],
"members": {
"certificateId": {
"location": "uri",
"locationName": "certificateId"
}
}
},
"output": {
"type": "structure",
"members": {
"certificateDescription": {
"type": "structure",
"members": {
"certificateArn": {},
"certificateId": {},
"caCertificateId": {},
"status": {},
"certificatePem": {},
"ownedBy": {},
"previousOwnedBy": {},
"creationDate": {
"type": "timestamp"
},
"lastModifiedDate": {
"type": "timestamp"
},
"customerVersion": {
"type": "integer"
},
"transferData": {
"type": "structure",
"members": {
"transferMessage": {},
"rejectReason": {},
"transferDate": {
"type": "timestamp"
},
"acceptDate": {
"type": "timestamp"
},
"rejectDate": {
"type": "timestamp"
}
}
},
"generationId": {},
"validity": {
"shape": "Sca"
}
}
}
}
}
},
"DescribeDefaultAuthorizer": {
"http": {
"method": "GET",
"requestUri": "/default-authorizer"
},
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {
"authorizerDescription": {
"shape": "Sbw"
}
}
}
},
"DescribeEndpoint": {
"http": {
"method": "GET",
"requestUri": "/endpoint"
},
"input": {
"type": "structure",
"members": {
"endpointType": {
"location": "querystring",
"locationName": "endpointType"
}
}
},
"output": {
"type": "structure",
"members": {
"endpointAddress": {}
}
}
},
"DescribeEventConfigurations": {
"http": {
"method": "GET",
"requestUri": "/event-configurations"
},
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {
"eventConfigurations": {
"shape": "Scr"
},
"creationDate": {
"type": "timestamp"
},
"lastModifiedDate": {
"type": "timestamp"
}
}
}
},
"DescribeIndex": {
"http": {
"method": "GET",
"requestUri": "/indices/{indexName}"
},
"input": {
"type": "structure",
"required": [
"indexName"
],
"members": {
"indexName": {
"location": "uri",
"locationName": "indexName"
}
}
},
"output": {
"type": "structure",
"members": {
"indexName": {},
"indexStatus": {},
"schema": {}
}
}
},
"DescribeJob": {
"http": {
"method": "GET",
"requestUri": "/jobs/{jobId}"
},
"input": {
"type": "structure",
"required": [
"jobId"
],
"members": {
"jobId": {
"location": "uri",
"locationName": "jobId"
}
}
},
"output": {
"type": "structure",
"members": {
"documentSource": {},
"job": {
"type": "structure",
"members": {
"jobArn": {},
"jobId": {},
"targetSelection": {},
"status": {},
"forceCanceled": {
"type": "boolean"
},
"reasonCode": {},
"comment": {},
"targets": {
"shape": "Sg"
},
"description": {},
"presignedUrlConfig": {
"shape": "S2k"
},
"jobExecutionsRolloutConfig": {
"shape": "S2o"
},
"abortConfig": {
"shape": "S2v"
},
"createdAt": {
"type": "timestamp"
},
"lastUpdatedAt": {
"type": "timestamp"
},
"completedAt": {
"type": "timestamp"
},
"jobProcessDetails": {
"type": "structure",
"members": {
"processingTargets": {
"type": "list",
"member": {}
},
"numberOfCanceledThings": {
"type": "integer"
},
"numberOfSucceededThings": {
"type": "integer"
},
"numberOfFailedThings": {
"type": "integer"
},
"numberOfRejectedThings": {
"type": "integer"
},
"numberOfQueuedThings": {
"type": "integer"
},
"numberOfInProgressThings": {
"type": "integer"
},
"numberOfRemovedThings": {
"type": "integer"
},
"numberOfTimedOutThings": {
"type": "integer"
}
}
},
"timeoutConfig": {
"shape": "S32"
}
}
}
}
}
},
"DescribeJobExecution": {
"http": {
"method": "GET",
"requestUri": "/things/{thingName}/jobs/{jobId}"
},
"input": {
"type": "structure",
"required": [
"jobId",
"thingName"
],
"members": {
"jobId": {
"location": "uri",
"locationName": "jobId"
},
"thingName": {
"location": "uri",
"locationName": "thingName"
},
"executionNumber": {
"location": "querystring",
"locationName": "executionNumber",
"type": "long"
}
}
},
"output": {
"type": "structure",
"members": {
"execution": {
"type": "structure",
"members": {
"jobId": {},
"status": {},
"forceCanceled": {
"type": "boolean"
},
"statusDetails": {
"type": "structure",
"members": {
"detailsMap": {
"shape": "S1b"
}
}
},
"thingArn": {},
"queuedAt": {
"type": "timestamp"
},
"startedAt": {
"type": "timestamp"
},
"lastUpdatedAt": {
"type": "timestamp"
},
"executionNumber": {
"type": "long"
},
"versionNumber": {
"type": "long"
},
"approximateSecondsBeforeTimedOut": {
"type": "long"
}
}
}
}
}
},
"DescribeMitigationAction": {
"http": {
"method": "GET",
"requestUri": "/mitigationactions/actions/{actionName}"
},
"input": {
"type": "stru