{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.iot#AWSIotService": { "type": "service", "version": "2015-05-28", "operations": [ { "target": "com.amazonaws.iot#AcceptCertificateTransfer" }, { "target": "com.amazonaws.iot#AddThingToBillingGroup" }, { "target": "com.amazonaws.iot#AddThingToThingGroup" }, { "target": "com.amazonaws.iot#AssociateTargetsWithJob" }, { "target": "com.amazonaws.iot#AttachPolicy" }, { "target": "com.amazonaws.iot#AttachPrincipalPolicy" }, { "target": "com.amazonaws.iot#AttachSecurityProfile" }, { "target": "com.amazonaws.iot#AttachThingPrincipal" }, { "target": "com.amazonaws.iot#CancelAuditMitigationActionsTask" }, { "target": "com.amazonaws.iot#CancelAuditTask" }, { "target": "com.amazonaws.iot#CancelCertificateTransfer" }, { "target": "com.amazonaws.iot#CancelDetectMitigationActionsTask" }, { "target": "com.amazonaws.iot#CancelJob" }, { "target": "com.amazonaws.iot#CancelJobExecution" }, { "target": "com.amazonaws.iot#ClearDefaultAuthorizer" }, { "target": "com.amazonaws.iot#ConfirmTopicRuleDestination" }, { "target": "com.amazonaws.iot#CreateAuditSuppression" }, { "target": "com.amazonaws.iot#CreateAuthorizer" }, { "target": "com.amazonaws.iot#CreateBillingGroup" }, { "target": "com.amazonaws.iot#CreateCertificateFromCsr" }, { "target": "com.amazonaws.iot#CreateCustomMetric" }, { "target": "com.amazonaws.iot#CreateDimension" }, { "target": "com.amazonaws.iot#CreateDomainConfiguration" }, { "target": "com.amazonaws.iot#CreateDynamicThingGroup" }, { "target": "com.amazonaws.iot#CreateJob" }, { "target": "com.amazonaws.iot#CreateJobTemplate" }, { "target": "com.amazonaws.iot#CreateKeysAndCertificate" }, { "target": "com.amazonaws.iot#CreateMitigationAction" }, { "target": "com.amazonaws.iot#CreateOTAUpdate" }, { "target": "com.amazonaws.iot#CreatePolicy" }, { "target": "com.amazonaws.iot#CreatePolicyVersion" }, { "target": "com.amazonaws.iot#CreateProvisioningClaim" }, { "target": "com.amazonaws.iot#CreateProvisioningTemplate" }, { "target": "com.amazonaws.iot#CreateProvisioningTemplateVersion" }, { "target": "com.amazonaws.iot#CreateRoleAlias" }, { "target": "com.amazonaws.iot#CreateScheduledAudit" }, { "target": "com.amazonaws.iot#CreateSecurityProfile" }, { "target": "com.amazonaws.iot#CreateStream" }, { "target": "com.amazonaws.iot#CreateThing" }, { "target": "com.amazonaws.iot#CreateThingGroup" }, { "target": "com.amazonaws.iot#CreateThingType" }, { "target": "com.amazonaws.iot#CreateTopicRule" }, { "target": "com.amazonaws.iot#CreateTopicRuleDestination" }, { "target": "com.amazonaws.iot#DeleteAccountAuditConfiguration" }, { "target": "com.amazonaws.iot#DeleteAuditSuppression" }, { "target": "com.amazonaws.iot#DeleteAuthorizer" }, { "target": "com.amazonaws.iot#DeleteBillingGroup" }, { "target": "com.amazonaws.iot#DeleteCACertificate" }, { "target": "com.amazonaws.iot#DeleteCertificate" }, { "target": "com.amazonaws.iot#DeleteCustomMetric" }, { "target": "com.amazonaws.iot#DeleteDimension" }, { "target": "com.amazonaws.iot#DeleteDomainConfiguration" }, { "target": "com.amazonaws.iot#DeleteDynamicThingGroup" }, { "target": "com.amazonaws.iot#DeleteJob" }, { "target": "com.amazonaws.iot#DeleteJobExecution" }, { "target": "com.amazonaws.iot#DeleteJobTemplate" }, { "target": "com.amazonaws.iot#DeleteMitigationAction" }, { "target": "com.amazonaws.iot#DeleteOTAUpdate" }, { "target": "com.amazonaws.iot#DeletePolicy" }, { "target": "com.amazonaws.iot#DeletePolicyVersion" }, { "target": "com.amazonaws.iot#DeleteProvisioningTemplate" }, { "target": "com.amazonaws.iot#DeleteProvisioningTemplateVersion" }, { "target": "com.amazonaws.iot#DeleteRegistrationCode" }, { "target": "com.amazonaws.iot#DeleteRoleAlias" }, { "target": "com.amazonaws.iot#DeleteScheduledAudit" }, { "target": "com.amazonaws.iot#DeleteSecurityProfile" }, { "target": "com.amazonaws.iot#DeleteStream" }, { "target": "com.amazonaws.iot#DeleteThing" }, { "target": "com.amazonaws.iot#DeleteThingGroup" }, { "target": "com.amazonaws.iot#DeleteThingType" }, { "target": "com.amazonaws.iot#DeleteTopicRule" }, { "target": "com.amazonaws.iot#DeleteTopicRuleDestination" }, { "target": "com.amazonaws.iot#DeleteV2LoggingLevel" }, { "target": "com.amazonaws.iot#DeprecateThingType" }, { "target": "com.amazonaws.iot#DescribeAccountAuditConfiguration" }, { "target": "com.amazonaws.iot#DescribeAuditFinding" }, { "target": "com.amazonaws.iot#DescribeAuditMitigationActionsTask" }, { "target": "com.amazonaws.iot#DescribeAuditSuppression" }, { "target": "com.amazonaws.iot#DescribeAuditTask" }, { "target": "com.amazonaws.iot#DescribeAuthorizer" }, { "target": "com.amazonaws.iot#DescribeBillingGroup" }, { "target": "com.amazonaws.iot#DescribeCACertificate" }, { "target": "com.amazonaws.iot#DescribeCertificate" }, { "target": "com.amazonaws.iot#DescribeCustomMetric" }, { "target": "com.amazonaws.iot#DescribeDefaultAuthorizer" }, { "target": "com.amazonaws.iot#DescribeDetectMitigationActionsTask" }, { "target": "com.amazonaws.iot#DescribeDimension" }, { "target": "com.amazonaws.iot#DescribeDomainConfiguration" }, { "target": "com.amazonaws.iot#DescribeEndpoint" }, { "target": "com.amazonaws.iot#DescribeEventConfigurations" }, { "target": "com.amazonaws.iot#DescribeIndex" }, { "target": "com.amazonaws.iot#DescribeJob" }, { "target": "com.amazonaws.iot#DescribeJobExecution" }, { "target": "com.amazonaws.iot#DescribeJobTemplate" }, { "target": "com.amazonaws.iot#DescribeMitigationAction" }, { "target": "com.amazonaws.iot#DescribeProvisioningTemplate" }, { "target": "com.amazonaws.iot#DescribeProvisioningTemplateVersion" }, { "target": "com.amazonaws.iot#DescribeRoleAlias" }, { "target": "com.amazonaws.iot#DescribeScheduledAudit" }, { "target": "com.amazonaws.iot#DescribeSecurityProfile" }, { "target": "com.amazonaws.iot#DescribeStream" }, { "target": "com.amazonaws.iot#DescribeThing" }, { "target": "com.amazonaws.iot#DescribeThingGroup" }, { "target": "com.amazonaws.iot#DescribeThingRegistrationTask" }, { "target": "com.amazonaws.iot#DescribeThingType" }, { "target": "com.amazonaws.iot#DetachPolicy" }, { "target": "com.amazonaws.iot#DetachPrincipalPolicy" }, { "target": "com.amazonaws.iot#DetachSecurityProfile" }, { "target": "com.amazonaws.iot#DetachThingPrincipal" }, { "target": "com.amazonaws.iot#DisableTopicRule" }, { "target": "com.amazonaws.iot#EnableTopicRule" }, { "target": "com.amazonaws.iot#GetBehaviorModelTrainingSummaries" }, { "target": "com.amazonaws.iot#GetCardinality" }, { "target": "com.amazonaws.iot#GetEffectivePolicies" }, { "target": "com.amazonaws.iot#GetIndexingConfiguration" }, { "target": "com.amazonaws.iot#GetJobDocument" }, { "target": "com.amazonaws.iot#GetLoggingOptions" }, { "target": "com.amazonaws.iot#GetOTAUpdate" }, { "target": "com.amazonaws.iot#GetPercentiles" }, { "target": "com.amazonaws.iot#GetPolicy" }, { "target": "com.amazonaws.iot#GetPolicyVersion" }, { "target": "com.amazonaws.iot#GetRegistrationCode" }, { "target": "com.amazonaws.iot#GetStatistics" }, { "target": "com.amazonaws.iot#GetTopicRule" }, { "target": "com.amazonaws.iot#GetTopicRuleDestination" }, { "target": "com.amazonaws.iot#GetV2LoggingOptions" }, { "target": "com.amazonaws.iot#ListActiveViolations" }, { "target": "com.amazonaws.iot#ListAttachedPolicies" }, { "target": "com.amazonaws.iot#ListAuditFindings" }, { "target": "com.amazonaws.iot#ListAuditMitigationActionsExecutions" }, { "target": "com.amazonaws.iot#ListAuditMitigationActionsTasks" }, { "target": "com.amazonaws.iot#ListAuditSuppressions" }, { "target": "com.amazonaws.iot#ListAuditTasks" }, { "target": "com.amazonaws.iot#ListAuthorizers" }, { "target": "com.amazonaws.iot#ListBillingGroups" }, { "target": "com.amazonaws.iot#ListCACertificates" }, { "target": "com.amazonaws.iot#ListCertificates" }, { "target": "com.amazonaws.iot#ListCertificatesByCA" }, { "target": "com.amazonaws.iot#ListCustomMetrics" }, { "target": "com.amazonaws.iot#ListDetectMitigationActionsExecutions" }, { "target": "com.amazonaws.iot#ListDetectMitigationActionsTasks" }, { "target": "com.amazonaws.iot#ListDimensions" }, { "target": "com.amazonaws.iot#ListDomainConfigurations" }, { "target": "com.amazonaws.iot#ListIndices" }, { "target": "com.amazonaws.iot#ListJobExecutionsForJob" }, { "target": "com.amazonaws.iot#ListJobExecutionsForThing" }, { "target": "com.amazonaws.iot#ListJobs" }, { "target": "com.amazonaws.iot#ListJobTemplates" }, { "target": "com.amazonaws.iot#ListMitigationActions" }, { "target": "com.amazonaws.iot#ListOTAUpdates" }, { "target": "com.amazonaws.iot#ListOutgoingCertificates" }, { "target": "com.amazonaws.iot#ListPolicies" }, { "target": "com.amazonaws.iot#ListPolicyPrincipals" }, { "target": "com.amazonaws.iot#ListPolicyVersions" }, { "target": "com.amazonaws.iot#ListPrincipalPolicies" }, { "target": "com.amazonaws.iot#ListPrincipalThings" }, { "target": "com.amazonaws.iot#ListProvisioningTemplates" }, { "target": "com.amazonaws.iot#ListProvisioningTemplateVersions" }, { "target": "com.amazonaws.iot#ListRoleAliases" }, { "target": "com.amazonaws.iot#ListScheduledAudits" }, { "target": "com.amazonaws.iot#ListSecurityProfiles" }, { "target": "com.amazonaws.iot#ListSecurityProfilesForTarget" }, { "target": "com.amazonaws.iot#ListStreams" }, { "target": "com.amazonaws.iot#ListTagsForResource" }, { "target": "com.amazonaws.iot#ListTargetsForPolicy" }, { "target": "com.amazonaws.iot#ListTargetsForSecurityProfile" }, { "target": "com.amazonaws.iot#ListThingGroups" }, { "target": "com.amazonaws.iot#ListThingGroupsForThing" }, { "target": "com.amazonaws.iot#ListThingPrincipals" }, { "target": "com.amazonaws.iot#ListThingRegistrationTaskReports" }, { "target": "com.amazonaws.iot#ListThingRegistrationTasks" }, { "target": "com.amazonaws.iot#ListThings" }, { "target": "com.amazonaws.iot#ListThingsInBillingGroup" }, { "target": "com.amazonaws.iot#ListThingsInThingGroup" }, { "target": "com.amazonaws.iot#ListThingTypes" }, { "target": "com.amazonaws.iot#ListTopicRuleDestinations" }, { "target": "com.amazonaws.iot#ListTopicRules" }, { "target": "com.amazonaws.iot#ListV2LoggingLevels" }, { "target": "com.amazonaws.iot#ListViolationEvents" }, { "target": "com.amazonaws.iot#RegisterCACertificate" }, { "target": "com.amazonaws.iot#RegisterCertificate" }, { "target": "com.amazonaws.iot#RegisterCertificateWithoutCA" }, { "target": "com.amazonaws.iot#RegisterThing" }, { "target": "com.amazonaws.iot#RejectCertificateTransfer" }, { "target": "com.amazonaws.iot#RemoveThingFromBillingGroup" }, { "target": "com.amazonaws.iot#RemoveThingFromThingGroup" }, { "target": "com.amazonaws.iot#ReplaceTopicRule" }, { "target": "com.amazonaws.iot#SearchIndex" }, { "target": "com.amazonaws.iot#SetDefaultAuthorizer" }, { "target": "com.amazonaws.iot#SetDefaultPolicyVersion" }, { "target": "com.amazonaws.iot#SetLoggingOptions" }, { "target": "com.amazonaws.iot#SetV2LoggingLevel" }, { "target": "com.amazonaws.iot#SetV2LoggingOptions" }, { "target": "com.amazonaws.iot#StartAuditMitigationActionsTask" }, { "target": "com.amazonaws.iot#StartDetectMitigationActionsTask" }, { "target": "com.amazonaws.iot#StartOnDemandAuditTask" }, { "target": "com.amazonaws.iot#StartThingRegistrationTask" }, { "target": "com.amazonaws.iot#StopThingRegistrationTask" }, { "target": "com.amazonaws.iot#TagResource" }, { "target": "com.amazonaws.iot#TestAuthorization" }, { "target": "com.amazonaws.iot#TestInvokeAuthorizer" }, { "target": "com.amazonaws.iot#TransferCertificate" }, { "target": "com.amazonaws.iot#UntagResource" }, { "target": "com.amazonaws.iot#UpdateAccountAuditConfiguration" }, { "target": "com.amazonaws.iot#UpdateAuditSuppression" }, { "target": "com.amazonaws.iot#UpdateAuthorizer" }, { "target": "com.amazonaws.iot#UpdateBillingGroup" }, { "target": "com.amazonaws.iot#UpdateCACertificate" }, { "target": "com.amazonaws.iot#UpdateCertificate" }, { "target": "com.amazonaws.iot#UpdateCustomMetric" }, { "target": "com.amazonaws.iot#UpdateDimension" }, { "target": "com.amazonaws.iot#UpdateDomainConfiguration" }, { "target": "com.amazonaws.iot#UpdateDynamicThingGroup" }, { "target": "com.amazonaws.iot#UpdateEventConfigurations" }, { "target": "com.amazonaws.iot#UpdateIndexingConfiguration" }, { "target": "com.amazonaws.iot#UpdateJob" }, { "target": "com.amazonaws.iot#UpdateMitigationAction" }, { "target": "com.amazonaws.iot#UpdateProvisioningTemplate" }, { "target": "com.amazonaws.iot#UpdateRoleAlias" }, { "target": "com.amazonaws.iot#UpdateScheduledAudit" }, { "target": "com.amazonaws.iot#UpdateSecurityProfile" }, { "target": "com.amazonaws.iot#UpdateStream" }, { "target": "com.amazonaws.iot#UpdateThing" }, { "target": "com.amazonaws.iot#UpdateThingGroup" }, { "target": "com.amazonaws.iot#UpdateThingGroupsForThing" }, { "target": "com.amazonaws.iot#UpdateTopicRuleDestination" }, { "target": "com.amazonaws.iot#ValidateSecurityProfileBehaviors" } ], "traits": { "aws.api#service": { "sdkId": "IoT", "arnNamespace": "iot", "cloudFormationName": "IoT", "cloudTrailEventSource": "iot.amazonaws.com", "endpointPrefix": "iot" }, "aws.auth#sigv4": { "name": "execute-api" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "AWS IoT\n

AWS IoT provides secure, bi-directional communication between Internet-connected\n devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS\n cloud. You can discover your custom IoT-Data endpoint to communicate with, configure\n rules for data processing and integration with other services, organize resources\n associated with each device (Registry), configure logging, and create and manage\n policies and credentials to authenticate devices.

\n

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

\n

The service name used by AWS\n Signature Version 4 to sign the request is:\n execute-api.

\n

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

\n

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

", "smithy.api#title": "AWS IoT" } }, "com.amazonaws.iot#AbortAction": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CANCEL", "name": "CANCEL" } ] } }, "com.amazonaws.iot#AbortConfig": { "type": "structure", "members": { "criteriaList": { "target": "com.amazonaws.iot#AbortCriteriaList", "traits": { "smithy.api#documentation": "

The list of criteria that determine when and how to abort the job.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The criteria that determine when and how a job abort takes place.

" } }, "com.amazonaws.iot#AbortCriteria": { "type": "structure", "members": { "failureType": { "target": "com.amazonaws.iot#JobExecutionFailureType", "traits": { "smithy.api#documentation": "

The type of job execution failures that can initiate a job abort.

", "smithy.api#required": {} } }, "action": { "target": "com.amazonaws.iot#AbortAction", "traits": { "smithy.api#documentation": "

The type of job action to take to initiate the job abort.

", "smithy.api#required": {} } }, "thresholdPercentage": { "target": "com.amazonaws.iot#AbortThresholdPercentage", "traits": { "smithy.api#documentation": "

The minimum percentage of job execution failures that must occur to initiate the job abort.

\n

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

", "smithy.api#required": {} } }, "minNumberOfExecutedThings": { "target": "com.amazonaws.iot#MinimumNumberOfExecutedThings", "traits": { "smithy.api#documentation": "

The minimum number of things which must receive job execution notifications before the job \n can be aborted.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The criteria that determine when and how a job abort takes place.

" } }, "com.amazonaws.iot#AbortCriteriaList": { "type": "list", "member": { "target": "com.amazonaws.iot#AbortCriteria" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#AbortThresholdPercentage": { "type": "double", "traits": { "smithy.api#box": {}, "smithy.api#range": { "max": 100 } } }, "com.amazonaws.iot#AcceptCertificateTransfer": { "type": "operation", "input": { "target": "com.amazonaws.iot#AcceptCertificateTransferRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#TransferAlreadyCompletedException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Accepts a pending certificate transfer. The default state of the certificate is\n INACTIVE.

\n

To check for pending certificate transfers, call ListCertificates\n to enumerate your certificates.

", "smithy.api#http": { "method": "PATCH", "uri": "/accept-certificate-transfer/{certificateId}", "code": 200 } } }, "com.amazonaws.iot#AcceptCertificateTransferRequest": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "setAsActive": { "target": "com.amazonaws.iot#SetAsActive", "traits": { "smithy.api#documentation": "

Specifies whether the certificate is active.

", "smithy.api#httpQuery": "setAsActive" } } }, "traits": { "smithy.api#documentation": "

The input for the AcceptCertificateTransfer operation.

" } }, "com.amazonaws.iot#AcmCertificateArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#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/-]+" } }, "com.amazonaws.iot#Action": { "type": "structure", "members": { "dynamoDB": { "target": "com.amazonaws.iot#DynamoDBAction", "traits": { "smithy.api#documentation": "

Write to a DynamoDB table.

" } }, "dynamoDBv2": { "target": "com.amazonaws.iot#DynamoDBv2Action", "traits": { "smithy.api#documentation": "

Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows\n you to write each attribute in an MQTT message payload into a separate DynamoDB\n column.

" } }, "lambda": { "target": "com.amazonaws.iot#LambdaAction", "traits": { "smithy.api#documentation": "

Invoke a Lambda function.

" } }, "sns": { "target": "com.amazonaws.iot#SnsAction", "traits": { "smithy.api#documentation": "

Publish to an Amazon SNS topic.

" } }, "sqs": { "target": "com.amazonaws.iot#SqsAction", "traits": { "smithy.api#documentation": "

Publish to an Amazon SQS queue.

" } }, "kinesis": { "target": "com.amazonaws.iot#KinesisAction", "traits": { "smithy.api#documentation": "

Write data to an Amazon Kinesis stream.

" } }, "republish": { "target": "com.amazonaws.iot#RepublishAction", "traits": { "smithy.api#documentation": "

Publish to another MQTT topic.

" } }, "s3": { "target": "com.amazonaws.iot#S3Action", "traits": { "smithy.api#documentation": "

Write to an Amazon S3 bucket.

" } }, "firehose": { "target": "com.amazonaws.iot#FirehoseAction", "traits": { "smithy.api#documentation": "

Write to an Amazon Kinesis Firehose stream.

" } }, "cloudwatchMetric": { "target": "com.amazonaws.iot#CloudwatchMetricAction", "traits": { "smithy.api#documentation": "

Capture a CloudWatch metric.

" } }, "cloudwatchAlarm": { "target": "com.amazonaws.iot#CloudwatchAlarmAction", "traits": { "smithy.api#documentation": "

Change the state of a CloudWatch alarm.

" } }, "cloudwatchLogs": { "target": "com.amazonaws.iot#CloudwatchLogsAction", "traits": { "smithy.api#documentation": "

Send data to CloudWatch Logs.

" } }, "elasticsearch": { "target": "com.amazonaws.iot#ElasticsearchAction", "traits": { "smithy.api#documentation": "

Write data to an Amazon Elasticsearch Service domain.

" } }, "salesforce": { "target": "com.amazonaws.iot#SalesforceAction", "traits": { "smithy.api#documentation": "

Send a message to a Salesforce IoT Cloud Input Stream.

" } }, "iotAnalytics": { "target": "com.amazonaws.iot#IotAnalyticsAction", "traits": { "smithy.api#documentation": "

Sends message data to an AWS IoT Analytics channel.

" } }, "iotEvents": { "target": "com.amazonaws.iot#IotEventsAction", "traits": { "smithy.api#documentation": "

Sends an input to an AWS IoT Events detector.

" } }, "iotSiteWise": { "target": "com.amazonaws.iot#IotSiteWiseAction", "traits": { "smithy.api#documentation": "

Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset\n properties.

" } }, "stepFunctions": { "target": "com.amazonaws.iot#StepFunctionsAction", "traits": { "smithy.api#documentation": "

Starts execution of a Step Functions state machine.

" } }, "timestream": { "target": "com.amazonaws.iot#TimestreamAction", "traits": { "smithy.api#documentation": "

The Timestream rule action writes attributes (measures) from an MQTT message\n into an Amazon Timestream table. For more information, see the Timestream\n topic rule action documentation.

" } }, "http": { "target": "com.amazonaws.iot#HttpAction", "traits": { "smithy.api#documentation": "

Send data to an HTTPS endpoint.

" } }, "kafka": { "target": "com.amazonaws.iot#KafkaAction", "traits": { "smithy.api#documentation": "

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

" } } }, "traits": { "smithy.api#documentation": "

Describes the actions associated with a rule.

" } }, "com.amazonaws.iot#ActionList": { "type": "list", "member": { "target": "com.amazonaws.iot#Action" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.iot#ActionType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PUBLISH", "name": "PUBLISH" }, { "value": "SUBSCRIBE", "name": "SUBSCRIBE" }, { "value": "RECEIVE", "name": "RECEIVE" }, { "value": "CONNECT", "name": "CONNECT" } ] } }, "com.amazonaws.iot#ActiveViolation": { "type": "structure", "members": { "violationId": { "target": "com.amazonaws.iot#ViolationId", "traits": { "smithy.api#documentation": "

The ID of the active violation.

" } }, "thingName": { "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { "smithy.api#documentation": "

The name of the thing responsible for the active violation.

" } }, "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The security profile with the behavior is in violation.

" } }, "behavior": { "target": "com.amazonaws.iot#Behavior", "traits": { "smithy.api#documentation": "

The behavior that is being violated.

" } }, "lastViolationValue": { "target": "com.amazonaws.iot#MetricValue", "traits": { "smithy.api#documentation": "

The value of the metric (the measurement) that caused the most recent violation.

" } }, "violationEventAdditionalInfo": { "target": "com.amazonaws.iot#ViolationEventAdditionalInfo", "traits": { "smithy.api#documentation": "

\n The details of a violation event.\n

" } }, "lastViolationTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time the most recent violation occurred.

" } }, "violationStartTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time the violation started.

" } } }, "traits": { "smithy.api#documentation": "

Information about an active Device Defender security profile behavior violation.

" } }, "com.amazonaws.iot#ActiveViolations": { "type": "list", "member": { "target": "com.amazonaws.iot#ActiveViolation" } }, "com.amazonaws.iot#AddThingToBillingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#AddThingToBillingGroupRequest" }, "output": { "target": "com.amazonaws.iot#AddThingToBillingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Adds a thing to a billing group.

", "smithy.api#http": { "method": "PUT", "uri": "/billing-groups/addThingToBillingGroup", "code": 200 } } }, "com.amazonaws.iot#AddThingToBillingGroupRequest": { "type": "structure", "members": { "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name of the billing group.

" } }, "billingGroupArn": { "target": "com.amazonaws.iot#BillingGroupArn", "traits": { "smithy.api#documentation": "

The ARN of the billing group.

" } }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing to be added to the billing group.

" } }, "thingArn": { "target": "com.amazonaws.iot#ThingArn", "traits": { "smithy.api#documentation": "

The ARN of the thing to be added to the billing group.

" } } } }, "com.amazonaws.iot#AddThingToBillingGroupResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#AddThingToThingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#AddThingToThingGroupRequest" }, "output": { "target": "com.amazonaws.iot#AddThingToThingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Adds a thing to a thing group.

", "smithy.api#http": { "method": "PUT", "uri": "/thing-groups/addThingToThingGroup", "code": 200 } } }, "com.amazonaws.iot#AddThingToThingGroupRequest": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The name of the group to which you are adding a thing.

" } }, "thingGroupArn": { "target": "com.amazonaws.iot#ThingGroupArn", "traits": { "smithy.api#documentation": "

The ARN of the group to which you are adding a thing.

" } }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing to add to a group.

" } }, "thingArn": { "target": "com.amazonaws.iot#ThingArn", "traits": { "smithy.api#documentation": "

The ARN of the thing to add to a group.

" } }, "overrideDynamicGroups": { "target": "com.amazonaws.iot#OverrideDynamicGroups", "traits": { "smithy.api#documentation": "

Override dynamic thing groups with static thing groups when 10-group limit is\n\t\t\treached. If a thing belongs to 10 thing groups, and one or more of those groups are\n\t\t\tdynamic thing groups, adding a thing to a static group removes the thing from the last\n\t\t\tdynamic group.

" } } } }, "com.amazonaws.iot#AddThingToThingGroupResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#AddThingsToThingGroupParams": { "type": "structure", "members": { "thingGroupNames": { "target": "com.amazonaws.iot#ThingGroupNames", "traits": { "smithy.api#documentation": "

The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can't add a thing to more than one group in the same hierarchy.

", "smithy.api#required": {} } }, "overrideDynamicGroups": { "target": "com.amazonaws.iot#OverrideDynamicGroups", "traits": { "smithy.api#documentation": "

Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.

" } } }, "traits": { "smithy.api#documentation": "

Parameters used when defining a mitigation action that move a set of things to a thing group.

" } }, "com.amazonaws.iot#AdditionalMetricsToRetainList": { "type": "list", "member": { "target": "com.amazonaws.iot#BehaviorMetric" } }, "com.amazonaws.iot#AdditionalMetricsToRetainV2List": { "type": "list", "member": { "target": "com.amazonaws.iot#MetricToRetain" } }, "com.amazonaws.iot#AdditionalParameterMap": { "type": "map", "key": { "target": "com.amazonaws.iot#AttributeKey" }, "value": { "target": "com.amazonaws.iot#Value" } }, "com.amazonaws.iot#AggregationField": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#AlarmName": { "type": "string" }, "com.amazonaws.iot#AlertTarget": { "type": "structure", "members": { "alertTargetArn": { "target": "com.amazonaws.iot#AlertTargetArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the notification target to which alerts are sent.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the role that grants permission to send alerts to the \n notification target.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A structure containing the alert target ARN and the role ARN.

" } }, "com.amazonaws.iot#AlertTargetArn": { "type": "string" }, "com.amazonaws.iot#AlertTargetType": { "type": "string", "traits": { "smithy.api#documentation": "

The type of alert target: one of \"SNS\".

", "smithy.api#enum": [ { "value": "SNS", "name": "SNS" } ] } }, "com.amazonaws.iot#AlertTargets": { "type": "map", "key": { "target": "com.amazonaws.iot#AlertTargetType" }, "value": { "target": "com.amazonaws.iot#AlertTarget" } }, "com.amazonaws.iot#AllowAuthorizerOverride": { "type": "boolean" }, "com.amazonaws.iot#AllowAutoRegistration": { "type": "boolean" }, "com.amazonaws.iot#Allowed": { "type": "structure", "members": { "policies": { "target": "com.amazonaws.iot#Policies", "traits": { "smithy.api#documentation": "

A list of policies that allowed the authentication.

" } } }, "traits": { "smithy.api#documentation": "

Contains information that allowed the authorization.

" } }, "com.amazonaws.iot#ApproximateSecondsBeforeTimedOut": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#AscendingOrder": { "type": "boolean" }, "com.amazonaws.iot#AssetId": { "type": "string" }, "com.amazonaws.iot#AssetPropertyAlias": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#AssetPropertyBooleanValue": { "type": "string" }, "com.amazonaws.iot#AssetPropertyDoubleValue": { "type": "string" }, "com.amazonaws.iot#AssetPropertyEntryId": { "type": "string" }, "com.amazonaws.iot#AssetPropertyId": { "type": "string" }, "com.amazonaws.iot#AssetPropertyIntegerValue": { "type": "string" }, "com.amazonaws.iot#AssetPropertyOffsetInNanos": { "type": "string" }, "com.amazonaws.iot#AssetPropertyQuality": { "type": "string" }, "com.amazonaws.iot#AssetPropertyStringValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.iot#AssetPropertyTimeInSeconds": { "type": "string" }, "com.amazonaws.iot#AssetPropertyTimestamp": { "type": "structure", "members": { "timeInSeconds": { "target": "com.amazonaws.iot#AssetPropertyTimeInSeconds", "traits": { "smithy.api#documentation": "

A string that contains the time in seconds since epoch. Accepts substitution\n templates.

", "smithy.api#required": {} } }, "offsetInNanos": { "target": "com.amazonaws.iot#AssetPropertyOffsetInNanos", "traits": { "smithy.api#documentation": "

Optional. A string that contains the nanosecond time offset. Accepts substitution\n templates.

" } } }, "traits": { "smithy.api#documentation": "

An asset property timestamp entry containing the following information.

" } }, "com.amazonaws.iot#AssetPropertyValue": { "type": "structure", "members": { "value": { "target": "com.amazonaws.iot#AssetPropertyVariant", "traits": { "smithy.api#documentation": "

The value of the asset property.

", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.iot#AssetPropertyTimestamp", "traits": { "smithy.api#documentation": "

The asset property value timestamp.

", "smithy.api#required": {} } }, "quality": { "target": "com.amazonaws.iot#AssetPropertyQuality", "traits": { "smithy.api#documentation": "

Optional. A string that describes the quality of the value. Accepts substitution\n templates. Must be GOOD, BAD, or UNCERTAIN.

" } } }, "traits": { "smithy.api#documentation": "

An asset property value entry containing the following information.

" } }, "com.amazonaws.iot#AssetPropertyValueList": { "type": "list", "member": { "target": "com.amazonaws.iot#AssetPropertyValue" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#AssetPropertyVariant": { "type": "union", "members": { "stringValue": { "target": "com.amazonaws.iot#AssetPropertyStringValue", "traits": { "smithy.api#documentation": "

Optional. The string value of the value entry. Accepts substitution templates.

" } }, "integerValue": { "target": "com.amazonaws.iot#AssetPropertyIntegerValue", "traits": { "smithy.api#documentation": "

Optional. A string that contains the integer value of the value entry. Accepts\n substitution templates.

" } }, "doubleValue": { "target": "com.amazonaws.iot#AssetPropertyDoubleValue", "traits": { "smithy.api#documentation": "

Optional. A string that contains the double value of the value entry. Accepts substitution\n templates.

" } }, "booleanValue": { "target": "com.amazonaws.iot#AssetPropertyBooleanValue", "traits": { "smithy.api#documentation": "

Optional. A string that contains the boolean value (true or\n false) of the value entry. Accepts substitution templates.

" } } }, "traits": { "smithy.api#documentation": "

Contains an asset property value (of a single type).

" } }, "com.amazonaws.iot#AssociateTargetsWithJob": { "type": "operation", "input": { "target": "com.amazonaws.iot#AssociateTargetsWithJobRequest" }, "output": { "target": "com.amazonaws.iot#AssociateTargetsWithJobResponse" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Associates a group with a continuous job. The following criteria must be met:

\n ", "smithy.api#http": { "method": "POST", "uri": "/jobs/{jobId}/targets", "code": 200 } } }, "com.amazonaws.iot#AssociateTargetsWithJobRequest": { "type": "structure", "members": { "targets": { "target": "com.amazonaws.iot#JobTargets", "traits": { "smithy.api#documentation": "

A list of thing group ARNs that define the targets of the job.

", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "comment": { "target": "com.amazonaws.iot#Comment", "traits": { "smithy.api#documentation": "

An optional comment string describing why the job was associated with the targets.

" } }, "namespaceId": { "target": "com.amazonaws.iot#NamespaceId", "traits": { "smithy.api#documentation": "

The namespace used to indicate that a job is a customer-managed job.

\n

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that \n contain the value in the following format.

\n

\n $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/\n

\n \n

The namespaceId feature is in public preview.

\n
", "smithy.api#httpQuery": "namespaceId" } } } }, "com.amazonaws.iot#AssociateTargetsWithJobResponse": { "type": "structure", "members": { "jobArn": { "target": "com.amazonaws.iot#JobArn", "traits": { "smithy.api#documentation": "

An ARN identifying the job.

" } }, "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" } }, "description": { "target": "com.amazonaws.iot#JobDescription", "traits": { "smithy.api#documentation": "

A short text description of the job.

" } } } }, "com.amazonaws.iot#AttachPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iot#AttachPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Attaches a policy to the specified target.

", "smithy.api#http": { "method": "PUT", "uri": "/target-policies/{policyName}", "code": 200 } } }, "com.amazonaws.iot#AttachPolicyRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The name of the policy to attach.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.iot#PolicyTarget", "traits": { "smithy.api#documentation": "

The identity to which the policy is attached. For example, a thing group or a certificate.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#AttachPrincipalPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iot#AttachPrincipalPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

Attaches the specified policy to the specified principal (certificate or other\n credential).

\n

\n Note: This API is deprecated. Please use AttachPolicy instead.

", "smithy.api#http": { "method": "PUT", "uri": "/principal-policies/{policyName}", "code": 200 } } }, "com.amazonaws.iot#AttachPrincipalPolicyRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "principal": { "target": "com.amazonaws.iot#Principal", "traits": { "smithy.api#documentation": "

The principal, which can be a certificate ARN (as returned from the CreateCertificate\n operation) or an Amazon Cognito ID.

", "smithy.api#httpHeader": "x-amzn-iot-principal", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the AttachPrincipalPolicy operation.

" } }, "com.amazonaws.iot#AttachSecurityProfile": { "type": "operation", "input": { "target": "com.amazonaws.iot#AttachSecurityProfileRequest" }, "output": { "target": "com.amazonaws.iot#AttachSecurityProfileResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Associates a Device Defender security profile with a thing group or this account. Each \n thing group or account can have up to five security profiles associated with it.

", "smithy.api#http": { "method": "PUT", "uri": "/security-profiles/{securityProfileName}/targets", "code": 200 } } }, "com.amazonaws.iot#AttachSecurityProfileRequest": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The security profile that is attached.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "securityProfileTargetArn": { "target": "com.amazonaws.iot#SecurityProfileTargetArn", "traits": { "smithy.api#documentation": "

The ARN of the target (thing group) to which the security profile is attached.

", "smithy.api#httpQuery": "securityProfileTargetArn", "smithy.api#required": {} } } } }, "com.amazonaws.iot#AttachSecurityProfileResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#AttachThingPrincipal": { "type": "operation", "input": { "target": "com.amazonaws.iot#AttachThingPrincipalRequest" }, "output": { "target": "com.amazonaws.iot#AttachThingPrincipalResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Attaches the specified principal to the specified thing. A principal can be X.509\n\t\t\tcertificates, IAM users, groups, and roles, Amazon Cognito identities or federated\n\t\t\tidentities.

", "smithy.api#http": { "method": "PUT", "uri": "/things/{thingName}/principals", "code": 200 } } }, "com.amazonaws.iot#AttachThingPrincipalRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "principal": { "target": "com.amazonaws.iot#Principal", "traits": { "smithy.api#documentation": "

The principal, which can be a certificate ARN (as returned from the\n\t\t\tCreateCertificate operation) or an Amazon Cognito ID.

", "smithy.api#httpHeader": "x-amzn-principal", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the AttachThingPrincipal operation.

" } }, "com.amazonaws.iot#AttachThingPrincipalResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The output from the AttachThingPrincipal operation.

" } }, "com.amazonaws.iot#AttributeKey": { "type": "string" }, "com.amazonaws.iot#AttributeName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9_.,@/:#-]+" } }, "com.amazonaws.iot#AttributePayload": { "type": "structure", "members": { "attributes": { "target": "com.amazonaws.iot#Attributes", "traits": { "smithy.api#documentation": "

A JSON string containing up to three key-value pair in JSON format. For example:

\n\t\t

\n\t\t\t {\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}\n\t\t

" } }, "merge": { "target": "com.amazonaws.iot#Flag", "traits": { "smithy.api#documentation": "

Specifies whether the list of attributes provided in the AttributePayload is merged with\n\t\t\tthe attributes stored in the registry, instead of overwriting them.

\n\t\t

To remove an attribute, call UpdateThing with an empty attribute value.

\n\t\t \n\t\t\t

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

\n\t\t
" } } }, "traits": { "smithy.api#documentation": "

The attribute payload.

" } }, "com.amazonaws.iot#AttributeValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 800 }, "smithy.api#pattern": "[a-zA-Z0-9_.,@/:#-]*" } }, "com.amazonaws.iot#Attributes": { "type": "map", "key": { "target": "com.amazonaws.iot#AttributeName" }, "value": { "target": "com.amazonaws.iot#AttributeValue" } }, "com.amazonaws.iot#AttributesMap": { "type": "map", "key": { "target": "com.amazonaws.iot#AttributeKey" }, "value": { "target": "com.amazonaws.iot#Value" } }, "com.amazonaws.iot#AuditCheckConfiguration": { "type": "structure", "members": { "enabled": { "target": "com.amazonaws.iot#Enabled", "traits": { "smithy.api#documentation": "

True if this audit check is enabled for this account.

" } } }, "traits": { "smithy.api#documentation": "

Which audit checks are enabled and disabled for this account.

" } }, "com.amazonaws.iot#AuditCheckConfigurations": { "type": "map", "key": { "target": "com.amazonaws.iot#AuditCheckName" }, "value": { "target": "com.amazonaws.iot#AuditCheckConfiguration" } }, "com.amazonaws.iot#AuditCheckDetails": { "type": "structure", "members": { "checkRunStatus": { "target": "com.amazonaws.iot#AuditCheckRunStatus", "traits": { "smithy.api#documentation": "

The completion status of this check. One of \"IN_PROGRESS\", \"WAITING_FOR_DATA_COLLECTION\",\n \"CANCELED\", \"COMPLETED_COMPLIANT\", \"COMPLETED_NON_COMPLIANT\", or \"FAILED\".

" } }, "checkCompliant": { "target": "com.amazonaws.iot#CheckCompliant", "traits": { "smithy.api#documentation": "

True if the check is complete and found all resources compliant.

" } }, "totalResourcesCount": { "target": "com.amazonaws.iot#TotalResourcesCount", "traits": { "smithy.api#documentation": "

The number of resources on which the check was performed.

" } }, "nonCompliantResourcesCount": { "target": "com.amazonaws.iot#NonCompliantResourcesCount", "traits": { "smithy.api#documentation": "

The number of resources that were found noncompliant during the check.

" } }, "suppressedNonCompliantResourcesCount": { "target": "com.amazonaws.iot#SuppressedNonCompliantResourcesCount", "traits": { "smithy.api#documentation": "

\n Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.\n

" } }, "errorCode": { "target": "com.amazonaws.iot#ErrorCode", "traits": { "smithy.api#documentation": "

The code of any error encountered when this check is performed during this audit.\n One of \"INSUFFICIENT_PERMISSIONS\" or \"AUDIT_CHECK_DISABLED\".

" } }, "message": { "target": "com.amazonaws.iot#ErrorMessage", "traits": { "smithy.api#documentation": "

The message associated with any error encountered when this check is performed during this audit.

" } } }, "traits": { "smithy.api#documentation": "

Information about the audit check.

" } }, "com.amazonaws.iot#AuditCheckName": { "type": "string", "traits": { "smithy.api#documentation": "

An audit check name. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

" } }, "com.amazonaws.iot#AuditCheckRunStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "WAITING_FOR_DATA_COLLECTION", "name": "WAITING_FOR_DATA_COLLECTION" }, { "value": "CANCELED", "name": "CANCELED" }, { "value": "COMPLETED_COMPLIANT", "name": "COMPLETED_COMPLIANT" }, { "value": "COMPLETED_NON_COMPLIANT", "name": "COMPLETED_NON_COMPLIANT" }, { "value": "FAILED", "name": "FAILED" } ] } }, "com.amazonaws.iot#AuditCheckToActionsMapping": { "type": "map", "key": { "target": "com.amazonaws.iot#AuditCheckName" }, "value": { "target": "com.amazonaws.iot#MitigationActionNameList" } }, "com.amazonaws.iot#AuditCheckToReasonCodeFilter": { "type": "map", "key": { "target": "com.amazonaws.iot#AuditCheckName" }, "value": { "target": "com.amazonaws.iot#ReasonForNonComplianceCodes" } }, "com.amazonaws.iot#AuditDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "[\\p{Graph}\\x20]*" } }, "com.amazonaws.iot#AuditDetails": { "type": "map", "key": { "target": "com.amazonaws.iot#AuditCheckName" }, "value": { "target": "com.amazonaws.iot#AuditCheckDetails" } }, "com.amazonaws.iot#AuditFinding": { "type": "structure", "members": { "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { "smithy.api#documentation": "

A unique identifier for this set of audit findings. This identifier is used to apply\n mitigation tasks to one or more sets of findings.

" } }, "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { "smithy.api#documentation": "

The ID of the audit that generated this result (finding).

" } }, "checkName": { "target": "com.amazonaws.iot#AuditCheckName", "traits": { "smithy.api#documentation": "

The audit check that generated this result.

" } }, "taskStartTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time the audit started.

" } }, "findingTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time the result (finding) was discovered.

" } }, "severity": { "target": "com.amazonaws.iot#AuditFindingSeverity", "traits": { "smithy.api#documentation": "

The severity of the result (finding).

" } }, "nonCompliantResource": { "target": "com.amazonaws.iot#NonCompliantResource", "traits": { "smithy.api#documentation": "

The resource that was found to be noncompliant with the\n audit check.

" } }, "relatedResources": { "target": "com.amazonaws.iot#RelatedResources", "traits": { "smithy.api#documentation": "

The list of related resources.

" } }, "reasonForNonCompliance": { "target": "com.amazonaws.iot#ReasonForNonCompliance", "traits": { "smithy.api#documentation": "

The reason the resource was noncompliant.

" } }, "reasonForNonComplianceCode": { "target": "com.amazonaws.iot#ReasonForNonComplianceCode", "traits": { "smithy.api#documentation": "

A code that indicates the reason that the resource was noncompliant.

" } }, "isSuppressed": { "target": "com.amazonaws.iot#IsSuppressed", "traits": { "smithy.api#documentation": "

\n Indicates whether the audit finding was suppressed or not during reporting.\n

" } } }, "traits": { "smithy.api#documentation": "

The findings (results) of the audit.

" } }, "com.amazonaws.iot#AuditFindingSeverity": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CRITICAL", "name": "CRITICAL" }, { "value": "HIGH", "name": "HIGH" }, { "value": "MEDIUM", "name": "MEDIUM" }, { "value": "LOW", "name": "LOW" } ] } }, "com.amazonaws.iot#AuditFindings": { "type": "list", "member": { "target": "com.amazonaws.iot#AuditFinding" } }, "com.amazonaws.iot#AuditFrequency": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DAILY", "name": "DAILY" }, { "value": "WEEKLY", "name": "WEEKLY" }, { "value": "BIWEEKLY", "name": "BIWEEKLY" }, { "value": "MONTHLY", "name": "MONTHLY" } ] } }, "com.amazonaws.iot#AuditMitigationActionExecutionMetadata": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

The unique identifier for the task that applies the mitigation action.

" } }, "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { "smithy.api#documentation": "

The unique identifier for the findings to which the task and associated mitigation action are applied.

" } }, "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { "smithy.api#documentation": "

The friendly name of the mitigation action being applied by the task.

" } }, "actionId": { "target": "com.amazonaws.iot#MitigationActionId", "traits": { "smithy.api#documentation": "

The unique identifier for the mitigation action being applied by the task.

" } }, "status": { "target": "com.amazonaws.iot#AuditMitigationActionsExecutionStatus", "traits": { "smithy.api#documentation": "

The current status of the task being executed.

" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the task was started.

" } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the task was completed or canceled. Blank if the task is still running.

" } }, "errorCode": { "target": "com.amazonaws.iot#ErrorCode", "traits": { "smithy.api#documentation": "

If an error occurred, the code that indicates which type of error occurred.

" } }, "message": { "target": "com.amazonaws.iot#ErrorMessage", "traits": { "smithy.api#documentation": "

If an error occurred, a message that describes the error.

" } } }, "traits": { "smithy.api#documentation": "

Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.

" } }, "com.amazonaws.iot#AuditMitigationActionExecutionMetadataList": { "type": "list", "member": { "target": "com.amazonaws.iot#AuditMitigationActionExecutionMetadata" } }, "com.amazonaws.iot#AuditMitigationActionsExecutionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "FAILED", "name": "FAILED" }, { "value": "CANCELED", "name": "CANCELED" }, { "value": "SKIPPED", "name": "SKIPPED" }, { "value": "PENDING", "name": "PENDING" } ] } }, "com.amazonaws.iot#AuditMitigationActionsTaskMetadata": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

The unique identifier for the task.

" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the audit mitigation actions task was started.

" } }, "taskStatus": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatus", "traits": { "smithy.api#documentation": "

The current state of the audit mitigation actions task.

" } } }, "traits": { "smithy.api#documentation": "

Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks.

" } }, "com.amazonaws.iot#AuditMitigationActionsTaskMetadataList": { "type": "list", "member": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskMetadata" } }, "com.amazonaws.iot#AuditMitigationActionsTaskStatistics": { "type": "map", "key": { "target": "com.amazonaws.iot#AuditCheckName" }, "value": { "target": "com.amazonaws.iot#TaskStatisticsForAuditCheck" } }, "com.amazonaws.iot#AuditMitigationActionsTaskStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "FAILED", "name": "FAILED" }, { "value": "CANCELED", "name": "CANCELED" } ] } }, "com.amazonaws.iot#AuditMitigationActionsTaskTarget": { "type": "structure", "members": { "auditTaskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { "smithy.api#documentation": "

If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.

" } }, "findingIds": { "target": "com.amazonaws.iot#FindingIds", "traits": { "smithy.api#documentation": "

If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.

" } }, "auditCheckToReasonCodeFilter": { "target": "com.amazonaws.iot#AuditCheckToReasonCodeFilter", "traits": { "smithy.api#documentation": "

Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.

" } } }, "traits": { "smithy.api#documentation": "

Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.

" } }, "com.amazonaws.iot#AuditNotificationTarget": { "type": "structure", "members": { "targetArn": { "target": "com.amazonaws.iot#TargetArn", "traits": { "smithy.api#documentation": "

The ARN of the target (SNS topic) to which audit notifications are sent.

" } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the role that grants permission to send notifications to the target.

" } }, "enabled": { "target": "com.amazonaws.iot#Enabled", "traits": { "smithy.api#documentation": "

True if notifications to the target are enabled.

" } } }, "traits": { "smithy.api#documentation": "

Information about the targets to which audit notifications are sent.

" } }, "com.amazonaws.iot#AuditNotificationTargetConfigurations": { "type": "map", "key": { "target": "com.amazonaws.iot#AuditNotificationType" }, "value": { "target": "com.amazonaws.iot#AuditNotificationTarget" } }, "com.amazonaws.iot#AuditNotificationType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SNS", "name": "SNS" } ] } }, "com.amazonaws.iot#AuditSuppression": { "type": "structure", "members": { "checkName": { "target": "com.amazonaws.iot#AuditCheckName", "traits": { "smithy.api#required": {} } }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier", "traits": { "smithy.api#required": {} } }, "expirationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.\n

" } }, "suppressIndefinitely": { "target": "com.amazonaws.iot#SuppressIndefinitely", "traits": { "smithy.api#documentation": "

\n Indicates whether a suppression should exist indefinitely or not.\n

" } }, "description": { "target": "com.amazonaws.iot#AuditDescription", "traits": { "smithy.api#documentation": "

\n The description of the audit suppression.\n

" } } }, "traits": { "smithy.api#documentation": "

Filters out specific findings of a Device Defender audit.

" } }, "com.amazonaws.iot#AuditSuppressionList": { "type": "list", "member": { "target": "com.amazonaws.iot#AuditSuppression" } }, "com.amazonaws.iot#AuditTaskId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 40 }, "smithy.api#pattern": "[a-zA-Z0-9\\-]+" } }, "com.amazonaws.iot#AuditTaskMetadata": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { "smithy.api#documentation": "

The ID of this audit.

" } }, "taskStatus": { "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { "smithy.api#documentation": "

The status of this audit. One of \"IN_PROGRESS\", \"COMPLETED\",\n \"FAILED\", or \"CANCELED\".

" } }, "taskType": { "target": "com.amazonaws.iot#AuditTaskType", "traits": { "smithy.api#documentation": "

The type of this audit. One of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".

" } } }, "traits": { "smithy.api#documentation": "

The audits that were performed.

" } }, "com.amazonaws.iot#AuditTaskMetadataList": { "type": "list", "member": { "target": "com.amazonaws.iot#AuditTaskMetadata" } }, "com.amazonaws.iot#AuditTaskStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "FAILED", "name": "FAILED" }, { "value": "CANCELED", "name": "CANCELED" } ] } }, "com.amazonaws.iot#AuditTaskType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ON_DEMAND_AUDIT_TASK", "name": "ON_DEMAND_AUDIT_TASK" }, { "value": "SCHEDULED_AUDIT_TASK", "name": "SCHEDULED_AUDIT_TASK" } ] } }, "com.amazonaws.iot#AuthDecision": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ALLOWED", "name": "ALLOWED" }, { "value": "EXPLICIT_DENY", "name": "EXPLICIT_DENY" }, { "value": "IMPLICIT_DENY", "name": "IMPLICIT_DENY" } ] } }, "com.amazonaws.iot#AuthInfo": { "type": "structure", "members": { "actionType": { "target": "com.amazonaws.iot#ActionType", "traits": { "smithy.api#documentation": "

The type of action for which the principal is being authorized.

" } }, "resources": { "target": "com.amazonaws.iot#Resources", "traits": { "smithy.api#documentation": "

The resources for which the principal is being authorized to perform the specified\n action.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A collection of authorization information.

" } }, "com.amazonaws.iot#AuthInfos": { "type": "list", "member": { "target": "com.amazonaws.iot#AuthInfo" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.iot#AuthResult": { "type": "structure", "members": { "authInfo": { "target": "com.amazonaws.iot#AuthInfo", "traits": { "smithy.api#documentation": "

Authorization information.

" } }, "allowed": { "target": "com.amazonaws.iot#Allowed", "traits": { "smithy.api#documentation": "

The policies and statements that allowed the specified action.

" } }, "denied": { "target": "com.amazonaws.iot#Denied", "traits": { "smithy.api#documentation": "

The policies and statements that denied the specified action.

" } }, "authDecision": { "target": "com.amazonaws.iot#AuthDecision", "traits": { "smithy.api#documentation": "

The final authorization decision of this scenario. Multiple statements are taken into\n account when determining the authorization decision. An explicit deny statement can\n override multiple allow statements.

" } }, "missingContextValues": { "target": "com.amazonaws.iot#MissingContextValues", "traits": { "smithy.api#documentation": "

Contains any missing context values found while evaluating policy.

" } } }, "traits": { "smithy.api#documentation": "

The authorizer result.

" } }, "com.amazonaws.iot#AuthResults": { "type": "list", "member": { "target": "com.amazonaws.iot#AuthResult" } }, "com.amazonaws.iot#AuthorizerArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.iot#AuthorizerConfig": { "type": "structure", "members": { "defaultAuthorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The name of the authorization service for a domain configuration.

" } }, "allowAuthorizerOverride": { "target": "com.amazonaws.iot#AllowAuthorizerOverride", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

A Boolean that specifies whether the domain configuration's authorization service can be overridden.

" } } }, "traits": { "smithy.api#documentation": "

An object that specifies the authorization service for a domain.

" } }, "com.amazonaws.iot#AuthorizerDescription": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The authorizer name.

" } }, "authorizerArn": { "target": "com.amazonaws.iot#AuthorizerArn", "traits": { "smithy.api#documentation": "

The authorizer ARN.

" } }, "authorizerFunctionArn": { "target": "com.amazonaws.iot#AuthorizerFunctionArn", "traits": { "smithy.api#documentation": "

The authorizer's Lambda function ARN.

" } }, "tokenKeyName": { "target": "com.amazonaws.iot#TokenKeyName", "traits": { "smithy.api#documentation": "

The key used to extract the token from the HTTP headers.

" } }, "tokenSigningPublicKeys": { "target": "com.amazonaws.iot#PublicKeyMap", "traits": { "smithy.api#documentation": "

The public keys used to validate the token signature returned by your custom\n authentication service.

" } }, "status": { "target": "com.amazonaws.iot#AuthorizerStatus", "traits": { "smithy.api#documentation": "

The status of the authorizer.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The UNIX timestamp of when the authorizer was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The UNIX timestamp of when the authorizer was last updated.

" } }, "signingDisabled": { "target": "com.amazonaws.iot#BooleanKey", "traits": { "smithy.api#documentation": "

Specifies whether AWS IoT validates the token signature in an authorization request.

" } } }, "traits": { "smithy.api#documentation": "

The authorizer description.

" } }, "com.amazonaws.iot#AuthorizerFunctionArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.iot#AuthorizerName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[\\w=,@-]+" } }, "com.amazonaws.iot#AuthorizerStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "INACTIVE", "name": "INACTIVE" } ] } }, "com.amazonaws.iot#AuthorizerSummary": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The authorizer name.

" } }, "authorizerArn": { "target": "com.amazonaws.iot#AuthorizerArn", "traits": { "smithy.api#documentation": "

The authorizer ARN.

" } } }, "traits": { "smithy.api#documentation": "

The authorizer summary.

" } }, "com.amazonaws.iot#Authorizers": { "type": "list", "member": { "target": "com.amazonaws.iot#AuthorizerSummary" } }, "com.amazonaws.iot#AutoRegistrationStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENABLE", "name": "ENABLE" }, { "value": "DISABLE", "name": "DISABLE" } ] } }, "com.amazonaws.iot#Average": { "type": "double" }, "com.amazonaws.iot#AwsAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "[0-9]+" } }, "com.amazonaws.iot#AwsArn": { "type": "string" }, "com.amazonaws.iot#AwsIotJobArn": { "type": "string" }, "com.amazonaws.iot#AwsIotJobId": { "type": "string" }, "com.amazonaws.iot#AwsIotSqlVersion": { "type": "string" }, "com.amazonaws.iot#AwsJobAbortConfig": { "type": "structure", "members": { "abortCriteriaList": { "target": "com.amazonaws.iot#AwsJobAbortCriteriaList", "traits": { "smithy.api#documentation": "

The list of criteria that determine when and how to abort the job.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The criteria that determine when and how a job abort takes place.

" } }, "com.amazonaws.iot#AwsJobAbortCriteria": { "type": "structure", "members": { "failureType": { "target": "com.amazonaws.iot#AwsJobAbortCriteriaFailureType", "traits": { "smithy.api#documentation": "

The type of job execution failures that can initiate a job abort.

", "smithy.api#required": {} } }, "action": { "target": "com.amazonaws.iot#AwsJobAbortCriteriaAbortAction", "traits": { "smithy.api#documentation": "

The type of job action to take to initiate the job abort.

", "smithy.api#required": {} } }, "thresholdPercentage": { "target": "com.amazonaws.iot#AwsJobAbortCriteriaAbortThresholdPercentage", "traits": { "smithy.api#documentation": "

The minimum percentage of job execution failures that must occur to initiate the job abort.

\n

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

", "smithy.api#required": {} } }, "minNumberOfExecutedThings": { "target": "com.amazonaws.iot#AwsJobAbortCriteriaMinimumNumberOfExecutedThings", "traits": { "smithy.api#documentation": "

The minimum number of things which must receive job execution notifications before the job \n can be aborted.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The criteria that determine when and how a job abort takes place.

" } }, "com.amazonaws.iot#AwsJobAbortCriteriaAbortAction": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CANCEL", "name": "CANCEL" } ] } }, "com.amazonaws.iot#AwsJobAbortCriteriaAbortThresholdPercentage": { "type": "double", "traits": { "smithy.api#box": {}, "smithy.api#range": { "max": 100 } } }, "com.amazonaws.iot#AwsJobAbortCriteriaFailureType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "FAILED", "name": "FAILED" }, { "value": "REJECTED", "name": "REJECTED" }, { "value": "TIMED_OUT", "name": "TIMED_OUT" }, { "value": "ALL", "name": "ALL" } ] } }, "com.amazonaws.iot#AwsJobAbortCriteriaList": { "type": "list", "member": { "target": "com.amazonaws.iot#AwsJobAbortCriteria" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#AwsJobAbortCriteriaMinimumNumberOfExecutedThings": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.iot#AwsJobExecutionsRolloutConfig": { "type": "structure", "members": { "maximumPerMinute": { "target": "com.amazonaws.iot#MaximumPerMinute", "traits": { "smithy.api#documentation": "

The maximum number of OTA update job executions started per minute.

" } }, "exponentialRate": { "target": "com.amazonaws.iot#AwsJobExponentialRolloutRate", "traits": { "smithy.api#documentation": "

The rate of increase for a job rollout. This parameter allows you to define an exponential rate \n increase for a job rollout.

" } } }, "traits": { "smithy.api#documentation": "

Configuration for the rollout of OTA updates.

" } }, "com.amazonaws.iot#AwsJobExponentialRolloutRate": { "type": "structure", "members": { "baseRatePerMinute": { "target": "com.amazonaws.iot#AwsJobRolloutRatePerMinute", "traits": { "smithy.api#documentation": "

The minimum number of things that will be notified of a pending job, per minute, at the start \n of the job rollout. This is the initial rate of the rollout.

", "smithy.api#required": {} } }, "incrementFactor": { "target": "com.amazonaws.iot#AwsJobRolloutIncrementFactor", "traits": { "smithy.api#documentation": "

The rate of increase for a job rollout. The number of things notified is multiplied by this \n factor.

", "smithy.api#required": {} } }, "rateIncreaseCriteria": { "target": "com.amazonaws.iot#AwsJobRateIncreaseCriteria", "traits": { "smithy.api#documentation": "

The criteria to initiate the increase in rate of rollout for a job.

\n

AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The rate of increase for a job rollout. This parameter allows you to define an exponential rate \n increase for a job rollout.

" } }, "com.amazonaws.iot#AwsJobPresignedUrlConfig": { "type": "structure", "members": { "expiresInSec": { "target": "com.amazonaws.iot#ExpiresInSeconds", "traits": { "smithy.api#documentation": "

How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800\n seconds. Pre-signed URLs are generated when a request for the job document is received.

" } } }, "traits": { "smithy.api#documentation": "

Configuration information for pre-signed URLs. Valid when protocols\n contains HTTP.

" } }, "com.amazonaws.iot#AwsJobRateIncreaseCriteria": { "type": "structure", "members": { "numberOfNotifiedThings": { "target": "com.amazonaws.iot#AwsJobRateIncreaseCriteriaNumberOfThings", "traits": { "smithy.api#documentation": "

When this number of things have been notified, it will initiate an increase in the rollout\n rate.

" } }, "numberOfSucceededThings": { "target": "com.amazonaws.iot#AwsJobRateIncreaseCriteriaNumberOfThings", "traits": { "smithy.api#documentation": "

When this number of things have succeeded in their job execution, it will initiate an \n increase in the rollout rate.

" } } }, "traits": { "smithy.api#documentation": "

The criteria to initiate the increase in rate of rollout for a job.

" } }, "com.amazonaws.iot#AwsJobRateIncreaseCriteriaNumberOfThings": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.iot#AwsJobRolloutIncrementFactor": { "type": "double" }, "com.amazonaws.iot#AwsJobRolloutRatePerMinute": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.iot#AwsJobTimeoutConfig": { "type": "structure", "members": { "inProgressTimeoutInMinutes": { "target": "com.amazonaws.iot#AwsJobTimeoutInProgressTimeoutInMinutes", "traits": { "smithy.api#documentation": "

Specifies the amount of time, in minutes, this device has to finish execution of this job. The \n timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress \n timer can't be updated and will apply to all job executions for the job. Whenever a job execution \n remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and \n switch to the terminal TIMED_OUT status.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. A timer is \n started when the job execution status is set to IN_PROGRESS. If the job execution \n status is not set to another terminal state before the timer expires, it will be automatically \n set to TIMED_OUT.

" } }, "com.amazonaws.iot#AwsJobTimeoutInProgressTimeoutInMinutes": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#BatchMode": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#Behavior": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#BehaviorName", "traits": { "smithy.api#documentation": "

The name\n you've given to the behavior.

", "smithy.api#required": {} } }, "metric": { "target": "com.amazonaws.iot#BehaviorMetric", "traits": { "smithy.api#documentation": "

What is measured by the behavior.

" } }, "metricDimension": { "target": "com.amazonaws.iot#MetricDimension", "traits": { "smithy.api#documentation": "

The dimension for a metric in your behavior. For example, using a\n TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.

" } }, "criteria": { "target": "com.amazonaws.iot#BehaviorCriteria", "traits": { "smithy.api#documentation": "

The criteria that determine if a device is behaving normally in regard to\n the metric.

" } }, "suppressAlerts": { "target": "com.amazonaws.iot#SuppressAlerts", "traits": { "smithy.api#documentation": "

\n Suppresses alerts.\n

" } } }, "traits": { "smithy.api#documentation": "

A Device Defender security profile behavior.

" } }, "com.amazonaws.iot#BehaviorCriteria": { "type": "structure", "members": { "comparisonOperator": { "target": "com.amazonaws.iot#ComparisonOperator", "traits": { "smithy.api#documentation": "

The operator that relates the thing measured (metric) to the criteria \n (containing a value or statisticalThreshold). Valid operators include:

\n " } }, "value": { "target": "com.amazonaws.iot#MetricValue", "traits": { "smithy.api#documentation": "

The value to be compared with the metric.

" } }, "durationSeconds": { "target": "com.amazonaws.iot#DurationSeconds", "traits": { "smithy.api#documentation": "

Use this to specify the time duration over which the behavior is evaluated, for those criteria that\n have a time dimension (for example, NUM_MESSAGES_SENT). For a\n statisticalThreshhold metric comparison, measurements from all devices are\n accumulated over this time duration before being used to calculate percentiles, and later,\n measurements from an individual device are also accumulated over this time duration before\n being given a percentile rank. Cannot be used with list-based metric datatypes.

" } }, "consecutiveDatapointsToAlarm": { "target": "com.amazonaws.iot#ConsecutiveDatapointsToAlarm", "traits": { "smithy.api#documentation": "

If a device is in violation of the behavior for the specified number of consecutive \n datapoints, an alarm occurs. If not specified, the default is 1.

" } }, "consecutiveDatapointsToClear": { "target": "com.amazonaws.iot#ConsecutiveDatapointsToClear", "traits": { "smithy.api#documentation": "

If an alarm has occurred and the offending device is no longer in violation of the behavior \n for the specified number of consecutive datapoints, the alarm is cleared. If not specified,\n the default is 1.

" } }, "statisticalThreshold": { "target": "com.amazonaws.iot#StatisticalThreshold", "traits": { "smithy.api#documentation": "

A statistical ranking (percentile)that\n indicates a threshold value by which a behavior is determined to be in compliance or in\n violation of the behavior.

" } }, "mlDetectionConfig": { "target": "com.amazonaws.iot#MachineLearningDetectionConfig", "traits": { "smithy.api#documentation": "

\n The configuration of an ML Detect \n

" } } }, "traits": { "smithy.api#documentation": "

The criteria by which the behavior is determined to be normal.

" } }, "com.amazonaws.iot#BehaviorCriteriaType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "STATIC", "name": "STATIC" }, { "value": "STATISTICAL", "name": "STATISTICAL" }, { "value": "MACHINE_LEARNING", "name": "MACHINE_LEARNING" } ] } }, "com.amazonaws.iot#BehaviorMetric": { "type": "string" }, "com.amazonaws.iot#BehaviorModelTrainingSummaries": { "type": "list", "member": { "target": "com.amazonaws.iot#BehaviorModelTrainingSummary" } }, "com.amazonaws.iot#BehaviorModelTrainingSummary": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

\n The name of the security profile.\n

" } }, "behaviorName": { "target": "com.amazonaws.iot#BehaviorName", "traits": { "smithy.api#documentation": "

\n The name of the behavior.\n

" } }, "trainingDataCollectionStartDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The date a training model started collecting data.\n

" } }, "modelStatus": { "target": "com.amazonaws.iot#ModelStatus", "traits": { "smithy.api#documentation": "

\n The status of the behavior model.\n

" } }, "datapointsCollectionPercentage": { "target": "com.amazonaws.iot#DataCollectionPercentage", "traits": { "smithy.api#documentation": "

\n The percentage of datapoints collected.\n

" } }, "lastModelRefreshDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The date the model was last refreshed.\n

" } } }, "traits": { "smithy.api#documentation": "

\n The summary of an ML Detect behavior model.\n

" } }, "com.amazonaws.iot#BehaviorName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#Behaviors": { "type": "list", "member": { "target": "com.amazonaws.iot#Behavior" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.iot#BillingGroupArn": { "type": "string" }, "com.amazonaws.iot#BillingGroupDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2028 }, "smithy.api#pattern": "[\\p{Graph}\\x20]*" } }, "com.amazonaws.iot#BillingGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9\\-]+" } }, "com.amazonaws.iot#BillingGroupMetadata": { "type": "structure", "members": { "creationDate": { "target": "com.amazonaws.iot#CreationDate", "traits": { "smithy.api#documentation": "

The date the billing group was created.

" } } }, "traits": { "smithy.api#documentation": "

Additional information about the billing group.

" } }, "com.amazonaws.iot#BillingGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#BillingGroupNameAndArnList": { "type": "list", "member": { "target": "com.amazonaws.iot#GroupNameAndArn" } }, "com.amazonaws.iot#BillingGroupProperties": { "type": "structure", "members": { "billingGroupDescription": { "target": "com.amazonaws.iot#BillingGroupDescription", "traits": { "smithy.api#documentation": "

The description of the billing group.

" } } }, "traits": { "smithy.api#documentation": "

The properties of a billing group.

" } }, "com.amazonaws.iot#Boolean": { "type": "boolean" }, "com.amazonaws.iot#BooleanKey": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#BucketName": { "type": "string" }, "com.amazonaws.iot#CACertificate": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The ARN of the CA certificate.

" } }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the CA certificate.

" } }, "status": { "target": "com.amazonaws.iot#CACertificateStatus", "traits": { "smithy.api#documentation": "

The status of the CA certificate.

\n

The status value REGISTER_INACTIVE is deprecated and should not be used.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the CA certificate was created.

" } } }, "traits": { "smithy.api#documentation": "

A CA certificate.

" } }, "com.amazonaws.iot#CACertificateDescription": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The CA certificate ARN.

" } }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The CA certificate ID.

" } }, "status": { "target": "com.amazonaws.iot#CACertificateStatus", "traits": { "smithy.api#documentation": "

The status of a CA certificate.

" } }, "certificatePem": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The CA certificate data, in PEM format.

" } }, "ownedBy": { "target": "com.amazonaws.iot#AwsAccountId", "traits": { "smithy.api#documentation": "

The owner of the CA certificate.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the CA certificate was created.

" } }, "autoRegistrationStatus": { "target": "com.amazonaws.iot#AutoRegistrationStatus", "traits": { "smithy.api#documentation": "

Whether the CA certificate configured for auto registration of device certificates.\n Valid values are \"ENABLE\" and \"DISABLE\"

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the CA certificate was last modified.

" } }, "customerVersion": { "target": "com.amazonaws.iot#CustomerVersion", "traits": { "smithy.api#documentation": "

The customer version of the CA certificate.

" } }, "generationId": { "target": "com.amazonaws.iot#GenerationId", "traits": { "smithy.api#documentation": "

The generation ID of the CA certificate.

" } }, "validity": { "target": "com.amazonaws.iot#CertificateValidity", "traits": { "smithy.api#documentation": "

When the CA certificate is valid.

" } } }, "traits": { "smithy.api#documentation": "

Describes a CA certificate.

" } }, "com.amazonaws.iot#CACertificateStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "INACTIVE", "name": "INACTIVE" } ] } }, "com.amazonaws.iot#CACertificateUpdateAction": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DEACTIVATE", "name": "DEACTIVATE" } ] } }, "com.amazonaws.iot#CACertificates": { "type": "list", "member": { "target": "com.amazonaws.iot#CACertificate" } }, "com.amazonaws.iot#CancelAuditMitigationActionsTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#CancelAuditMitigationActionsTaskRequest" }, "output": { "target": "com.amazonaws.iot#CancelAuditMitigationActionsTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Cancels a mitigation action task that is in progress. If the task\n is not\n in progress, an InvalidRequestException occurs.

", "smithy.api#http": { "method": "PUT", "uri": "/audit/mitigationactions/tasks/{taskId}/cancel", "code": 200 } } }, "com.amazonaws.iot#CancelAuditMitigationActionsTaskRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

The unique identifier for the task that you want to cancel.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#CancelAuditMitigationActionsTaskResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#CancelAuditTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#CancelAuditTaskRequest" }, "output": { "target": "com.amazonaws.iot#CancelAuditTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an \"InvalidRequestException\" occurs.

", "smithy.api#http": { "method": "PUT", "uri": "/audit/tasks/{taskId}/cancel", "code": 200 } } }, "com.amazonaws.iot#CancelAuditTaskRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { "smithy.api#documentation": "

The ID of the audit you want to cancel. You can only cancel an\n audit that is \"IN_PROGRESS\".

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#CancelAuditTaskResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#CancelCertificateTransfer": { "type": "operation", "input": { "target": "com.amazonaws.iot#CancelCertificateTransferRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#TransferAlreadyCompletedException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Cancels a pending transfer for the specified certificate.

\n

\n Note Only the transfer source account can use this\n operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the\n certificate to the source account in the INACTIVE state. After the destination account has\n accepted the transfer, the transfer cannot be cancelled.

\n

After a certificate transfer is cancelled, the status of the certificate changes from\n PENDING_TRANSFER to INACTIVE.

", "smithy.api#http": { "method": "PATCH", "uri": "/cancel-certificate-transfer/{certificateId}", "code": 200 } } }, "com.amazonaws.iot#CancelCertificateTransferRequest": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the CancelCertificateTransfer operation.

" } }, "com.amazonaws.iot#CancelDetectMitigationActionsTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#CancelDetectMitigationActionsTaskRequest" }, "output": { "target": "com.amazonaws.iot#CancelDetectMitigationActionsTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Cancels a Device Defender ML Detect mitigation action.\n

", "smithy.api#http": { "method": "PUT", "uri": "/detect/mitigationactions/tasks/{taskId}/cancel", "code": 200 } } }, "com.amazonaws.iot#CancelDetectMitigationActionsTaskRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

\n The unique identifier of the task.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#CancelDetectMitigationActionsTaskResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#CancelJob": { "type": "operation", "input": { "target": "com.amazonaws.iot#CancelJobRequest" }, "output": { "target": "com.amazonaws.iot#CancelJobResponse" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Cancels a job.

", "smithy.api#http": { "method": "PUT", "uri": "/jobs/{jobId}/cancel", "code": 200 } } }, "com.amazonaws.iot#CancelJobExecution": { "type": "operation", "input": { "target": "com.amazonaws.iot#CancelJobExecutionRequest" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#InvalidStateTransitionException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Cancels the execution of a job for a given thing.

", "smithy.api#http": { "method": "PUT", "uri": "/things/{thingName}/jobs/{jobId}/cancel", "code": 200 } } }, "com.amazonaws.iot#CancelJobExecutionRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The ID of the job to be canceled.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing whose execution of the job will be canceled.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "force": { "target": "com.amazonaws.iot#ForceFlag", "traits": { "smithy.api#documentation": "

(Optional) If true the job execution will be canceled if it has status \n IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status \n QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set \n force to true, then an InvalidStateTransitionException \n will be thrown. The default is false.

\n

Canceling a job execution which is \"IN_PROGRESS\", will cause the device to be unable \n to update the job execution status. Use caution and ensure that the device is able to \n recover to a valid state.

", "smithy.api#httpQuery": "force" } }, "expectedVersion": { "target": "com.amazonaws.iot#ExpectedVersion", "traits": { "smithy.api#documentation": "

(Optional) The expected current version of the job execution. Each time you update the job \n execution, its version is incremented. If the version of the job execution stored in Jobs does \n not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that \n contains the current job execution status data is returned. (This makes it unnecessary to \n perform a separate DescribeJobExecution request in order to obtain the job execution status \n data.)

" } }, "statusDetails": { "target": "com.amazonaws.iot#DetailsMap", "traits": { "smithy.api#documentation": "

A collection of name/value pairs that describe the status of the job execution. If not \n specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

" } } } }, "com.amazonaws.iot#CancelJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "reasonCode": { "target": "com.amazonaws.iot#ReasonCode", "traits": { "smithy.api#documentation": "

(Optional)A reason code string that explains why the job was canceled.

" } }, "comment": { "target": "com.amazonaws.iot#Comment", "traits": { "smithy.api#documentation": "

An optional comment string describing why the job was canceled.

" } }, "force": { "target": "com.amazonaws.iot#ForceFlag", "traits": { "smithy.api#documentation": "

(Optional) If true job executions with status \"IN_PROGRESS\" and \"QUEUED\" \n are canceled, otherwise only job executions with status \"QUEUED\" are canceled. The default \n is false.

\n

Canceling a job which is \"IN_PROGRESS\", will cause a device which is executing \n the job to be unable to update the job execution status. Use caution and ensure that each \n device executing a job which is canceled is able to recover to a valid state.

", "smithy.api#httpQuery": "force" } } } }, "com.amazonaws.iot#CancelJobResponse": { "type": "structure", "members": { "jobArn": { "target": "com.amazonaws.iot#JobArn", "traits": { "smithy.api#documentation": "

The job ARN.

" } }, "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" } }, "description": { "target": "com.amazonaws.iot#JobDescription", "traits": { "smithy.api#documentation": "

A short text description of the job.

" } } } }, "com.amazonaws.iot#CanceledChecksCount": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#CanceledFindingsCount": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#CanceledThings": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#CannedAccessControlList": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "private", "name": "Private" }, { "value": "public-read", "name": "PublicRead" }, { "value": "public-read-write", "name": "PublicReadWrite" }, { "value": "aws-exec-read", "name": "AwsExecRead" }, { "value": "authenticated-read", "name": "AuthenticatedRead" }, { "value": "bucket-owner-read", "name": "BucketOwnerRead" }, { "value": "bucket-owner-full-control", "name": "BucketOwnerFullControl" }, { "value": "log-delivery-write", "name": "LogDeliveryWrite" } ] } }, "com.amazonaws.iot#Certificate": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The ARN of the certificate.

" } }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

" } }, "status": { "target": "com.amazonaws.iot#CertificateStatus", "traits": { "smithy.api#documentation": "

The status of the certificate.

\n

The status value REGISTER_INACTIVE is deprecated and should not be used.

" } }, "certificateMode": { "target": "com.amazonaws.iot#CertificateMode", "traits": { "smithy.api#documentation": "

The mode of the certificate.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date and time the certificate was created.

" } } }, "traits": { "smithy.api#documentation": "

Information about a certificate.

" } }, "com.amazonaws.iot#CertificateArn": { "type": "string" }, "com.amazonaws.iot#CertificateConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

Unable to verify the CA certificate used to sign the device certificate you are\n attempting to register. This is happens when you have registered more than one CA\n certificate that has the same subject field and public key.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iot#CertificateDescription": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The ARN of the certificate.

" } }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate.

" } }, "caCertificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The certificate ID of the CA certificate used to sign this certificate.

" } }, "status": { "target": "com.amazonaws.iot#CertificateStatus", "traits": { "smithy.api#documentation": "

The status of the certificate.

" } }, "certificatePem": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The certificate data, in PEM format.

" } }, "ownedBy": { "target": "com.amazonaws.iot#AwsAccountId", "traits": { "smithy.api#documentation": "

The ID of the AWS account that owns the certificate.

" } }, "previousOwnedBy": { "target": "com.amazonaws.iot#AwsAccountId", "traits": { "smithy.api#documentation": "

The ID of the AWS account of the previous owner of the certificate.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date and time the certificate was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date and time the certificate was last modified.

" } }, "customerVersion": { "target": "com.amazonaws.iot#CustomerVersion", "traits": { "smithy.api#documentation": "

The customer version of the certificate.

" } }, "transferData": { "target": "com.amazonaws.iot#TransferData", "traits": { "smithy.api#documentation": "

The transfer data.

" } }, "generationId": { "target": "com.amazonaws.iot#GenerationId", "traits": { "smithy.api#documentation": "

The generation ID of the certificate.

" } }, "validity": { "target": "com.amazonaws.iot#CertificateValidity", "traits": { "smithy.api#documentation": "

When the certificate is valid.

" } }, "certificateMode": { "target": "com.amazonaws.iot#CertificateMode", "traits": { "smithy.api#documentation": "

The mode of the certificate.

" } } }, "traits": { "smithy.api#documentation": "

Describes a certificate.

" } }, "com.amazonaws.iot#CertificateId": { "type": "string", "traits": { "smithy.api#length": { "min": 64, "max": 64 }, "smithy.api#pattern": "(0x)?[a-fA-F0-9]+" } }, "com.amazonaws.iot#CertificateMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DEFAULT", "name": "DEFAULT" }, { "value": "SNI_ONLY", "name": "SNI_ONLY" } ] } }, "com.amazonaws.iot#CertificateName": { "type": "string" }, "com.amazonaws.iot#CertificatePathOnDevice": { "type": "string" }, "com.amazonaws.iot#CertificatePem": { "type": "string", "traits": { "smithy.api#documentation": "

The PEM of a certificate.

", "smithy.api#length": { "min": 1, "max": 65536 } } }, "com.amazonaws.iot#CertificateSigningRequest": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#CertificateStateException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The certificate operation is not allowed.

", "smithy.api#error": "client", "smithy.api#httpError": 406 } }, "com.amazonaws.iot#CertificateStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "INACTIVE", "name": "INACTIVE" }, { "value": "REVOKED", "name": "REVOKED" }, { "value": "PENDING_TRANSFER", "name": "PENDING_TRANSFER" }, { "value": "REGISTER_INACTIVE", "name": "REGISTER_INACTIVE" }, { "value": "PENDING_ACTIVATION", "name": "PENDING_ACTIVATION" } ] } }, "com.amazonaws.iot#CertificateValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

Additional information about the exception.

" } } }, "traits": { "smithy.api#documentation": "

The certificate is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#CertificateValidity": { "type": "structure", "members": { "notBefore": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The certificate is not valid before this date.

" } }, "notAfter": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The certificate is not valid after this date.

" } } }, "traits": { "smithy.api#documentation": "

When the certificate is valid.

" } }, "com.amazonaws.iot#Certificates": { "type": "list", "member": { "target": "com.amazonaws.iot#Certificate" } }, "com.amazonaws.iot#ChannelName": { "type": "string" }, "com.amazonaws.iot#CheckCompliant": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#Cidr": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 43 }, "smithy.api#pattern": "[a-fA-F0-9:\\.\\/]+" } }, "com.amazonaws.iot#Cidrs": { "type": "list", "member": { "target": "com.amazonaws.iot#Cidr" } }, "com.amazonaws.iot#ClearDefaultAuthorizer": { "type": "operation", "input": { "target": "com.amazonaws.iot#ClearDefaultAuthorizerRequest" }, "output": { "target": "com.amazonaws.iot#ClearDefaultAuthorizerResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Clears the default authorizer.

", "smithy.api#http": { "method": "DELETE", "uri": "/default-authorizer", "code": 200 } } }, "com.amazonaws.iot#ClearDefaultAuthorizerRequest": { "type": "structure", "members": {} }, "com.amazonaws.iot#ClearDefaultAuthorizerResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#ClientId": { "type": "string" }, "com.amazonaws.iot#ClientProperties": { "type": "map", "key": { "target": "com.amazonaws.iot#String" }, "value": { "target": "com.amazonaws.iot#String" } }, "com.amazonaws.iot#ClientRequestToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" } }, "com.amazonaws.iot#CloudwatchAlarmAction": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The IAM role that allows access to the CloudWatch alarm.

", "smithy.api#required": {} } }, "alarmName": { "target": "com.amazonaws.iot#AlarmName", "traits": { "smithy.api#documentation": "

The CloudWatch alarm name.

", "smithy.api#required": {} } }, "stateReason": { "target": "com.amazonaws.iot#StateReason", "traits": { "smithy.api#documentation": "

The reason for the alarm change.

", "smithy.api#required": {} } }, "stateValue": { "target": "com.amazonaws.iot#StateValue", "traits": { "smithy.api#documentation": "

The value of the alarm state. Acceptable values are: OK, ALARM,\n INSUFFICIENT_DATA.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an action that updates a CloudWatch alarm.

" } }, "com.amazonaws.iot#CloudwatchLogsAction": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The IAM role that allows access to the CloudWatch log.

", "smithy.api#required": {} } }, "logGroupName": { "target": "com.amazonaws.iot#LogGroupName", "traits": { "smithy.api#documentation": "

The CloudWatch log group to which the action sends data.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an action that sends data to CloudWatch Logs.

" } }, "com.amazonaws.iot#CloudwatchMetricAction": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The IAM role that allows access to the CloudWatch metric.

", "smithy.api#required": {} } }, "metricNamespace": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

The CloudWatch metric namespace name.

", "smithy.api#required": {} } }, "metricName": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

The CloudWatch metric name.

", "smithy.api#required": {} } }, "metricValue": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

The CloudWatch metric value.

", "smithy.api#required": {} } }, "metricUnit": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

The metric\n unit supported by CloudWatch.

", "smithy.api#required": {} } }, "metricTimestamp": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

An optional Unix timestamp.

" } } }, "traits": { "smithy.api#documentation": "

Describes an action that captures a CloudWatch metric.

" } }, "com.amazonaws.iot#Code": { "type": "string" }, "com.amazonaws.iot#CodeSigning": { "type": "structure", "members": { "awsSignerJobId": { "target": "com.amazonaws.iot#SigningJobId", "traits": { "smithy.api#documentation": "

The ID of the AWSSignerJob which was created to sign the file.

" } }, "startSigningJobParameter": { "target": "com.amazonaws.iot#StartSigningJobParameter", "traits": { "smithy.api#documentation": "

Describes the code-signing job.

" } }, "customCodeSigning": { "target": "com.amazonaws.iot#CustomCodeSigning", "traits": { "smithy.api#documentation": "

A custom method for code signing a file.

" } } }, "traits": { "smithy.api#documentation": "

Describes the method to use when code signing a file.

" } }, "com.amazonaws.iot#CodeSigningCertificateChain": { "type": "structure", "members": { "certificateName": { "target": "com.amazonaws.iot#CertificateName", "traits": { "smithy.api#documentation": "

The name of the certificate.

" } }, "inlineDocument": { "target": "com.amazonaws.iot#InlineDocument", "traits": { "smithy.api#documentation": "

A base64 encoded binary representation of the code signing certificate chain.

" } } }, "traits": { "smithy.api#documentation": "

Describes the certificate chain being used when code signing a file.

" } }, "com.amazonaws.iot#CodeSigningSignature": { "type": "structure", "members": { "inlineDocument": { "target": "com.amazonaws.iot#Signature", "traits": { "smithy.api#documentation": "

A base64 encoded binary representation of the code signing signature.

" } } }, "traits": { "smithy.api#documentation": "

Describes the signature for a file.

" } }, "com.amazonaws.iot#CognitoIdentityPoolId": { "type": "string" }, "com.amazonaws.iot#Comment": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2028 }, "smithy.api#pattern": "[^\\p{C}]+" } }, "com.amazonaws.iot#ComparisonOperator": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "less-than", "name": "LESS_THAN" }, { "value": "less-than-equals", "name": "LESS_THAN_EQUALS" }, { "value": "greater-than", "name": "GREATER_THAN" }, { "value": "greater-than-equals", "name": "GREATER_THAN_EQUALS" }, { "value": "in-cidr-set", "name": "IN_CIDR_SET" }, { "value": "not-in-cidr-set", "name": "NOT_IN_CIDR_SET" }, { "value": "in-port-set", "name": "IN_PORT_SET" }, { "value": "not-in-port-set", "name": "NOT_IN_PORT_SET" }, { "value": "in-set", "name": "IN_SET" }, { "value": "not-in-set", "name": "NOT_IN_SET" } ] } }, "com.amazonaws.iot#CompliantChecksCount": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#ConfidenceLevel": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "LOW", "name": "LOW" }, { "value": "MEDIUM", "name": "MEDIUM" }, { "value": "HIGH", "name": "HIGH" } ] } }, "com.amazonaws.iot#Configuration": { "type": "structure", "members": { "Enabled": { "target": "com.amazonaws.iot#Enabled", "traits": { "smithy.api#documentation": "

True to enable the configuration.

" } } }, "traits": { "smithy.api#documentation": "

Configuration.

" } }, "com.amazonaws.iot#ConfirmTopicRuleDestination": { "type": "operation", "input": { "target": "com.amazonaws.iot#ConfirmTopicRuleDestinationRequest" }, "output": { "target": "com.amazonaws.iot#ConfirmTopicRuleDestinationResponse" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Confirms a topic rule destination. When you create a rule requiring a destination, AWS\n IoT sends a confirmation message to the endpoint or base address you specify. The message\n includes a token which you pass back when calling ConfirmTopicRuleDestination\n to confirm that you own or have access to the endpoint.

", "smithy.api#http": { "method": "GET", "uri": "/confirmdestination/{confirmationToken+}", "code": 200 } } }, "com.amazonaws.iot#ConfirmTopicRuleDestinationRequest": { "type": "structure", "members": { "confirmationToken": { "target": "com.amazonaws.iot#ConfirmationToken", "traits": { "smithy.api#documentation": "

The token used to confirm ownership or access to the topic rule confirmation URL.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#ConfirmTopicRuleDestinationResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#ConfirmationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.iot#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2" } }, "traits": { "smithy.api#documentation": "

A resource with the same name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iot#ConflictingResourceUpdateException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

A conflicting resource update exception. This exception is thrown when two pending\n updates cause a conflict.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iot#ConnectivityTimestamp": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#ConsecutiveDatapointsToAlarm": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.iot#ConsecutiveDatapointsToClear": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.iot#Count": { "type": "integer" }, "com.amazonaws.iot#CreateAuditSuppression": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateAuditSuppressionRequest" }, "output": { "target": "com.amazonaws.iot#CreateAuditSuppressionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Creates a Device Defender audit suppression.\n

", "smithy.api#http": { "method": "POST", "uri": "/audit/suppressions/create", "code": 200 } } }, "com.amazonaws.iot#CreateAuditSuppressionRequest": { "type": "structure", "members": { "checkName": { "target": "com.amazonaws.iot#AuditCheckName", "traits": { "smithy.api#required": {} } }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier", "traits": { "smithy.api#required": {} } }, "expirationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The epoch timestamp in seconds at which this suppression expires.\n

" } }, "suppressIndefinitely": { "target": "com.amazonaws.iot#SuppressIndefinitely", "traits": { "smithy.api#documentation": "

\n Indicates whether a suppression should exist indefinitely or not.\n

" } }, "description": { "target": "com.amazonaws.iot#AuditDescription", "traits": { "smithy.api#documentation": "

\n The description of the audit suppression.\n

" } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { "smithy.api#documentation": "

\n The epoch timestamp in seconds at which this suppression expires.\n

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#CreateAuditSuppressionResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#CreateAuthorizer": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateAuthorizerRequest" }, "output": { "target": "com.amazonaws.iot#CreateAuthorizerResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates an authorizer.

", "smithy.api#http": { "method": "POST", "uri": "/authorizer/{authorizerName}", "code": 200 } } }, "com.amazonaws.iot#CreateAuthorizerRequest": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The authorizer name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "authorizerFunctionArn": { "target": "com.amazonaws.iot#AuthorizerFunctionArn", "traits": { "smithy.api#documentation": "

The ARN of the authorizer's Lambda function.

", "smithy.api#required": {} } }, "tokenKeyName": { "target": "com.amazonaws.iot#TokenKeyName", "traits": { "smithy.api#documentation": "

The name of the token key used to extract the token from the HTTP headers.

" } }, "tokenSigningPublicKeys": { "target": "com.amazonaws.iot#PublicKeyMap", "traits": { "smithy.api#documentation": "

The public keys used to verify the digital signature returned by your custom\n authentication service.

" } }, "status": { "target": "com.amazonaws.iot#AuthorizerStatus", "traits": { "smithy.api#documentation": "

The status of the create authorizer request.

" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the custom authorizer.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n
" } }, "signingDisabled": { "target": "com.amazonaws.iot#BooleanKey", "traits": { "smithy.api#documentation": "

Specifies whether AWS IoT validates the token signature in an authorization request.

" } } } }, "com.amazonaws.iot#CreateAuthorizerResponse": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The authorizer's name.

" } }, "authorizerArn": { "target": "com.amazonaws.iot#AuthorizerArn", "traits": { "smithy.api#documentation": "

The authorizer ARN.

" } } } }, "com.amazonaws.iot#CreateBillingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateBillingGroupRequest" }, "output": { "target": "com.amazonaws.iot#CreateBillingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Creates a billing group.

", "smithy.api#http": { "method": "POST", "uri": "/billing-groups/{billingGroupName}", "code": 200 } } }, "com.amazonaws.iot#CreateBillingGroupRequest": { "type": "structure", "members": { "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name you wish to give to the billing group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "billingGroupProperties": { "target": "com.amazonaws.iot#BillingGroupProperties", "traits": { "smithy.api#documentation": "

The properties of the billing group.

" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the billing group.

" } } } }, "com.amazonaws.iot#CreateBillingGroupResponse": { "type": "structure", "members": { "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name you gave to the billing group.

" } }, "billingGroupArn": { "target": "com.amazonaws.iot#BillingGroupArn", "traits": { "smithy.api#documentation": "

The ARN of the billing group.

" } }, "billingGroupId": { "target": "com.amazonaws.iot#BillingGroupId", "traits": { "smithy.api#documentation": "

The ID of the billing group.

" } } } }, "com.amazonaws.iot#CreateCertificateFromCsr": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateCertificateFromCsrRequest" }, "output": { "target": "com.amazonaws.iot#CreateCertificateFromCsrResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates an X.509 certificate using the specified certificate signing\n request.

\n

\n Note: The CSR must include a public key that is either an\n RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384\n curves.

\n

\n Note: Reusing the same certificate signing request (CSR)\n results in a distinct certificate.

\n

You can create multiple certificates in a batch by creating a directory, copying\n multiple .csr files into that directory, and then specifying that directory on the command\n line. The following commands show how to create a batch of certificates given a batch of\n CSRs.

\n

Assuming a set of CSRs are located inside of the directory\n my-csr-directory:

\n\n

On Linux and OS X, the command is:

\n\n

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}

\n

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name\n to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the\n corresponding CSR.

\n

The aws iot create-certificate-from-csr part of the command can also be run in\n parallel to speed up the certificate creation process:

\n

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}

\n

On Windows PowerShell, the command to create certificates for all CSRs in\n my-csr-directory is:

\n

> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/$_}

\n

On a Windows command prompt, the command to create certificates for all CSRs in\n my-csr-directory is:

\n

> forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr\n --certificate-signing-request file://@path\"

", "smithy.api#http": { "method": "POST", "uri": "/certificates", "code": 200 } } }, "com.amazonaws.iot#CreateCertificateFromCsrRequest": { "type": "structure", "members": { "certificateSigningRequest": { "target": "com.amazonaws.iot#CertificateSigningRequest", "traits": { "smithy.api#documentation": "

The certificate signing request (CSR).

", "smithy.api#required": {} } }, "setAsActive": { "target": "com.amazonaws.iot#SetAsActive", "traits": { "smithy.api#documentation": "

Specifies whether the certificate is active.

", "smithy.api#httpQuery": "setAsActive" } } }, "traits": { "smithy.api#documentation": "

The input for the CreateCertificateFromCsr operation.

" } }, "com.amazonaws.iot#CreateCertificateFromCsrResponse": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal\n for policy operations.

" } }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate. Certificate management operations only take a\n certificateId.

" } }, "certificatePem": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The certificate data, in PEM format.

" } } }, "traits": { "smithy.api#documentation": "

The output from the CreateCertificateFromCsr operation.

" } }, "com.amazonaws.iot#CreateCustomMetric": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateCustomMetricRequest" }, "output": { "target": "com.amazonaws.iot#CreateCustomMetricResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Use this API to define a\n Custom\n Metric\n published by your devices to Device Defender.

", "smithy.api#http": { "method": "POST", "uri": "/custom-metric/{metricName}", "code": 200 } } }, "com.amazonaws.iot#CreateCustomMetricRequest": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { "smithy.api#documentation": "

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:.\n Cannot be updated\n once defined.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { "smithy.api#documentation": "

\n Field\n represents a friendly name in the console for the custom metric;\n it\n doesn't have to be unique. Don't use this name as the metric identifier in\n the device metric report. Can be updated once defined.

" } }, "metricType": { "target": "com.amazonaws.iot#CustomMetricType", "traits": { "smithy.api#documentation": "

\n The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.\n

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

\n Metadata that can be used to manage the custom metric.\n

" } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { "smithy.api#documentation": "

Each custom\n metric must have a unique client request token. If you try to create a new custom metric that\n already exists with a different token,\n an exception\n occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#CreateCustomMetricResponse": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { "smithy.api#documentation": "

\n The name of the custom metric to be used in the metric report.\n

" } }, "metricArn": { "target": "com.amazonaws.iot#CustomMetricArn", "traits": { "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the custom metric, e.g. arn:aws-partition:iot:region:accountId:custommetric/metricName\n \n

" } } } }, "com.amazonaws.iot#CreateDimension": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateDimensionRequest" }, "output": { "target": "com.amazonaws.iot#CreateDimensionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Create a dimension that you can use to limit the scope of a metric used in a security profile for AWS IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

", "smithy.api#http": { "method": "POST", "uri": "/dimensions/{name}", "code": 200 } } }, "com.amazonaws.iot#CreateDimensionRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.iot#DimensionType", "traits": { "smithy.api#documentation": "

Specifies the type of dimension. Supported types: TOPIC_FILTER.\n

", "smithy.api#required": {} } }, "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata that can be used to manage the dimension.

" } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { "smithy.api#documentation": "

Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#CreateDimensionResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { "smithy.api#documentation": "

A unique identifier for the dimension.

" } }, "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name\n (ARN)\n of\n the created dimension.

" } } } }, "com.amazonaws.iot#CreateDomainConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateDomainConfigurationRequest" }, "output": { "target": "com.amazonaws.iot#CreateDomainConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.iot#CertificateValidationException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a domain configuration.

", "smithy.api#http": { "method": "POST", "uri": "/domainConfigurations/{domainConfigurationName}", "code": 200 } } }, "com.amazonaws.iot#CreateDomainConfigurationRequest": { "type": "structure", "members": { "domainConfigurationName": { "target": "com.amazonaws.iot#DomainConfigurationName", "traits": { "smithy.api#documentation": "

The name of the domain configuration. This value must be unique to a region.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.iot#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

" } }, "serverCertificateArns": { "target": "com.amazonaws.iot#ServerCertificateArns", "traits": { "smithy.api#documentation": "

The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. \n This value is not required for AWS-managed domains.

" } }, "validationCertificateArn": { "target": "com.amazonaws.iot#AcmCertificateArn", "traits": { "smithy.api#documentation": "

The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. \n This value is not required for AWS-managed domains.

" } }, "authorizerConfig": { "target": "com.amazonaws.iot#AuthorizerConfig", "traits": { "smithy.api#documentation": "

An object that specifies the authorization service for a domain.

" } }, "serviceType": { "target": "com.amazonaws.iot#ServiceType", "traits": { "smithy.api#documentation": "

The type of service delivered by the endpoint.

\n \n

AWS IoT Core currently supports only the DATA service type.

\n
" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the domain configuration.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n
" } } } }, "com.amazonaws.iot#CreateDomainConfigurationResponse": { "type": "structure", "members": { "domainConfigurationName": { "target": "com.amazonaws.iot#DomainConfigurationName", "traits": { "smithy.api#documentation": "

The name of the domain configuration.

" } }, "domainConfigurationArn": { "target": "com.amazonaws.iot#DomainConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of the domain configuration.

" } } } }, "com.amazonaws.iot#CreateDynamicThingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateDynamicThingGroupRequest" }, "output": { "target": "com.amazonaws.iot#CreateDynamicThingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidQueryException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Creates a dynamic thing group.

", "smithy.api#http": { "method": "POST", "uri": "/dynamic-thing-groups/{thingGroupName}", "code": 200 } } }, "com.amazonaws.iot#CreateDynamicThingGroupRequest": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The dynamic thing group name to create.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "thingGroupProperties": { "target": "com.amazonaws.iot#ThingGroupProperties", "traits": { "smithy.api#documentation": "

The dynamic thing group properties.

" } }, "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The dynamic thing group index name.

\n\t\t \n\t\t\t

Currently one index is supported: \"AWS_Things\".

\n\t\t
" } }, "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { "smithy.api#documentation": "

The dynamic thing group search query string.

\n\t\t

See Query Syntax for information about query string syntax.

", "smithy.api#required": {} } }, "queryVersion": { "target": "com.amazonaws.iot#QueryVersion", "traits": { "smithy.api#documentation": "

The dynamic thing group query version.

\n\t\t \n\t\t\t

Currently one query version is supported: \"2017-09-30\". If not specified, the\n\t\t\t\tquery version defaults to this value.

\n\t\t
" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the dynamic thing group.

" } } } }, "com.amazonaws.iot#CreateDynamicThingGroupResponse": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The dynamic thing group name.

" } }, "thingGroupArn": { "target": "com.amazonaws.iot#ThingGroupArn", "traits": { "smithy.api#documentation": "

The dynamic thing group ARN.

" } }, "thingGroupId": { "target": "com.amazonaws.iot#ThingGroupId", "traits": { "smithy.api#documentation": "

The dynamic thing group ID.

" } }, "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The dynamic thing group index name.

" } }, "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { "smithy.api#documentation": "

The dynamic thing group search query string.

" } }, "queryVersion": { "target": "com.amazonaws.iot#QueryVersion", "traits": { "smithy.api#documentation": "

The dynamic thing group query version.

" } } } }, "com.amazonaws.iot#CreateJob": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateJobRequest" }, "output": { "target": "com.amazonaws.iot#CreateJobResponse" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Creates a job.

", "smithy.api#http": { "method": "PUT", "uri": "/jobs/{jobId}", "code": 200 } } }, "com.amazonaws.iot#CreateJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric\n characters, \"-\" and \"_\" are valid for use here.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "targets": { "target": "com.amazonaws.iot#JobTargets", "traits": { "smithy.api#documentation": "

A list of things and thing groups to which the job should be sent.

", "smithy.api#required": {} } }, "documentSource": { "target": "com.amazonaws.iot#JobDocumentSource", "traits": { "smithy.api#documentation": "

An S3 link to the job document. Required if you don't specify a value for document.

\n \n

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

\n

The placeholder link is of the following form:

\n

\n ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}\n

\n

where bucket is your bucket name and key is the object in the bucket to which you are linking.

\n
" } }, "document": { "target": "com.amazonaws.iot#JobDocument", "traits": { "smithy.api#documentation": "

The job document. Required if you don't specify a value for documentSource.

" } }, "description": { "target": "com.amazonaws.iot#JobDescription", "traits": { "smithy.api#documentation": "

A short text description of the job.

" } }, "presignedUrlConfig": { "target": "com.amazonaws.iot#PresignedUrlConfig", "traits": { "smithy.api#documentation": "

Configuration information for pre-signed S3 URLs.

" } }, "targetSelection": { "target": "com.amazonaws.iot#TargetSelection", "traits": { "smithy.api#documentation": "

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.

" } }, "jobExecutionsRolloutConfig": { "target": "com.amazonaws.iot#JobExecutionsRolloutConfig", "traits": { "smithy.api#documentation": "

Allows you to create a staged rollout of the job.

" } }, "abortConfig": { "target": "com.amazonaws.iot#AbortConfig", "traits": { "smithy.api#documentation": "

Allows you to create criteria to abort a job.

" } }, "timeoutConfig": { "target": "com.amazonaws.iot#TimeoutConfig", "traits": { "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. The timer \n is started when the job execution status is set to IN_PROGRESS. If the job \n execution status is not set to another terminal state before the time expires, it will be \n automatically set to TIMED_OUT.

" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the job.

" } }, "namespaceId": { "target": "com.amazonaws.iot#NamespaceId", "traits": { "smithy.api#documentation": "

The namespace used to indicate that a job is a customer-managed job.

\n

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that \n contain the value in the following format.

\n

\n $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/\n

\n \n

The namespaceId feature is in public preview.

\n
" } }, "jobTemplateArn": { "target": "com.amazonaws.iot#JobTemplateArn", "traits": { "smithy.api#documentation": "

The ARN of the job template used to create the job.

" } } } }, "com.amazonaws.iot#CreateJobResponse": { "type": "structure", "members": { "jobArn": { "target": "com.amazonaws.iot#JobArn", "traits": { "smithy.api#documentation": "

The job ARN.

" } }, "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job.

" } }, "description": { "target": "com.amazonaws.iot#JobDescription", "traits": { "smithy.api#documentation": "

The job description.

" } } } }, "com.amazonaws.iot#CreateJobTemplate": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateJobTemplateRequest" }, "output": { "target": "com.amazonaws.iot#CreateJobTemplateResponse" }, "errors": [ { "target": "com.amazonaws.iot#ConflictException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Creates a job template.

", "smithy.api#http": { "method": "PUT", "uri": "/job-templates/{jobTemplateId}", "code": 200 } } }, "com.amazonaws.iot#CreateJobTemplateRequest": { "type": "structure", "members": { "jobTemplateId": { "target": "com.amazonaws.iot#JobTemplateId", "traits": { "smithy.api#documentation": "

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric \n characters, \"-\", and \"_\" are valid for use here.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobArn": { "target": "com.amazonaws.iot#JobArn", "traits": { "smithy.api#documentation": "

The ARN of the job to use as the basis for the job template.

" } }, "documentSource": { "target": "com.amazonaws.iot#JobDocumentSource", "traits": { "smithy.api#documentation": "

An S3 link to the job document to use in the template. Required if you don't specify a value for document.

\n \n

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

\n

The placeholder link is of the following form:

\n

\n ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}\n

\n

where bucket is your bucket name and key is the object in the bucket to which you are linking.

\n
" } }, "document": { "target": "com.amazonaws.iot#JobDocument", "traits": { "smithy.api#documentation": "

The job document. Required if you don't specify a value for documentSource.

" } }, "description": { "target": "com.amazonaws.iot#JobDescription", "traits": { "smithy.api#documentation": "

A description of the job document.

", "smithy.api#required": {} } }, "presignedUrlConfig": { "target": "com.amazonaws.iot#PresignedUrlConfig" }, "jobExecutionsRolloutConfig": { "target": "com.amazonaws.iot#JobExecutionsRolloutConfig" }, "abortConfig": { "target": "com.amazonaws.iot#AbortConfig" }, "timeoutConfig": { "target": "com.amazonaws.iot#TimeoutConfig" }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata that can be used to manage the job template.

" } } } }, "com.amazonaws.iot#CreateJobTemplateResponse": { "type": "structure", "members": { "jobTemplateArn": { "target": "com.amazonaws.iot#JobTemplateArn", "traits": { "smithy.api#documentation": "

The ARN of the job template.

" } }, "jobTemplateId": { "target": "com.amazonaws.iot#JobTemplateId", "traits": { "smithy.api#documentation": "

The unique identifier of the job template.

" } } } }, "com.amazonaws.iot#CreateKeysAndCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateKeysAndCertificateRequest" }, "output": { "target": "com.amazonaws.iot#CreateKeysAndCertificateResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued\n public key. You can also call CreateKeysAndCertificate over MQTT from a\n device, for more information, see Provisioning MQTT API.

\n

\n Note This is the only time AWS IoT issues the private key\n for this certificate, so it is important to keep it in a secure location.

", "smithy.api#http": { "method": "POST", "uri": "/keys-and-certificate", "code": 200 } } }, "com.amazonaws.iot#CreateKeysAndCertificateRequest": { "type": "structure", "members": { "setAsActive": { "target": "com.amazonaws.iot#SetAsActive", "traits": { "smithy.api#documentation": "

Specifies whether the certificate is active.

", "smithy.api#httpQuery": "setAsActive" } } }, "traits": { "smithy.api#documentation": "

The input for the CreateKeysAndCertificate operation.

" } }, "com.amazonaws.iot#CreateKeysAndCertificateResponse": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The ARN of the certificate.

" } }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate. AWS IoT issues a default subject name for the certificate\n (for example, AWS IoT Certificate).

" } }, "certificatePem": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The certificate data, in PEM format.

" } }, "keyPair": { "target": "com.amazonaws.iot#KeyPair", "traits": { "smithy.api#documentation": "

The generated key pair.

" } } }, "traits": { "smithy.api#documentation": "

The output of the CreateKeysAndCertificate operation.

" } }, "com.amazonaws.iot#CreateMitigationAction": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateMitigationActionRequest" }, "output": { "target": "com.amazonaws.iot#CreateMitigationActionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

", "smithy.api#http": { "method": "POST", "uri": "/mitigationactions/actions/{actionName}", "code": 200 } } }, "com.amazonaws.iot#CreateMitigationActionRequest": { "type": "structure", "members": { "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { "smithy.api#documentation": "

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that is used to apply the mitigation action.

", "smithy.api#required": {} } }, "actionParams": { "target": "com.amazonaws.iot#MitigationActionParams", "traits": { "smithy.api#documentation": "

Defines the type of action and the parameters for that action.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata that can be used to manage the mitigation action.

" } } } }, "com.amazonaws.iot#CreateMitigationActionResponse": { "type": "structure", "members": { "actionArn": { "target": "com.amazonaws.iot#MitigationActionArn", "traits": { "smithy.api#documentation": "

The ARN for the new mitigation action.

" } }, "actionId": { "target": "com.amazonaws.iot#MitigationActionId", "traits": { "smithy.api#documentation": "

A unique identifier for the new mitigation action.

" } } } }, "com.amazonaws.iot#CreateOTAUpdate": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateOTAUpdateRequest" }, "output": { "target": "com.amazonaws.iot#CreateOTAUpdateResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates an AWS IoT OTAUpdate on a target group of things or groups.

", "smithy.api#http": { "method": "POST", "uri": "/otaUpdates/{otaUpdateId}", "code": 200 } } }, "com.amazonaws.iot#CreateOTAUpdateRequest": { "type": "structure", "members": { "otaUpdateId": { "target": "com.amazonaws.iot#OTAUpdateId", "traits": { "smithy.api#documentation": "

The ID of the OTA update to be created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.iot#OTAUpdateDescription", "traits": { "smithy.api#documentation": "

The description of the OTA update.

" } }, "targets": { "target": "com.amazonaws.iot#Targets", "traits": { "smithy.api#documentation": "

The devices targeted to receive OTA updates.

", "smithy.api#required": {} } }, "protocols": { "target": "com.amazonaws.iot#Protocols", "traits": { "smithy.api#documentation": "

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both\n HTTP and MQTT are specified, the target device can choose the protocol.

" } }, "targetSelection": { "target": "com.amazonaws.iot#TargetSelection", "traits": { "smithy.api#documentation": "

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things\n specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a\n thing when a change is detected in a target. For example, an update will run on a thing when the thing is\n added to a target group, even after the update was completed by all things originally in the group. Valid\n values: CONTINUOUS | SNAPSHOT.

" } }, "awsJobExecutionsRolloutConfig": { "target": "com.amazonaws.iot#AwsJobExecutionsRolloutConfig", "traits": { "smithy.api#documentation": "

Configuration for the rollout of OTA updates.

" } }, "awsJobPresignedUrlConfig": { "target": "com.amazonaws.iot#AwsJobPresignedUrlConfig", "traits": { "smithy.api#documentation": "

Configuration information for pre-signed URLs.

" } }, "awsJobAbortConfig": { "target": "com.amazonaws.iot#AwsJobAbortConfig", "traits": { "smithy.api#documentation": "

The criteria that determine when and how a job abort takes place.

" } }, "awsJobTimeoutConfig": { "target": "com.amazonaws.iot#AwsJobTimeoutConfig", "traits": { "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. A timer is \n started when the job execution status is set to IN_PROGRESS. If the job execution \n status is not set to another terminal state before the timer expires, it will be automatically \n set to TIMED_OUT.

" } }, "files": { "target": "com.amazonaws.iot#OTAUpdateFiles", "traits": { "smithy.api#documentation": "

The files to be streamed by the OTA update.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources \n to create an OTA update job.

", "smithy.api#required": {} } }, "additionalParameters": { "target": "com.amazonaws.iot#AdditionalParameterMap", "traits": { "smithy.api#documentation": "

A list of additional OTA update parameters which are name-value pairs.

" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage updates.

" } } } }, "com.amazonaws.iot#CreateOTAUpdateResponse": { "type": "structure", "members": { "otaUpdateId": { "target": "com.amazonaws.iot#OTAUpdateId", "traits": { "smithy.api#documentation": "

The OTA update ID.

" } }, "awsIotJobId": { "target": "com.amazonaws.iot#AwsIotJobId", "traits": { "smithy.api#documentation": "

The AWS IoT job ID associated with the OTA update.

" } }, "otaUpdateArn": { "target": "com.amazonaws.iot#OTAUpdateArn", "traits": { "smithy.api#documentation": "

The OTA update ARN.

" } }, "awsIotJobArn": { "target": "com.amazonaws.iot#AwsIotJobArn", "traits": { "smithy.api#documentation": "

The AWS IoT job ARN associated with the OTA update.

" } }, "otaUpdateStatus": { "target": "com.amazonaws.iot#OTAUpdateStatus", "traits": { "smithy.api#documentation": "

The OTA update status.

" } } } }, "com.amazonaws.iot#CreatePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreatePolicyRequest" }, "output": { "target": "com.amazonaws.iot#CreatePolicyResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#MalformedPolicyException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates an AWS IoT policy.

\n

The created policy is the default version for the policy. This operation creates a\n policy version with a version identifier of 1 and sets\n 1 as the policy's default version.

", "smithy.api#http": { "method": "POST", "uri": "/policies/{policyName}", "code": 200 } } }, "com.amazonaws.iot#CreatePolicyRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "policyDocument": { "target": "com.amazonaws.iot#PolicyDocument", "traits": { "smithy.api#documentation": "

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of\n 2048, excluding whitespace.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the policy.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n
" } } }, "traits": { "smithy.api#documentation": "

The input for the CreatePolicy operation.

" } }, "com.amazonaws.iot#CreatePolicyResponse": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

" } }, "policyArn": { "target": "com.amazonaws.iot#PolicyArn", "traits": { "smithy.api#documentation": "

The policy ARN.

" } }, "policyDocument": { "target": "com.amazonaws.iot#PolicyDocument", "traits": { "smithy.api#documentation": "

The JSON document that describes the policy.

" } }, "policyVersionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The policy version ID.

" } } }, "traits": { "smithy.api#documentation": "

The output from the CreatePolicy operation.

" } }, "com.amazonaws.iot#CreatePolicyVersion": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreatePolicyVersionRequest" }, "output": { "target": "com.amazonaws.iot#CreatePolicyVersionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#MalformedPolicyException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" }, { "target": "com.amazonaws.iot#VersionsLimitExceededException" } ], "traits": { "smithy.api#documentation": "

Creates a new version of the specified AWS IoT policy. To update a policy, create a\n new policy version. A managed policy can have up to five versions. If the policy has five\n versions, you must use DeletePolicyVersion to delete an existing version\n before you create a new one.

\n

Optionally, you can set the new version as the policy's default version. The default\n version is the operative version (that is, the version that is in effect for the\n certificates to which the policy is attached).

", "smithy.api#http": { "method": "POST", "uri": "/policies/{policyName}/version", "code": 200 } } }, "com.amazonaws.iot#CreatePolicyVersionRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "policyDocument": { "target": "com.amazonaws.iot#PolicyDocument", "traits": { "smithy.api#documentation": "

The JSON document that describes the policy. Minimum length of 1. Maximum length of\n 2048, excluding whitespace.

", "smithy.api#required": {} } }, "setAsDefault": { "target": "com.amazonaws.iot#SetAsDefault", "traits": { "smithy.api#documentation": "

Specifies whether the policy version is set as the default. When this parameter is\n true, the new policy version becomes the operative version (that is, the version that is in\n effect for the certificates to which the policy is attached).

", "smithy.api#httpQuery": "setAsDefault" } } }, "traits": { "smithy.api#documentation": "

The input for the CreatePolicyVersion operation.

" } }, "com.amazonaws.iot#CreatePolicyVersionResponse": { "type": "structure", "members": { "policyArn": { "target": "com.amazonaws.iot#PolicyArn", "traits": { "smithy.api#documentation": "

The policy ARN.

" } }, "policyDocument": { "target": "com.amazonaws.iot#PolicyDocument", "traits": { "smithy.api#documentation": "

The JSON document that describes the policy.

" } }, "policyVersionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The policy version ID.

" } }, "isDefaultVersion": { "target": "com.amazonaws.iot#IsDefaultVersion", "traits": { "smithy.api#documentation": "

Specifies whether the policy version is the default.

" } } }, "traits": { "smithy.api#documentation": "

The output of the CreatePolicyVersion operation.

" } }, "com.amazonaws.iot#CreateProvisioningClaim": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateProvisioningClaimRequest" }, "output": { "target": "com.amazonaws.iot#CreateProvisioningClaimResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a provisioning claim.

", "smithy.api#http": { "method": "POST", "uri": "/provisioning-templates/{templateName}/provisioning-claim", "code": 200 } } }, "com.amazonaws.iot#CreateProvisioningClaimRequest": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the provisioning template to use.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#CreateProvisioningClaimResponse": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate.

" } }, "certificatePem": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The provisioning claim certificate.

" } }, "keyPair": { "target": "com.amazonaws.iot#KeyPair", "traits": { "smithy.api#documentation": "

The provisioning claim key pair.

" } }, "expiration": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The provisioning claim expiration time.

" } } } }, "com.amazonaws.iot#CreateProvisioningTemplate": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateProvisioningTemplateRequest" }, "output": { "target": "com.amazonaws.iot#CreateProvisioningTemplateResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a fleet provisioning template.

", "smithy.api#http": { "method": "POST", "uri": "/provisioning-templates", "code": 200 } } }, "com.amazonaws.iot#CreateProvisioningTemplateRequest": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provisioning template.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.iot#TemplateDescription", "traits": { "smithy.api#documentation": "

The description of the fleet provisioning template.

" } }, "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

", "smithy.api#required": {} } }, "enabled": { "target": "com.amazonaws.iot#Enabled", "traits": { "smithy.api#documentation": "

True to enable the fleet provisioning template, otherwise false.

" } }, "provisioningRoleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The role ARN for the role associated with the fleet provisioning template. This IoT role\n grants permission to provision a device.

", "smithy.api#required": {} } }, "preProvisioningHook": { "target": "com.amazonaws.iot#ProvisioningHook", "traits": { "smithy.api#documentation": "

Creates a pre-provisioning hook template.

" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the fleet provisioning template.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n
" } } } }, "com.amazonaws.iot#CreateProvisioningTemplateResponse": { "type": "structure", "members": { "templateArn": { "target": "com.amazonaws.iot#TemplateArn", "traits": { "smithy.api#documentation": "

The ARN that identifies the provisioning template.

" } }, "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provisioning template.

" } }, "defaultVersionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { "smithy.api#documentation": "

The default version of the fleet provisioning template.

" } } } }, "com.amazonaws.iot#CreateProvisioningTemplateVersion": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateProvisioningTemplateVersionRequest" }, "output": { "target": "com.amazonaws.iot#CreateProvisioningTemplateVersionResponse" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" }, { "target": "com.amazonaws.iot#VersionsLimitExceededException" } ], "traits": { "smithy.api#documentation": "

Creates a new version of a fleet provisioning template.

", "smithy.api#http": { "method": "POST", "uri": "/provisioning-templates/{templateName}/versions", "code": 200 } } }, "com.amazonaws.iot#CreateProvisioningTemplateVersionRequest": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provisioning template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

", "smithy.api#required": {} } }, "setAsDefault": { "target": "com.amazonaws.iot#SetAsDefault", "traits": { "smithy.api#documentation": "

Sets a fleet provision template version as the default version.

", "smithy.api#httpQuery": "setAsDefault" } } } }, "com.amazonaws.iot#CreateProvisioningTemplateVersionResponse": { "type": "structure", "members": { "templateArn": { "target": "com.amazonaws.iot#TemplateArn", "traits": { "smithy.api#documentation": "

The ARN that identifies the provisioning template.

" } }, "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provisioning template.

" } }, "versionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { "smithy.api#documentation": "

The version of the fleet provisioning template.

" } }, "isDefaultVersion": { "target": "com.amazonaws.iot#IsDefaultVersion", "traits": { "smithy.api#documentation": "

True if the fleet provisioning template version is the default version, otherwise\n false.

" } } } }, "com.amazonaws.iot#CreateRoleAlias": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateRoleAliasRequest" }, "output": { "target": "com.amazonaws.iot#CreateRoleAliasResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a role alias.

", "smithy.api#http": { "method": "POST", "uri": "/role-aliases/{roleAlias}", "code": 200 } } }, "com.amazonaws.iot#CreateRoleAliasRequest": { "type": "structure", "members": { "roleAlias": { "target": "com.amazonaws.iot#RoleAlias", "traits": { "smithy.api#documentation": "

The role alias that points to a role ARN. This allows you to change the role without\n having to update the device.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The role ARN.

", "smithy.api#required": {} } }, "credentialDurationSeconds": { "target": "com.amazonaws.iot#CredentialDurationSeconds", "traits": { "smithy.api#documentation": "

How long (in seconds) the credentials will be valid.

" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the role alias.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n
" } } } }, "com.amazonaws.iot#CreateRoleAliasResponse": { "type": "structure", "members": { "roleAlias": { "target": "com.amazonaws.iot#RoleAlias", "traits": { "smithy.api#documentation": "

The role alias.

" } }, "roleAliasArn": { "target": "com.amazonaws.iot#RoleAliasArn", "traits": { "smithy.api#documentation": "

The role alias ARN.

" } } } }, "com.amazonaws.iot#CreateScheduledAudit": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateScheduledAuditRequest" }, "output": { "target": "com.amazonaws.iot#CreateScheduledAuditResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Creates a scheduled audit that is run at a specified \n time interval.

", "smithy.api#http": { "method": "POST", "uri": "/audit/scheduledaudits/{scheduledAuditName}", "code": 200 } } }, "com.amazonaws.iot#CreateScheduledAuditRequest": { "type": "structure", "members": { "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { "smithy.api#documentation": "

How often the scheduled audit takes\n place, either\n DAILY,\n WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is\n determined by the system.

", "smithy.api#required": {} } }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place.\n This\n can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\"\n parameter is set to MONTHLY. If days\n 29\n to 31 are specified, and the month\n doesn't\n have that many days, the audit takes place on the LAST day of the month.

" } }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { "smithy.api#documentation": "

The day of the week on which the scheduled audit takes\n place,\n either\n SUN,\n MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency\n parameter is set to WEEKLY or BIWEEKLY.

" } }, "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

", "smithy.api#required": {} } }, "scheduledAuditName": { "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { "smithy.api#documentation": "

The name you want to give to the scheduled audit. (Max. 128 chars)

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata that can be used to manage the scheduled audit.

" } } } }, "com.amazonaws.iot#CreateScheduledAuditResponse": { "type": "structure", "members": { "scheduledAuditArn": { "target": "com.amazonaws.iot#ScheduledAuditArn", "traits": { "smithy.api#documentation": "

The ARN of the scheduled audit.

" } } } }, "com.amazonaws.iot#CreateSecurityProfile": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateSecurityProfileRequest" }, "output": { "target": "com.amazonaws.iot#CreateSecurityProfileResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Creates a Device Defender security profile.

", "smithy.api#http": { "method": "POST", "uri": "/security-profiles/{securityProfileName}", "code": 200 } } }, "com.amazonaws.iot#CreateSecurityProfileRequest": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name you are giving to the security profile.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "securityProfileDescription": { "target": "com.amazonaws.iot#SecurityProfileDescription", "traits": { "smithy.api#documentation": "

A description of the security profile.

" } }, "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, "alertTargets": { "target": "com.amazonaws.iot#AlertTargets", "traits": { "smithy.api#documentation": "

Specifies the destinations to which alerts are sent. (Alerts are always sent to the \n console.) Alerts are generated when a device (thing) violates a behavior.

" } }, "additionalMetricsToRetain": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainList", "traits": { "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, "smithy.api#documentation": "

\n Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.\n

\n

A list of metrics whose data is retained (stored). By default, data is retained \n for any metric used in the profile's behaviors, but it is also retained for \n any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata that can be used to manage the security profile.

" } } } }, "com.amazonaws.iot#CreateSecurityProfileResponse": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name you gave to the security profile.

" } }, "securityProfileArn": { "target": "com.amazonaws.iot#SecurityProfileArn", "traits": { "smithy.api#documentation": "

The ARN of the security profile.

" } } } }, "com.amazonaws.iot#CreateStream": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateStreamRequest" }, "output": { "target": "com.amazonaws.iot#CreateStreamResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data\n bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files\n associated with a stream.

", "smithy.api#http": { "method": "POST", "uri": "/streams/{streamId}", "code": 200 } } }, "com.amazonaws.iot#CreateStreamRequest": { "type": "structure", "members": { "streamId": { "target": "com.amazonaws.iot#StreamId", "traits": { "smithy.api#documentation": "

The stream ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.iot#StreamDescription", "traits": { "smithy.api#documentation": "

A description of the stream.

" } }, "files": { "target": "com.amazonaws.iot#StreamFiles", "traits": { "smithy.api#documentation": "

The files to stream.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

An IAM role that allows the IoT service principal assumes to access your S3 files.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage streams.

" } } } }, "com.amazonaws.iot#CreateStreamResponse": { "type": "structure", "members": { "streamId": { "target": "com.amazonaws.iot#StreamId", "traits": { "smithy.api#documentation": "

The stream ID.

" } }, "streamArn": { "target": "com.amazonaws.iot#StreamArn", "traits": { "smithy.api#documentation": "

The stream ARN.

" } }, "description": { "target": "com.amazonaws.iot#StreamDescription", "traits": { "smithy.api#documentation": "

A description of the stream.

" } }, "streamVersion": { "target": "com.amazonaws.iot#StreamVersion", "traits": { "smithy.api#documentation": "

The version of the stream.

" } } } }, "com.amazonaws.iot#CreateThing": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateThingRequest" }, "output": { "target": "com.amazonaws.iot#CreateThingResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a thing record in the registry. If this call is made multiple times using\n\t\t\tthe same thing name and configuration, the call will succeed. If this call is made with\n\t\t\tthe same thing name but different configuration a\n\t\t\t\tResourceAlreadyExistsException is thrown.

\n\t\t \n\t\t\t

This is a control plane operation. See Authorization for\n\t\t\t\tinformation about authorizing control plane actions.

\n\t\t
", "smithy.api#http": { "method": "POST", "uri": "/things/{thingName}", "code": 200 } } }, "com.amazonaws.iot#CreateThingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateThingGroupRequest" }, "output": { "target": "com.amazonaws.iot#CreateThingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Create a thing group.

\n\t\t \n\t\t\t

This is a control plane operation. See Authorization for\n\t\t\t\tinformation about authorizing control plane actions.

\n\t\t
", "smithy.api#http": { "method": "POST", "uri": "/thing-groups/{thingGroupName}", "code": 200 } } }, "com.amazonaws.iot#CreateThingGroupRequest": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The thing group name to create.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "parentGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The name of the parent thing group.

" } }, "thingGroupProperties": { "target": "com.amazonaws.iot#ThingGroupProperties", "traits": { "smithy.api#documentation": "

The thing group properties.

" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the thing group.

" } } } }, "com.amazonaws.iot#CreateThingGroupResponse": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The thing group name.

" } }, "thingGroupArn": { "target": "com.amazonaws.iot#ThingGroupArn", "traits": { "smithy.api#documentation": "

The thing group ARN.

" } }, "thingGroupId": { "target": "com.amazonaws.iot#ThingGroupId", "traits": { "smithy.api#documentation": "

The thing group ID.

" } } } }, "com.amazonaws.iot#CreateThingRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing to create.

\n\t\t

You can't change a thing's name after you create it. To change a thing's name, you must create a\n\t\t\tnew thing, give it the new name, and then delete the old thing.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type associated with the new thing.

" } }, "attributePayload": { "target": "com.amazonaws.iot#AttributePayload", "traits": { "smithy.api#documentation": "

The attribute payload, which consists of up to three name/value pairs in a JSON\n\t\t\tdocument. For example:

\n\t\t

\n\t\t\t {\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}\n\t\t

" } }, "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name of the billing group the thing will be added to.

" } } }, "traits": { "smithy.api#documentation": "

The input for the CreateThing operation.

" } }, "com.amazonaws.iot#CreateThingResponse": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the new thing.

" } }, "thingArn": { "target": "com.amazonaws.iot#ThingArn", "traits": { "smithy.api#documentation": "

The ARN of the new thing.

" } }, "thingId": { "target": "com.amazonaws.iot#ThingId", "traits": { "smithy.api#documentation": "

The thing ID.

" } } }, "traits": { "smithy.api#documentation": "

The output of the CreateThing operation.

" } }, "com.amazonaws.iot#CreateThingType": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateThingTypeRequest" }, "output": { "target": "com.amazonaws.iot#CreateThingTypeResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a new thing type.

", "smithy.api#http": { "method": "POST", "uri": "/thing-types/{thingTypeName}", "code": 200 } } }, "com.amazonaws.iot#CreateThingTypeRequest": { "type": "structure", "members": { "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "thingTypeProperties": { "target": "com.amazonaws.iot#ThingTypeProperties", "traits": { "smithy.api#documentation": "

The ThingTypeProperties for the thing type to create. It contains information about\n\t\t\tthe new thing type including a description, and a list of searchable thing attribute\n\t\t\tnames.

" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the thing type.

" } } }, "traits": { "smithy.api#documentation": "

The input for the CreateThingType operation.

" } }, "com.amazonaws.iot#CreateThingTypeResponse": { "type": "structure", "members": { "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type.

" } }, "thingTypeArn": { "target": "com.amazonaws.iot#ThingTypeArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the thing type.

" } }, "thingTypeId": { "target": "com.amazonaws.iot#ThingTypeId", "traits": { "smithy.api#documentation": "

The thing type ID.

" } } }, "traits": { "smithy.api#documentation": "

The output of the CreateThingType operation.

" } }, "com.amazonaws.iot#CreateTopicRule": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateTopicRuleRequest" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#SqlParseException" } ], "traits": { "smithy.api#documentation": "

Creates a rule. Creating rules is an administrator-level action. Any user who has\n permission to create rules will be able to access data processed by the rule.

", "smithy.api#http": { "method": "POST", "uri": "/rules/{ruleName}", "code": 200 } } }, "com.amazonaws.iot#CreateTopicRuleDestination": { "type": "operation", "input": { "target": "com.amazonaws.iot#CreateTopicRuleDestinationRequest" }, "output": { "target": "com.amazonaws.iot#CreateTopicRuleDestinationResponse" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Creates a topic rule destination. The destination must be confirmed prior to use.

", "smithy.api#http": { "method": "POST", "uri": "/destinations", "code": 200 } } }, "com.amazonaws.iot#CreateTopicRuleDestinationRequest": { "type": "structure", "members": { "destinationConfiguration": { "target": "com.amazonaws.iot#TopicRuleDestinationConfiguration", "traits": { "smithy.api#documentation": "

The topic rule destination configuration.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#CreateTopicRuleDestinationResponse": { "type": "structure", "members": { "topicRuleDestination": { "target": "com.amazonaws.iot#TopicRuleDestination", "traits": { "smithy.api#documentation": "

The topic rule destination.

" } } } }, "com.amazonaws.iot#CreateTopicRuleRequest": { "type": "structure", "members": { "ruleName": { "target": "com.amazonaws.iot#RuleName", "traits": { "smithy.api#documentation": "

The name of the rule.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "topicRulePayload": { "target": "com.amazonaws.iot#TopicRulePayload", "traits": { "smithy.api#documentation": "

The rule payload.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the topic rule.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: --tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n
", "smithy.api#httpHeader": "x-amz-tagging" } } }, "traits": { "smithy.api#documentation": "

The input for the CreateTopicRule operation.

" } }, "com.amazonaws.iot#CreatedAtDate": { "type": "timestamp" }, "com.amazonaws.iot#CreationDate": { "type": "timestamp" }, "com.amazonaws.iot#CredentialDurationSeconds": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 900, "max": 3600 } } }, "com.amazonaws.iot#CustomCodeSigning": { "type": "structure", "members": { "signature": { "target": "com.amazonaws.iot#CodeSigningSignature", "traits": { "smithy.api#documentation": "

The signature for the file.

" } }, "certificateChain": { "target": "com.amazonaws.iot#CodeSigningCertificateChain", "traits": { "smithy.api#documentation": "

The certificate chain.

" } }, "hashAlgorithm": { "target": "com.amazonaws.iot#HashAlgorithm", "traits": { "smithy.api#documentation": "

The hash algorithm used to code sign the file.

" } }, "signatureAlgorithm": { "target": "com.amazonaws.iot#SignatureAlgorithm", "traits": { "smithy.api#documentation": "

The signature algorithm used to code sign the file.

" } } }, "traits": { "smithy.api#documentation": "

Describes a custom method used to code sign a file.

" } }, "com.amazonaws.iot#CustomMetricArn": { "type": "string" }, "com.amazonaws.iot#CustomMetricDisplayName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "[\\p{Graph}\\x20]*" } }, "com.amazonaws.iot#CustomMetricType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "string-list", "name": "STRING_LIST" }, { "value": "ip-address-list", "name": "IP_ADDRESS_LIST" }, { "value": "number-list", "name": "NUMBER_LIST" }, { "value": "number", "name": "NUMBER" } ] } }, "com.amazonaws.iot#CustomerVersion": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.iot#DataCollectionPercentage": { "type": "double", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.iot#DateType": { "type": "timestamp" }, "com.amazonaws.iot#DayOfMonth": { "type": "string", "traits": { "smithy.api#pattern": "^([1-9]|[12][0-9]|3[01])$|^LAST$" } }, "com.amazonaws.iot#DayOfWeek": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SUN", "name": "SUN" }, { "value": "MON", "name": "MON" }, { "value": "TUE", "name": "TUE" }, { "value": "WED", "name": "WED" }, { "value": "THU", "name": "THU" }, { "value": "FRI", "name": "FRI" }, { "value": "SAT", "name": "SAT" } ] } }, "com.amazonaws.iot#DeleteAccountAuditConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteAccountAuditConfigurationRequest" }, "output": { "target": "com.amazonaws.iot#DeleteAccountAuditConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Restores the default settings for Device Defender audits for this account. Any\n configuration data you entered is deleted and all audit checks are reset to \n disabled.

", "smithy.api#http": { "method": "DELETE", "uri": "/audit/configuration", "code": 200 } } }, "com.amazonaws.iot#DeleteAccountAuditConfigurationRequest": { "type": "structure", "members": { "deleteScheduledAudits": { "target": "com.amazonaws.iot#DeleteScheduledAudits", "traits": { "smithy.api#documentation": "

If true, all scheduled audits are deleted.

", "smithy.api#httpQuery": "deleteScheduledAudits" } } } }, "com.amazonaws.iot#DeleteAccountAuditConfigurationResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteAdditionalMetricsToRetain": { "type": "boolean" }, "com.amazonaws.iot#DeleteAlertTargets": { "type": "boolean" }, "com.amazonaws.iot#DeleteAuditSuppression": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteAuditSuppressionRequest" }, "output": { "target": "com.amazonaws.iot#DeleteAuditSuppressionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Deletes a Device Defender audit suppression.\n

", "smithy.api#http": { "method": "POST", "uri": "/audit/suppressions/delete", "code": 200 } } }, "com.amazonaws.iot#DeleteAuditSuppressionRequest": { "type": "structure", "members": { "checkName": { "target": "com.amazonaws.iot#AuditCheckName", "traits": { "smithy.api#required": {} } }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier", "traits": { "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteAuditSuppressionResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteAuthorizer": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteAuthorizerRequest" }, "output": { "target": "com.amazonaws.iot#DeleteAuthorizerResponse" }, "errors": [ { "target": "com.amazonaws.iot#DeleteConflictException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes an authorizer.

", "smithy.api#http": { "method": "DELETE", "uri": "/authorizer/{authorizerName}", "code": 200 } } }, "com.amazonaws.iot#DeleteAuthorizerRequest": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The name of the authorizer to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteAuthorizerResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteBehaviors": { "type": "boolean" }, "com.amazonaws.iot#DeleteBillingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteBillingGroupRequest" }, "output": { "target": "com.amazonaws.iot#DeleteBillingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Deletes the billing group.

", "smithy.api#http": { "method": "DELETE", "uri": "/billing-groups/{billingGroupName}", "code": 200 } } }, "com.amazonaws.iot#DeleteBillingGroupRequest": { "type": "structure", "members": { "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name of the billing group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the billing group. If the version of the billing group does\n\t\t\tnot match the expected version specified in the request, the\n\t\t\t\tDeleteBillingGroup request is rejected with a\n\t\t\t\tVersionConflictException.

", "smithy.api#httpQuery": "expectedVersion" } } } }, "com.amazonaws.iot#DeleteBillingGroupResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteCACertificate": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteCACertificateRequest" }, "output": { "target": "com.amazonaws.iot#DeleteCACertificateResponse" }, "errors": [ { "target": "com.amazonaws.iot#CertificateStateException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes a registered CA certificate.

", "smithy.api#http": { "method": "DELETE", "uri": "/cacertificate/{certificateId}", "code": 200 } } }, "com.amazonaws.iot#DeleteCACertificateRequest": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate to delete. (The last part of the certificate ARN contains\n the certificate ID.)

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for the DeleteCACertificate operation.

" } }, "com.amazonaws.iot#DeleteCACertificateResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The output for the DeleteCACertificate operation.

" } }, "com.amazonaws.iot#DeleteCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteCertificateRequest" }, "errors": [ { "target": "com.amazonaws.iot#CertificateStateException" }, { "target": "com.amazonaws.iot#DeleteConflictException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified certificate.

\n

A certificate cannot be deleted if it has a policy or IoT thing attached to it or if\n its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE\n status.

", "smithy.api#http": { "method": "DELETE", "uri": "/certificates/{certificateId}", "code": 200 } } }, "com.amazonaws.iot#DeleteCertificateRequest": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "forceDelete": { "target": "com.amazonaws.iot#ForceDelete", "traits": { "smithy.api#documentation": "

Forces the deletion of a certificate if it is inactive and is not attached to an IoT\n thing.

", "smithy.api#httpQuery": "forceDelete" } } }, "traits": { "smithy.api#documentation": "

The input for the DeleteCertificate operation.

" } }, "com.amazonaws.iot#DeleteConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

You can't delete the resource because it is attached to one or more\n resources.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iot#DeleteCustomMetric": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteCustomMetricRequest" }, "output": { "target": "com.amazonaws.iot#DeleteCustomMetricResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "\n

Before you can delete a custom metric, you must first remove the custom metric from all\n security profiles it's a part of.\n The\n security\n profile associated with the custom metric can be found using the ListSecurityProfiles\n API with metricName set to your custom metric name.

\n
\n

\n Deletes a Device Defender detect custom metric.\n

", "smithy.api#http": { "method": "DELETE", "uri": "/custom-metric/{metricName}", "code": 200 } } }, "com.amazonaws.iot#DeleteCustomMetricRequest": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { "smithy.api#documentation": "

\n The name of the custom metric.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteCustomMetricResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteDimension": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteDimensionRequest" }, "output": { "target": "com.amazonaws.iot#DeleteDimensionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Removes the specified dimension from your AWS account.

", "smithy.api#http": { "method": "DELETE", "uri": "/dimensions/{name}", "code": 200 } } }, "com.amazonaws.iot#DeleteDimensionRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { "smithy.api#documentation": "

The unique identifier for the dimension that you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteDimensionResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteDomainConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteDomainConfigurationRequest" }, "output": { "target": "com.amazonaws.iot#DeleteDomainConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified domain configuration.

", "smithy.api#http": { "method": "DELETE", "uri": "/domainConfigurations/{domainConfigurationName}", "code": 200 } } }, "com.amazonaws.iot#DeleteDomainConfigurationRequest": { "type": "structure", "members": { "domainConfigurationName": { "target": "com.amazonaws.iot#DomainConfigurationName", "traits": { "smithy.api#documentation": "

The name of the domain configuration to be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteDomainConfigurationResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteDynamicThingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteDynamicThingGroupRequest" }, "output": { "target": "com.amazonaws.iot#DeleteDynamicThingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Deletes a dynamic thing group.

", "smithy.api#http": { "method": "DELETE", "uri": "/dynamic-thing-groups/{thingGroupName}", "code": 200 } } }, "com.amazonaws.iot#DeleteDynamicThingGroupRequest": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The name of the dynamic thing group to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the dynamic thing group to delete.

", "smithy.api#httpQuery": "expectedVersion" } } } }, "com.amazonaws.iot#DeleteDynamicThingGroupResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteJob": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteJobRequest" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#InvalidStateTransitionException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Deletes a job and its related job executions.

\n

Deleting a job may take time, depending on the number of job\n executions created for the job and various other factors. While the job\n is being deleted, the status of the job will be shown as \n \"DELETION_IN_PROGRESS\". Attempting to delete or cancel a job whose status \n is already \"DELETION_IN_PROGRESS\" will result in an error.

\n

Only 10 jobs may have status \"DELETION_IN_PROGRESS\" at the same time, or\n a LimitExceededException will occur.

", "smithy.api#http": { "method": "DELETE", "uri": "/jobs/{jobId}", "code": 200 } } }, "com.amazonaws.iot#DeleteJobExecution": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteJobExecutionRequest" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#InvalidStateTransitionException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Deletes a job execution.

", "smithy.api#http": { "method": "DELETE", "uri": "/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}", "code": 200 } } }, "com.amazonaws.iot#DeleteJobExecutionRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The ID of the job whose execution on a particular device will be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing whose job execution will be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "executionNumber": { "target": "com.amazonaws.iot#ExecutionNumber", "traits": { "smithy.api#documentation": "

The ID of the job execution to be deleted. The executionNumber refers to the \n execution of a particular job on a particular device.

\n

Note that once a job execution is deleted, the executionNumber may be reused \n by IoT, so be sure you get and use the correct value here.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "force": { "target": "com.amazonaws.iot#ForceFlag", "traits": { "smithy.api#documentation": "

(Optional) When true, you can delete a job execution which is \"IN_PROGRESS\". Otherwise, \n you can only delete a job execution which is in a terminal state (\"SUCCEEDED\", \"FAILED\",\n \"REJECTED\", \"REMOVED\" or \"CANCELED\") or an exception will occur. The default is false.

\n \n

Deleting a job execution which is \"IN_PROGRESS\", will cause the device \n to be unable to access job information or update the job execution status.\n Use caution and ensure that the device is able to recover to a valid state.

\n
", "smithy.api#httpQuery": "force" } }, "namespaceId": { "target": "com.amazonaws.iot#NamespaceId", "traits": { "smithy.api#documentation": "

The namespace used to indicate that a job is a customer-managed job.

\n

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that \n contain the value in the following format.

\n

\n $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/\n

\n \n

The namespaceId feature is in public preview.

\n
", "smithy.api#httpQuery": "namespaceId" } } } }, "com.amazonaws.iot#DeleteJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The ID of the job to be deleted.

\n

After a job deletion is completed, you may reuse this jobId when you create a new job. \n However, this is not recommended, and you must ensure that your devices are not using the \n jobId to refer to the deleted job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "force": { "target": "com.amazonaws.iot#ForceFlag", "traits": { "smithy.api#documentation": "

(Optional) When true, you can delete a job which is \"IN_PROGRESS\". Otherwise, you can\n only delete a job which is in a terminal state (\"COMPLETED\" or \"CANCELED\") or an exception \n will occur. The default is false.

\n \n

Deleting a job which is \"IN_PROGRESS\", will cause a device which is executing \n the job to be unable to access job information or update the job execution status.\n Use caution and ensure that each device executing a job which is deleted is able to recover to \n a valid state.

\n
", "smithy.api#httpQuery": "force" } }, "namespaceId": { "target": "com.amazonaws.iot#NamespaceId", "traits": { "smithy.api#documentation": "

The namespace used to indicate that a job is a customer-managed job.

\n

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that \n contain the value in the following format.

\n

\n $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/\n

\n \n

The namespaceId feature is in public preview.

\n
", "smithy.api#httpQuery": "namespaceId" } } } }, "com.amazonaws.iot#DeleteJobTemplate": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteJobTemplateRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified job template.

", "smithy.api#http": { "method": "DELETE", "uri": "/job-templates/{jobTemplateId}", "code": 200 } } }, "com.amazonaws.iot#DeleteJobTemplateRequest": { "type": "structure", "members": { "jobTemplateId": { "target": "com.amazonaws.iot#JobTemplateId", "traits": { "smithy.api#documentation": "

The unique identifier of the job template to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteMitigationAction": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteMitigationActionRequest" }, "output": { "target": "com.amazonaws.iot#DeleteMitigationActionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Deletes a defined mitigation action from your AWS account.

", "smithy.api#http": { "method": "DELETE", "uri": "/mitigationactions/actions/{actionName}", "code": 200 } } }, "com.amazonaws.iot#DeleteMitigationActionRequest": { "type": "structure", "members": { "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { "smithy.api#documentation": "

The name of the mitigation action that you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteMitigationActionResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteOTAUpdate": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteOTAUpdateRequest" }, "output": { "target": "com.amazonaws.iot#DeleteOTAUpdateResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Delete an OTA update.

", "smithy.api#http": { "method": "DELETE", "uri": "/otaUpdates/{otaUpdateId}", "code": 200 } } }, "com.amazonaws.iot#DeleteOTAUpdateRequest": { "type": "structure", "members": { "otaUpdateId": { "target": "com.amazonaws.iot#OTAUpdateId", "traits": { "smithy.api#documentation": "

The ID of the OTA update to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "deleteStream": { "target": "com.amazonaws.iot#DeleteStream_", "traits": { "smithy.api#documentation": "

When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted.\n Ignored if the stream specified in the OTAUpdate is supplied by the user.

", "smithy.api#httpQuery": "deleteStream" } }, "forceDeleteAWSJob": { "target": "com.amazonaws.iot#ForceDeleteAWSJob", "traits": { "smithy.api#documentation": "

When true, deletes the AWS job created by the OTAUpdate process even if it is \"IN_PROGRESS\". Otherwise, if the \n job is not in a terminal state (\"COMPLETED\" or \"CANCELED\") an exception will occur. The default is false.

", "smithy.api#httpQuery": "forceDeleteAWSJob" } } } }, "com.amazonaws.iot#DeleteOTAUpdateResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeletePolicy": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeletePolicyRequest" }, "errors": [ { "target": "com.amazonaws.iot#DeleteConflictException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified policy.

\n

A policy cannot be deleted if it has non-default versions or it is attached to any\n certificate.

\n

To delete a policy, use the DeletePolicyVersion API to delete all non-default\n versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any\n certificate; and then use the DeletePolicy API to delete the policy.

\n

When a policy is deleted using DeletePolicy, its default version is deleted with\n it.

", "smithy.api#http": { "method": "DELETE", "uri": "/policies/{policyName}", "code": 200 } } }, "com.amazonaws.iot#DeletePolicyRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The name of the policy to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DeletePolicy operation.

" } }, "com.amazonaws.iot#DeletePolicyVersion": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeletePolicyVersionRequest" }, "errors": [ { "target": "com.amazonaws.iot#DeleteConflictException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified version of the specified policy. You cannot delete the default\n version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default\n version, use ListPolicyVersions.

", "smithy.api#http": { "method": "DELETE", "uri": "/policies/{policyName}/version/{policyVersionId}", "code": 200 } } }, "com.amazonaws.iot#DeletePolicyVersionRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The name of the policy.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "policyVersionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The policy version ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DeletePolicyVersion operation.

" } }, "com.amazonaws.iot#DeleteProvisioningTemplate": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteProvisioningTemplateRequest" }, "output": { "target": "com.amazonaws.iot#DeleteProvisioningTemplateResponse" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#DeleteConflictException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes a fleet provisioning template.

", "smithy.api#http": { "method": "DELETE", "uri": "/provisioning-templates/{templateName}", "code": 200 } } }, "com.amazonaws.iot#DeleteProvisioningTemplateRequest": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provision template to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteProvisioningTemplateResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteProvisioningTemplateVersion": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteProvisioningTemplateVersionRequest" }, "output": { "target": "com.amazonaws.iot#DeleteProvisioningTemplateVersionResponse" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#DeleteConflictException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes a fleet provisioning template version.

", "smithy.api#http": { "method": "DELETE", "uri": "/provisioning-templates/{templateName}/versions/{versionId}", "code": 200 } } }, "com.amazonaws.iot#DeleteProvisioningTemplateVersionRequest": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provisioning template version to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "versionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { "smithy.api#documentation": "

The fleet provisioning template version ID to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteProvisioningTemplateVersionResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteRegistrationCode": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteRegistrationCodeRequest" }, "output": { "target": "com.amazonaws.iot#DeleteRegistrationCodeResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes a CA certificate registration code.

", "smithy.api#http": { "method": "DELETE", "uri": "/registrationcode", "code": 200 } } }, "com.amazonaws.iot#DeleteRegistrationCodeRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The input for the DeleteRegistrationCode operation.

" } }, "com.amazonaws.iot#DeleteRegistrationCodeResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The output for the DeleteRegistrationCode operation.

" } }, "com.amazonaws.iot#DeleteRoleAlias": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteRoleAliasRequest" }, "output": { "target": "com.amazonaws.iot#DeleteRoleAliasResponse" }, "errors": [ { "target": "com.amazonaws.iot#DeleteConflictException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes a role alias

", "smithy.api#http": { "method": "DELETE", "uri": "/role-aliases/{roleAlias}", "code": 200 } } }, "com.amazonaws.iot#DeleteRoleAliasRequest": { "type": "structure", "members": { "roleAlias": { "target": "com.amazonaws.iot#RoleAlias", "traits": { "smithy.api#documentation": "

The role alias to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteRoleAliasResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteScheduledAudit": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteScheduledAuditRequest" }, "output": { "target": "com.amazonaws.iot#DeleteScheduledAuditResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Deletes a scheduled audit.

", "smithy.api#http": { "method": "DELETE", "uri": "/audit/scheduledaudits/{scheduledAuditName}", "code": 200 } } }, "com.amazonaws.iot#DeleteScheduledAuditRequest": { "type": "structure", "members": { "scheduledAuditName": { "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { "smithy.api#documentation": "

The name of the scheduled audit you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteScheduledAuditResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteScheduledAudits": { "type": "boolean" }, "com.amazonaws.iot#DeleteSecurityProfile": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteSecurityProfileRequest" }, "output": { "target": "com.amazonaws.iot#DeleteSecurityProfileResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Deletes a Device Defender security profile.

", "smithy.api#http": { "method": "DELETE", "uri": "/security-profiles/{securityProfileName}", "code": 200 } } }, "com.amazonaws.iot#DeleteSecurityProfileRequest": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name of the security profile to be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.

", "smithy.api#httpQuery": "expectedVersion" } } } }, "com.amazonaws.iot#DeleteSecurityProfileResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteStream": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteStreamRequest" }, "output": { "target": "com.amazonaws.iot#DeleteStreamResponse" }, "errors": [ { "target": "com.amazonaws.iot#DeleteConflictException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes a stream.

", "smithy.api#http": { "method": "DELETE", "uri": "/streams/{streamId}", "code": 200 } } }, "com.amazonaws.iot#DeleteStreamRequest": { "type": "structure", "members": { "streamId": { "target": "com.amazonaws.iot#StreamId", "traits": { "smithy.api#documentation": "

The stream ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteStreamResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteStream_": { "type": "boolean" }, "com.amazonaws.iot#DeleteThing": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteThingRequest" }, "output": { "target": "com.amazonaws.iot#DeleteThingResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified thing. Returns successfully with no error if the deletion is\n\t\t\tsuccessful or you specify a thing that doesn't exist.

", "smithy.api#http": { "method": "DELETE", "uri": "/things/{thingName}", "code": 200 } } }, "com.amazonaws.iot#DeleteThingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteThingGroupRequest" }, "output": { "target": "com.amazonaws.iot#DeleteThingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Deletes a thing group.

", "smithy.api#http": { "method": "DELETE", "uri": "/thing-groups/{thingGroupName}", "code": 200 } } }, "com.amazonaws.iot#DeleteThingGroupRequest": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The name of the thing group to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the thing group to delete.

", "smithy.api#httpQuery": "expectedVersion" } } } }, "com.amazonaws.iot#DeleteThingGroupResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteThingRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the thing record in the registry. If the version of the\n\t\t\trecord in the registry does not match the expected version specified in the request, the\n\t\t\t\tDeleteThing request is rejected with a\n\t\t\t\tVersionConflictException.

", "smithy.api#httpQuery": "expectedVersion" } } }, "traits": { "smithy.api#documentation": "

The input for the DeleteThing operation.

" } }, "com.amazonaws.iot#DeleteThingResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The output of the DeleteThing operation.

" } }, "com.amazonaws.iot#DeleteThingType": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteThingTypeRequest" }, "output": { "target": "com.amazonaws.iot#DeleteThingTypeResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified thing type. You cannot delete a thing type if it has things\n\t\t\tassociated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and\n\t\t\tfinally use DeleteThingType to delete the thing type.

", "smithy.api#http": { "method": "DELETE", "uri": "/thing-types/{thingTypeName}", "code": 200 } } }, "com.amazonaws.iot#DeleteThingTypeRequest": { "type": "structure", "members": { "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DeleteThingType operation.

" } }, "com.amazonaws.iot#DeleteThingTypeResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The output for the DeleteThingType operation.

" } }, "com.amazonaws.iot#DeleteTopicRule": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteTopicRuleRequest" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes the rule.

", "smithy.api#http": { "method": "DELETE", "uri": "/rules/{ruleName}", "code": 200 } } }, "com.amazonaws.iot#DeleteTopicRuleDestination": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteTopicRuleDestinationRequest" }, "output": { "target": "com.amazonaws.iot#DeleteTopicRuleDestinationResponse" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deletes a topic rule destination.

", "smithy.api#http": { "method": "DELETE", "uri": "/destinations/{arn+}", "code": 200 } } }, "com.amazonaws.iot#DeleteTopicRuleDestinationRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the topic rule destination to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeleteTopicRuleDestinationResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DeleteTopicRuleRequest": { "type": "structure", "members": { "ruleName": { "target": "com.amazonaws.iot#RuleName", "traits": { "smithy.api#documentation": "

The name of the rule.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DeleteTopicRule operation.

" } }, "com.amazonaws.iot#DeleteV2LoggingLevel": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeleteV2LoggingLevelRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Deletes a logging level.

", "smithy.api#http": { "method": "DELETE", "uri": "/v2LoggingLevel", "code": 200 } } }, "com.amazonaws.iot#DeleteV2LoggingLevelRequest": { "type": "structure", "members": { "targetType": { "target": "com.amazonaws.iot#LogTargetType", "traits": { "smithy.api#documentation": "

The type of resource for which you are configuring logging. Must be\n THING_Group.

", "smithy.api#httpQuery": "targetType", "smithy.api#required": {} } }, "targetName": { "target": "com.amazonaws.iot#LogTargetName", "traits": { "smithy.api#documentation": "

The name of the resource for which you are configuring logging.

", "smithy.api#httpQuery": "targetName", "smithy.api#required": {} } } } }, "com.amazonaws.iot#DeliveryStreamName": { "type": "string" }, "com.amazonaws.iot#Denied": { "type": "structure", "members": { "implicitDeny": { "target": "com.amazonaws.iot#ImplicitDeny", "traits": { "smithy.api#documentation": "

Information that implicitly denies the authorization. When a policy doesn't\n explicitly deny or allow an action on a resource it is considered an implicit\n deny.

" } }, "explicitDeny": { "target": "com.amazonaws.iot#ExplicitDeny", "traits": { "smithy.api#documentation": "

Information that explicitly denies the authorization.

" } } }, "traits": { "smithy.api#documentation": "

Contains information that denied the authorization.

" } }, "com.amazonaws.iot#DeprecateThingType": { "type": "operation", "input": { "target": "com.amazonaws.iot#DeprecateThingTypeRequest" }, "output": { "target": "com.amazonaws.iot#DeprecateThingTypeResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Deprecates a thing type. You can not associate new things with deprecated thing\n\t\t\ttype.

", "smithy.api#http": { "method": "POST", "uri": "/thing-types/{thingTypeName}/deprecate", "code": 200 } } }, "com.amazonaws.iot#DeprecateThingTypeRequest": { "type": "structure", "members": { "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type to deprecate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "undoDeprecate": { "target": "com.amazonaws.iot#UndoDeprecate", "traits": { "smithy.api#documentation": "

Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can\n\t\t\tassociate it with things.

" } } }, "traits": { "smithy.api#documentation": "

The input for the DeprecateThingType operation.

" } }, "com.amazonaws.iot#DeprecateThingTypeResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The output for the DeprecateThingType operation.

" } }, "com.amazonaws.iot#DeprecationDate": { "type": "timestamp" }, "com.amazonaws.iot#DescribeAccountAuditConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeAccountAuditConfigurationRequest" }, "output": { "target": "com.amazonaws.iot#DescribeAccountAuditConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets information about the Device Defender audit settings for this account.\n Settings include how audit notifications are sent and which audit checks are\n enabled or disabled.

", "smithy.api#http": { "method": "GET", "uri": "/audit/configuration", "code": 200 } } }, "com.amazonaws.iot#DescribeAccountAuditConfigurationRequest": { "type": "structure", "members": {} }, "com.amazonaws.iot#DescribeAccountAuditConfigurationResponse": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the role that grants permission to AWS IoT to access information\n about your devices, policies, certificates, and other items as required when \n performing an audit.

\n

On the first call to UpdateAccountAuditConfiguration,\n this parameter is required.

" } }, "auditNotificationTargetConfigurations": { "target": "com.amazonaws.iot#AuditNotificationTargetConfigurations", "traits": { "smithy.api#documentation": "

Information about the targets to which audit notifications are sent for \n this account.

" } }, "auditCheckConfigurations": { "target": "com.amazonaws.iot#AuditCheckConfigurations", "traits": { "smithy.api#documentation": "

Which audit checks are enabled and disabled for this account.

" } } } }, "com.amazonaws.iot#DescribeAuditFinding": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeAuditFindingRequest" }, "output": { "target": "com.amazonaws.iot#DescribeAuditFindingResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets information about a single audit finding. Properties include the reason for\n noncompliance, the severity of the issue,\n and the start time\n when the audit that returned the\n finding.

", "smithy.api#http": { "method": "GET", "uri": "/audit/findings/{findingId}", "code": 200 } } }, "com.amazonaws.iot#DescribeAuditFindingRequest": { "type": "structure", "members": { "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { "smithy.api#documentation": "

A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeAuditFindingResponse": { "type": "structure", "members": { "finding": { "target": "com.amazonaws.iot#AuditFinding" } } }, "com.amazonaws.iot#DescribeAuditMitigationActionsTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeAuditMitigationActionsTaskRequest" }, "output": { "target": "com.amazonaws.iot#DescribeAuditMitigationActionsTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

", "smithy.api#http": { "method": "GET", "uri": "/audit/mitigationactions/tasks/{taskId}", "code": 200 } } }, "com.amazonaws.iot#DescribeAuditMitigationActionsTaskRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

The unique identifier for the audit mitigation task.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeAuditMitigationActionsTaskResponse": { "type": "structure", "members": { "taskStatus": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatus", "traits": { "smithy.api#documentation": "

The current status of the task.

" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the task was started.

" } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the task was completed or canceled.

" } }, "taskStatistics": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatistics", "traits": { "smithy.api#documentation": "

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

" } }, "target": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", "traits": { "smithy.api#documentation": "

Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

" } }, "auditCheckToActionsMapping": { "target": "com.amazonaws.iot#AuditCheckToActionsMapping", "traits": { "smithy.api#documentation": "

Specifies the mitigation actions that should be applied to specific audit checks.

" } }, "actionsDefinition": { "target": "com.amazonaws.iot#MitigationActionList", "traits": { "smithy.api#documentation": "

Specifies the mitigation actions and their parameters that are applied as part of this task.

" } } } }, "com.amazonaws.iot#DescribeAuditSuppression": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeAuditSuppressionRequest" }, "output": { "target": "com.amazonaws.iot#DescribeAuditSuppressionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Gets information about a Device Defender audit suppression.\n

", "smithy.api#http": { "method": "POST", "uri": "/audit/suppressions/describe", "code": 200 } } }, "com.amazonaws.iot#DescribeAuditSuppressionRequest": { "type": "structure", "members": { "checkName": { "target": "com.amazonaws.iot#AuditCheckName", "traits": { "smithy.api#required": {} } }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier", "traits": { "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeAuditSuppressionResponse": { "type": "structure", "members": { "checkName": { "target": "com.amazonaws.iot#AuditCheckName" }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier" }, "expirationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The epoch timestamp in seconds at which this suppression expires.\n

" } }, "suppressIndefinitely": { "target": "com.amazonaws.iot#SuppressIndefinitely", "traits": { "smithy.api#documentation": "

\n Indicates whether a suppression should exist indefinitely or not.\n

" } }, "description": { "target": "com.amazonaws.iot#AuditDescription", "traits": { "smithy.api#documentation": "

\n The description of the audit suppression.\n

" } } } }, "com.amazonaws.iot#DescribeAuditTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeAuditTaskRequest" }, "output": { "target": "com.amazonaws.iot#DescribeAuditTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets information about a Device Defender audit.

", "smithy.api#http": { "method": "GET", "uri": "/audit/tasks/{taskId}", "code": 200 } } }, "com.amazonaws.iot#DescribeAuditTaskRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { "smithy.api#documentation": "

The ID of the audit whose information you want to get.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeAuditTaskResponse": { "type": "structure", "members": { "taskStatus": { "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { "smithy.api#documentation": "

The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\",\n \"FAILED\", or \"CANCELED\".

" } }, "taskType": { "target": "com.amazonaws.iot#AuditTaskType", "traits": { "smithy.api#documentation": "

The type of audit: \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".

" } }, "taskStartTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time the audit started.

" } }, "taskStatistics": { "target": "com.amazonaws.iot#TaskStatistics", "traits": { "smithy.api#documentation": "

Statistical information about the audit.

" } }, "scheduledAuditName": { "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { "smithy.api#documentation": "

The name of the scheduled audit (only if the audit was a scheduled audit).

" } }, "auditDetails": { "target": "com.amazonaws.iot#AuditDetails", "traits": { "smithy.api#documentation": "

Detailed information about each check performed during this audit.

" } } } }, "com.amazonaws.iot#DescribeAuthorizer": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeAuthorizerRequest" }, "output": { "target": "com.amazonaws.iot#DescribeAuthorizerResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Describes an authorizer.

", "smithy.api#http": { "method": "GET", "uri": "/authorizer/{authorizerName}", "code": 200 } } }, "com.amazonaws.iot#DescribeAuthorizerRequest": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The name of the authorizer to describe.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeAuthorizerResponse": { "type": "structure", "members": { "authorizerDescription": { "target": "com.amazonaws.iot#AuthorizerDescription", "traits": { "smithy.api#documentation": "

The authorizer description.

" } } } }, "com.amazonaws.iot#DescribeBillingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeBillingGroupRequest" }, "output": { "target": "com.amazonaws.iot#DescribeBillingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Returns information about a billing group.

", "smithy.api#http": { "method": "GET", "uri": "/billing-groups/{billingGroupName}", "code": 200 } } }, "com.amazonaws.iot#DescribeBillingGroupRequest": { "type": "structure", "members": { "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name of the billing group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeBillingGroupResponse": { "type": "structure", "members": { "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name of the billing group.

" } }, "billingGroupId": { "target": "com.amazonaws.iot#BillingGroupId", "traits": { "smithy.api#documentation": "

The ID of the billing group.

" } }, "billingGroupArn": { "target": "com.amazonaws.iot#BillingGroupArn", "traits": { "smithy.api#documentation": "

The ARN of the billing group.

" } }, "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#documentation": "

The version of the billing group.

" } }, "billingGroupProperties": { "target": "com.amazonaws.iot#BillingGroupProperties", "traits": { "smithy.api#documentation": "

The properties of the billing group.

" } }, "billingGroupMetadata": { "target": "com.amazonaws.iot#BillingGroupMetadata", "traits": { "smithy.api#documentation": "

Additional information about the billing group.

" } } } }, "com.amazonaws.iot#DescribeCACertificate": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeCACertificateRequest" }, "output": { "target": "com.amazonaws.iot#DescribeCACertificateResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Describes a registered CA certificate.

", "smithy.api#http": { "method": "GET", "uri": "/cacertificate/{certificateId}", "code": 200 } } }, "com.amazonaws.iot#DescribeCACertificateRequest": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The CA certificate identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DescribeCACertificate operation.

" } }, "com.amazonaws.iot#DescribeCACertificateResponse": { "type": "structure", "members": { "certificateDescription": { "target": "com.amazonaws.iot#CACertificateDescription", "traits": { "smithy.api#documentation": "

The CA certificate description.

" } }, "registrationConfig": { "target": "com.amazonaws.iot#RegistrationConfig", "traits": { "smithy.api#documentation": "

Information about the registration configuration.

" } } }, "traits": { "smithy.api#documentation": "

The output from the DescribeCACertificate operation.

" } }, "com.amazonaws.iot#DescribeCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeCertificateRequest" }, "output": { "target": "com.amazonaws.iot#DescribeCertificateResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets information about the specified certificate.

", "smithy.api#http": { "method": "GET", "uri": "/certificates/{certificateId}", "code": 200 } } }, "com.amazonaws.iot#DescribeCertificateRequest": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DescribeCertificate operation.

" } }, "com.amazonaws.iot#DescribeCertificateResponse": { "type": "structure", "members": { "certificateDescription": { "target": "com.amazonaws.iot#CertificateDescription", "traits": { "smithy.api#documentation": "

The description of the certificate.

" } } }, "traits": { "smithy.api#documentation": "

The output of the DescribeCertificate operation.

" } }, "com.amazonaws.iot#DescribeCustomMetric": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeCustomMetricRequest" }, "output": { "target": "com.amazonaws.iot#DescribeCustomMetricResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Gets information about a Device Defender detect custom metric.\n

", "smithy.api#http": { "method": "GET", "uri": "/custom-metric/{metricName}", "code": 200 } } }, "com.amazonaws.iot#DescribeCustomMetricRequest": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { "smithy.api#documentation": "

\n The name of the custom metric.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeCustomMetricResponse": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { "smithy.api#documentation": "

\n The name of the custom metric.\n

" } }, "metricArn": { "target": "com.amazonaws.iot#CustomMetricArn", "traits": { "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the custom metric.\n

" } }, "metricType": { "target": "com.amazonaws.iot#CustomMetricType", "traits": { "smithy.api#documentation": "

\n The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.\n

" } }, "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { "smithy.api#documentation": "

\n Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.\n

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The creation date of the custom metric in milliseconds since epoch.\n

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The time the custom metric was last modified in milliseconds since epoch.\n

" } } } }, "com.amazonaws.iot#DescribeDefaultAuthorizer": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeDefaultAuthorizerRequest" }, "output": { "target": "com.amazonaws.iot#DescribeDefaultAuthorizerResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Describes the default authorizer.

", "smithy.api#http": { "method": "GET", "uri": "/default-authorizer", "code": 200 } } }, "com.amazonaws.iot#DescribeDefaultAuthorizerRequest": { "type": "structure", "members": {} }, "com.amazonaws.iot#DescribeDefaultAuthorizerResponse": { "type": "structure", "members": { "authorizerDescription": { "target": "com.amazonaws.iot#AuthorizerDescription", "traits": { "smithy.api#documentation": "

The default authorizer's description.

" } } } }, "com.amazonaws.iot#DescribeDetectMitigationActionsTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeDetectMitigationActionsTaskRequest" }, "output": { "target": "com.amazonaws.iot#DescribeDetectMitigationActionsTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Gets information about a Device Defender ML Detect mitigation action.\n

", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/tasks/{taskId}", "code": 200 } } }, "com.amazonaws.iot#DescribeDetectMitigationActionsTaskRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

\n The unique identifier of the task.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeDetectMitigationActionsTaskResponse": { "type": "structure", "members": { "taskSummary": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskSummary", "traits": { "smithy.api#documentation": "

\n The description of a task.\n

" } } } }, "com.amazonaws.iot#DescribeDimension": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeDimensionRequest" }, "output": { "target": "com.amazonaws.iot#DescribeDimensionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Provides details about a dimension that is defined in your AWS account.

", "smithy.api#http": { "method": "GET", "uri": "/dimensions/{name}", "code": 200 } } }, "com.amazonaws.iot#DescribeDimensionRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { "smithy.api#documentation": "

The unique identifier for the dimension.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeDimensionResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { "smithy.api#documentation": "

The unique identifier for the dimension.

" } }, "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name\n (ARN)\n for\n the dimension.

" } }, "type": { "target": "com.amazonaws.iot#DimensionType", "traits": { "smithy.api#documentation": "

The type of the dimension.

" } }, "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date the dimension was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date the dimension was last modified.

" } } } }, "com.amazonaws.iot#DescribeDomainConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeDomainConfigurationRequest" }, "output": { "target": "com.amazonaws.iot#DescribeDomainConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets summary information about a domain configuration.

", "smithy.api#http": { "method": "GET", "uri": "/domainConfigurations/{domainConfigurationName}", "code": 200 } } }, "com.amazonaws.iot#DescribeDomainConfigurationRequest": { "type": "structure", "members": { "domainConfigurationName": { "target": "com.amazonaws.iot#ReservedDomainConfigurationName", "traits": { "smithy.api#documentation": "

The name of the domain configuration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeDomainConfigurationResponse": { "type": "structure", "members": { "domainConfigurationName": { "target": "com.amazonaws.iot#ReservedDomainConfigurationName", "traits": { "smithy.api#documentation": "

The name of the domain configuration.

" } }, "domainConfigurationArn": { "target": "com.amazonaws.iot#DomainConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of the domain configuration.

" } }, "domainName": { "target": "com.amazonaws.iot#DomainName", "traits": { "smithy.api#documentation": "

The name of the domain.

" } }, "serverCertificates": { "target": "com.amazonaws.iot#ServerCertificates", "traits": { "smithy.api#documentation": "

A list containing summary information about the server certificate included in the domain configuration.

" } }, "authorizerConfig": { "target": "com.amazonaws.iot#AuthorizerConfig", "traits": { "smithy.api#documentation": "

An object that specifies the authorization service for a domain.

" } }, "domainConfigurationStatus": { "target": "com.amazonaws.iot#DomainConfigurationStatus", "traits": { "smithy.api#documentation": "

A Boolean value that specifies the current state of the domain configuration.

" } }, "serviceType": { "target": "com.amazonaws.iot#ServiceType", "traits": { "smithy.api#documentation": "

The type of service delivered by the endpoint.

" } }, "domainType": { "target": "com.amazonaws.iot#DomainType", "traits": { "smithy.api#documentation": "

The type of the domain.

" } }, "lastStatusChangeDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date and time the domain configuration's status was last changed.

" } } } }, "com.amazonaws.iot#DescribeEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeEndpointRequest" }, "output": { "target": "com.amazonaws.iot#DescribeEndpointResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns a unique endpoint specific to the AWS account making the call.

", "smithy.api#http": { "method": "GET", "uri": "/endpoint", "code": 200 } } }, "com.amazonaws.iot#DescribeEndpointRequest": { "type": "structure", "members": { "endpointType": { "target": "com.amazonaws.iot#EndpointType", "traits": { "smithy.api#documentation": "

The endpoint type. Valid endpoint types include:

\n \n \n \n \n

We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid \n issues related to the widespread distrust of Symantec certificate authorities.

", "smithy.api#httpQuery": "endpointType" } } }, "traits": { "smithy.api#documentation": "

The input for the DescribeEndpoint operation.

" } }, "com.amazonaws.iot#DescribeEndpointResponse": { "type": "structure", "members": { "endpointAddress": { "target": "com.amazonaws.iot#EndpointAddress", "traits": { "smithy.api#documentation": "

The endpoint. The format of the endpoint is as follows:\n identifier.iot.region.amazonaws.com.

" } } }, "traits": { "smithy.api#documentation": "

The output from the DescribeEndpoint operation.

" } }, "com.amazonaws.iot#DescribeEventConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeEventConfigurationsRequest" }, "output": { "target": "com.amazonaws.iot#DescribeEventConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Describes event configurations.

", "smithy.api#http": { "method": "GET", "uri": "/event-configurations", "code": 200 } } }, "com.amazonaws.iot#DescribeEventConfigurationsRequest": { "type": "structure", "members": {} }, "com.amazonaws.iot#DescribeEventConfigurationsResponse": { "type": "structure", "members": { "eventConfigurations": { "target": "com.amazonaws.iot#EventConfigurations", "traits": { "smithy.api#documentation": "

The event configurations.

" } }, "creationDate": { "target": "com.amazonaws.iot#CreationDate", "traits": { "smithy.api#documentation": "

The creation date of the event configuration.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#LastModifiedDate", "traits": { "smithy.api#documentation": "

The date the event configurations were last modified.

" } } } }, "com.amazonaws.iot#DescribeIndex": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeIndexRequest" }, "output": { "target": "com.amazonaws.iot#DescribeIndexResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Describes a search index.

", "smithy.api#http": { "method": "GET", "uri": "/indices/{indexName}", "code": 200 } } }, "com.amazonaws.iot#DescribeIndexRequest": { "type": "structure", "members": { "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The index name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeIndexResponse": { "type": "structure", "members": { "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The index name.

" } }, "indexStatus": { "target": "com.amazonaws.iot#IndexStatus", "traits": { "smithy.api#documentation": "

The index status.

" } }, "schema": { "target": "com.amazonaws.iot#IndexSchema", "traits": { "smithy.api#documentation": "

Contains a value that specifies the type of indexing performed. Valid values\n are:

\n " } } } }, "com.amazonaws.iot#DescribeJob": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeJobRequest" }, "output": { "target": "com.amazonaws.iot#DescribeJobResponse" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Describes a job.

", "smithy.api#http": { "method": "GET", "uri": "/jobs/{jobId}", "code": 200 } } }, "com.amazonaws.iot#DescribeJobExecution": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeJobExecutionRequest" }, "output": { "target": "com.amazonaws.iot#DescribeJobExecutionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Describes a job execution.

", "smithy.api#http": { "method": "GET", "uri": "/things/{thingName}/jobs/{jobId}", "code": 200 } } }, "com.amazonaws.iot#DescribeJobExecutionRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing on which the job execution is running.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "executionNumber": { "target": "com.amazonaws.iot#ExecutionNumber", "traits": { "smithy.api#documentation": "

A string (consisting of the digits \"0\" through \"9\" which is used to specify a particular job execution\n on a particular device.

", "smithy.api#httpQuery": "executionNumber" } } } }, "com.amazonaws.iot#DescribeJobExecutionResponse": { "type": "structure", "members": { "execution": { "target": "com.amazonaws.iot#JobExecution", "traits": { "smithy.api#documentation": "

Information about the job execution.

" } } } }, "com.amazonaws.iot#DescribeJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeJobResponse": { "type": "structure", "members": { "documentSource": { "target": "com.amazonaws.iot#JobDocumentSource", "traits": { "smithy.api#documentation": "

An S3 link to the job document.

" } }, "job": { "target": "com.amazonaws.iot#Job", "traits": { "smithy.api#documentation": "

Information about the job.

" } } } }, "com.amazonaws.iot#DescribeJobTemplate": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeJobTemplateRequest" }, "output": { "target": "com.amazonaws.iot#DescribeJobTemplateResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Returns information about a job template.

", "smithy.api#http": { "method": "GET", "uri": "/job-templates/{jobTemplateId}", "code": 200 } } }, "com.amazonaws.iot#DescribeJobTemplateRequest": { "type": "structure", "members": { "jobTemplateId": { "target": "com.amazonaws.iot#JobTemplateId", "traits": { "smithy.api#documentation": "

The unique identifier of the job template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeJobTemplateResponse": { "type": "structure", "members": { "jobTemplateArn": { "target": "com.amazonaws.iot#JobTemplateArn", "traits": { "smithy.api#documentation": "

The ARN of the job template.

" } }, "jobTemplateId": { "target": "com.amazonaws.iot#JobTemplateId", "traits": { "smithy.api#documentation": "

The unique identifier of the job template.

" } }, "description": { "target": "com.amazonaws.iot#JobDescription", "traits": { "smithy.api#documentation": "

A description of the job template.

" } }, "documentSource": { "target": "com.amazonaws.iot#JobDocumentSource", "traits": { "smithy.api#documentation": "

An S3 link to the job document.

" } }, "document": { "target": "com.amazonaws.iot#JobDocument", "traits": { "smithy.api#documentation": "

The job document.

" } }, "createdAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job template was created.

" } }, "presignedUrlConfig": { "target": "com.amazonaws.iot#PresignedUrlConfig" }, "jobExecutionsRolloutConfig": { "target": "com.amazonaws.iot#JobExecutionsRolloutConfig" }, "abortConfig": { "target": "com.amazonaws.iot#AbortConfig" }, "timeoutConfig": { "target": "com.amazonaws.iot#TimeoutConfig" } } }, "com.amazonaws.iot#DescribeMitigationAction": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeMitigationActionRequest" }, "output": { "target": "com.amazonaws.iot#DescribeMitigationActionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets information about a mitigation action.

", "smithy.api#http": { "method": "GET", "uri": "/mitigationactions/actions/{actionName}", "code": 200 } } }, "com.amazonaws.iot#DescribeMitigationActionRequest": { "type": "structure", "members": { "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { "smithy.api#documentation": "

The friendly name that uniquely identifies the mitigation action.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeMitigationActionResponse": { "type": "structure", "members": { "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { "smithy.api#documentation": "

The friendly name that uniquely identifies the mitigation action.

" } }, "actionType": { "target": "com.amazonaws.iot#MitigationActionType", "traits": { "smithy.api#documentation": "

The type of mitigation action.

" } }, "actionArn": { "target": "com.amazonaws.iot#MitigationActionArn", "traits": { "smithy.api#documentation": "

The ARN that identifies this migration action.

" } }, "actionId": { "target": "com.amazonaws.iot#MitigationActionId", "traits": { "smithy.api#documentation": "

A unique identifier for this action.

" } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role used to apply this action.

" } }, "actionParams": { "target": "com.amazonaws.iot#MitigationActionParams", "traits": { "smithy.api#documentation": "

Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the mitigation action was added to your AWS account.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the mitigation action was last changed.

" } } } }, "com.amazonaws.iot#DescribeProvisioningTemplate": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeProvisioningTemplateRequest" }, "output": { "target": "com.amazonaws.iot#DescribeProvisioningTemplateResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a fleet provisioning template.

", "smithy.api#http": { "method": "GET", "uri": "/provisioning-templates/{templateName}", "code": 200 } } }, "com.amazonaws.iot#DescribeProvisioningTemplateRequest": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provisioning template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeProvisioningTemplateResponse": { "type": "structure", "members": { "templateArn": { "target": "com.amazonaws.iot#TemplateArn", "traits": { "smithy.api#documentation": "

The ARN of the fleet provisioning template.

" } }, "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provisioning template.

" } }, "description": { "target": "com.amazonaws.iot#TemplateDescription", "traits": { "smithy.api#documentation": "

The description of the fleet provisioning template.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the fleet provisioning template was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the fleet provisioning template was last modified.

" } }, "defaultVersionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { "smithy.api#documentation": "

The default fleet template version ID.

" } }, "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template.

" } }, "enabled": { "target": "com.amazonaws.iot#Enabled", "traits": { "smithy.api#documentation": "

True if the fleet provisioning template is enabled, otherwise false.

" } }, "provisioningRoleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the role associated with the provisioning template. This IoT role grants\n permission to provision a device.

" } }, "preProvisioningHook": { "target": "com.amazonaws.iot#ProvisioningHook", "traits": { "smithy.api#documentation": "

Gets information about a pre-provisioned hook.

" } } } }, "com.amazonaws.iot#DescribeProvisioningTemplateVersion": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeProvisioningTemplateVersionRequest" }, "output": { "target": "com.amazonaws.iot#DescribeProvisioningTemplateVersionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns information about a fleet provisioning template version.

", "smithy.api#http": { "method": "GET", "uri": "/provisioning-templates/{templateName}/versions/{versionId}", "code": 200 } } }, "com.amazonaws.iot#DescribeProvisioningTemplateVersionRequest": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The template name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "versionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { "smithy.api#documentation": "

The fleet provisioning template version ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeProvisioningTemplateVersionResponse": { "type": "structure", "members": { "versionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { "smithy.api#documentation": "

The fleet provisioning template version ID.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the fleet provisioning template version was created.

" } }, "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { "smithy.api#documentation": "

The JSON formatted contents of the fleet provisioning template version.

" } }, "isDefaultVersion": { "target": "com.amazonaws.iot#IsDefaultVersion", "traits": { "smithy.api#documentation": "

True if the fleet provisioning template version is the default version.

" } } } }, "com.amazonaws.iot#DescribeRoleAlias": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeRoleAliasRequest" }, "output": { "target": "com.amazonaws.iot#DescribeRoleAliasResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Describes a role alias.

", "smithy.api#http": { "method": "GET", "uri": "/role-aliases/{roleAlias}", "code": 200 } } }, "com.amazonaws.iot#DescribeRoleAliasRequest": { "type": "structure", "members": { "roleAlias": { "target": "com.amazonaws.iot#RoleAlias", "traits": { "smithy.api#documentation": "

The role alias to describe.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeRoleAliasResponse": { "type": "structure", "members": { "roleAliasDescription": { "target": "com.amazonaws.iot#RoleAliasDescription", "traits": { "smithy.api#documentation": "

The role alias description.

" } } } }, "com.amazonaws.iot#DescribeScheduledAudit": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeScheduledAuditRequest" }, "output": { "target": "com.amazonaws.iot#DescribeScheduledAuditResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets information about a scheduled audit.

", "smithy.api#http": { "method": "GET", "uri": "/audit/scheduledaudits/{scheduledAuditName}", "code": 200 } } }, "com.amazonaws.iot#DescribeScheduledAuditRequest": { "type": "structure", "members": { "scheduledAuditName": { "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { "smithy.api#documentation": "

The name of the scheduled audit whose information you want to get.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeScheduledAuditResponse": { "type": "structure", "members": { "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { "smithy.api#documentation": "

How often the scheduled audit takes\n place, either\n one of DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the\n system.

" } }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place.\n This is\n will be 1\n through 31 or LAST. If days\n 29-31\n are specified, and the month does not have that many days, the audit takes place on the LAST\n day of the month.

" } }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { "smithy.api#documentation": "

The day of the week on which the scheduled audit takes\n place,\n either one of\n SUN, MON, TUE, WED, THU, FRI, or SAT.

" } }, "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be \n enabled for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

" } }, "scheduledAuditName": { "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { "smithy.api#documentation": "

The name of the scheduled audit.

" } }, "scheduledAuditArn": { "target": "com.amazonaws.iot#ScheduledAuditArn", "traits": { "smithy.api#documentation": "

The ARN of the scheduled audit.

" } } } }, "com.amazonaws.iot#DescribeSecurityProfile": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeSecurityProfileRequest" }, "output": { "target": "com.amazonaws.iot#DescribeSecurityProfileResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets information about a Device Defender security profile.

", "smithy.api#http": { "method": "GET", "uri": "/security-profiles/{securityProfileName}", "code": 200 } } }, "com.amazonaws.iot#DescribeSecurityProfileRequest": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name of the security profile\n whose information you want to get.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeSecurityProfileResponse": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name of the security profile.

" } }, "securityProfileArn": { "target": "com.amazonaws.iot#SecurityProfileArn", "traits": { "smithy.api#documentation": "

The ARN of the security profile.

" } }, "securityProfileDescription": { "target": "com.amazonaws.iot#SecurityProfileDescription", "traits": { "smithy.api#documentation": "

A description of the security profile (associated with the security profile\n when it was created or updated).

" } }, "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, "alertTargets": { "target": "com.amazonaws.iot#AlertTargets", "traits": { "smithy.api#documentation": "

Where the alerts are sent. (Alerts are always sent to the console.)

" } }, "additionalMetricsToRetain": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainList", "traits": { "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, "smithy.api#documentation": "

\n Please use\n DescribeSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the profile's behaviors, but\n it is\n also retained for any metric specified here.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any\n metric used in the profile's behaviors, but\n it is\n also retained for any metric specified here.

" } }, "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#documentation": "

The version of the security profile. A new version is generated whenever the\n security profile is updated.

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time the security profile was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time the security profile was last modified.

" } } } }, "com.amazonaws.iot#DescribeStream": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeStreamRequest" }, "output": { "target": "com.amazonaws.iot#DescribeStreamResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets information about a stream.

", "smithy.api#http": { "method": "GET", "uri": "/streams/{streamId}", "code": 200 } } }, "com.amazonaws.iot#DescribeStreamRequest": { "type": "structure", "members": { "streamId": { "target": "com.amazonaws.iot#StreamId", "traits": { "smithy.api#documentation": "

The stream ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeStreamResponse": { "type": "structure", "members": { "streamInfo": { "target": "com.amazonaws.iot#StreamInfo", "traits": { "smithy.api#documentation": "

Information about the stream.

" } } } }, "com.amazonaws.iot#DescribeThing": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeThingRequest" }, "output": { "target": "com.amazonaws.iot#DescribeThingResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets information about the specified thing.

", "smithy.api#http": { "method": "GET", "uri": "/things/{thingName}", "code": 200 } } }, "com.amazonaws.iot#DescribeThingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeThingGroupRequest" }, "output": { "target": "com.amazonaws.iot#DescribeThingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Describe a thing group.

", "smithy.api#http": { "method": "GET", "uri": "/thing-groups/{thingGroupName}", "code": 200 } } }, "com.amazonaws.iot#DescribeThingGroupRequest": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The name of the thing group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeThingGroupResponse": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The name of the thing group.

" } }, "thingGroupId": { "target": "com.amazonaws.iot#ThingGroupId", "traits": { "smithy.api#documentation": "

The thing group ID.

" } }, "thingGroupArn": { "target": "com.amazonaws.iot#ThingGroupArn", "traits": { "smithy.api#documentation": "

The thing group ARN.

" } }, "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#documentation": "

The version of the thing group.

" } }, "thingGroupProperties": { "target": "com.amazonaws.iot#ThingGroupProperties", "traits": { "smithy.api#documentation": "

The thing group properties.

" } }, "thingGroupMetadata": { "target": "com.amazonaws.iot#ThingGroupMetadata", "traits": { "smithy.api#documentation": "

Thing group metadata.

" } }, "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The dynamic thing group index name.

" } }, "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { "smithy.api#documentation": "

The dynamic thing group search query string.

" } }, "queryVersion": { "target": "com.amazonaws.iot#QueryVersion", "traits": { "smithy.api#documentation": "

The dynamic thing group query version.

" } }, "status": { "target": "com.amazonaws.iot#DynamicGroupStatus", "traits": { "smithy.api#documentation": "

The dynamic thing group status.

" } } } }, "com.amazonaws.iot#DescribeThingRegistrationTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeThingRegistrationTaskRequest" }, "output": { "target": "com.amazonaws.iot#DescribeThingRegistrationTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Describes a bulk thing provisioning task.

", "smithy.api#http": { "method": "GET", "uri": "/thing-registration-tasks/{taskId}", "code": 200 } } }, "com.amazonaws.iot#DescribeThingRegistrationTaskRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#TaskId", "traits": { "smithy.api#documentation": "

The task ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#DescribeThingRegistrationTaskResponse": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#TaskId", "traits": { "smithy.api#documentation": "

The task ID.

" } }, "creationDate": { "target": "com.amazonaws.iot#CreationDate", "traits": { "smithy.api#documentation": "

The task creation date.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#LastModifiedDate", "traits": { "smithy.api#documentation": "

The date when the task was last modified.

" } }, "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { "smithy.api#documentation": "

The task's template.

" } }, "inputFileBucket": { "target": "com.amazonaws.iot#RegistryS3BucketName", "traits": { "smithy.api#documentation": "

The S3 bucket that contains the input file.

" } }, "inputFileKey": { "target": "com.amazonaws.iot#RegistryS3KeyName", "traits": { "smithy.api#documentation": "

The input file key.

" } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The role ARN that grants access to the input file bucket.

" } }, "status": { "target": "com.amazonaws.iot#Status", "traits": { "smithy.api#documentation": "

The status of the bulk thing provisioning task.

" } }, "message": { "target": "com.amazonaws.iot#ErrorMessage", "traits": { "smithy.api#documentation": "

The message.

" } }, "successCount": { "target": "com.amazonaws.iot#Count", "traits": { "smithy.api#documentation": "

The number of things successfully provisioned.

" } }, "failureCount": { "target": "com.amazonaws.iot#Count", "traits": { "smithy.api#documentation": "

The number of things that failed to be provisioned.

" } }, "percentageProgress": { "target": "com.amazonaws.iot#Percentage", "traits": { "smithy.api#documentation": "

The progress of the bulk provisioning task expressed as a percentage.

" } } } }, "com.amazonaws.iot#DescribeThingRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DescribeThing operation.

" } }, "com.amazonaws.iot#DescribeThingResponse": { "type": "structure", "members": { "defaultClientId": { "target": "com.amazonaws.iot#ClientId", "traits": { "smithy.api#documentation": "

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. \n\t\t\tAlthough we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or \n\t\t\tshadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

\n\t\t

This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

" } }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing.

" } }, "thingId": { "target": "com.amazonaws.iot#ThingId", "traits": { "smithy.api#documentation": "

The ID of the thing to describe.

" } }, "thingArn": { "target": "com.amazonaws.iot#ThingArn", "traits": { "smithy.api#documentation": "

The ARN of the thing to describe.

" } }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The thing type name.

" } }, "attributes": { "target": "com.amazonaws.iot#Attributes", "traits": { "smithy.api#documentation": "

The thing attributes.

" } }, "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#documentation": "

The current version of the thing record in the registry.

\n\t\t \n\t\t\t

To avoid unintentional changes to the information in the registry, you can pass\n\t\t\t\tthe version information in the expectedVersion parameter of the\n\t\t\t\t\tUpdateThing and DeleteThing calls.

\n\t\t
" } }, "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name of the billing group the thing belongs to.

" } } }, "traits": { "smithy.api#documentation": "

The output from the DescribeThing operation.

" } }, "com.amazonaws.iot#DescribeThingType": { "type": "operation", "input": { "target": "com.amazonaws.iot#DescribeThingTypeRequest" }, "output": { "target": "com.amazonaws.iot#DescribeThingTypeResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets information about the specified thing type.

", "smithy.api#http": { "method": "GET", "uri": "/thing-types/{thingTypeName}", "code": 200 } } }, "com.amazonaws.iot#DescribeThingTypeRequest": { "type": "structure", "members": { "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DescribeThingType operation.

" } }, "com.amazonaws.iot#DescribeThingTypeResponse": { "type": "structure", "members": { "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type.

" } }, "thingTypeId": { "target": "com.amazonaws.iot#ThingTypeId", "traits": { "smithy.api#documentation": "

The thing type ID.

" } }, "thingTypeArn": { "target": "com.amazonaws.iot#ThingTypeArn", "traits": { "smithy.api#documentation": "

The thing type ARN.

" } }, "thingTypeProperties": { "target": "com.amazonaws.iot#ThingTypeProperties", "traits": { "smithy.api#documentation": "

The ThingTypeProperties contains information about the thing type including\n\t\t\tdescription, and a list of searchable thing attribute names.

" } }, "thingTypeMetadata": { "target": "com.amazonaws.iot#ThingTypeMetadata", "traits": { "smithy.api#documentation": "

The ThingTypeMetadata contains additional information about the thing type\n\t\t\tincluding: creation date and time, a value indicating whether the thing type is\n\t\t\tdeprecated, and a date and time when it was deprecated.

" } } }, "traits": { "smithy.api#documentation": "

The output for the DescribeThingType operation.

" } }, "com.amazonaws.iot#Description": { "type": "string" }, "com.amazonaws.iot#Destination": { "type": "structure", "members": { "s3Destination": { "target": "com.amazonaws.iot#S3Destination", "traits": { "smithy.api#documentation": "

Describes the location in S3 of the updated firmware.

" } } }, "traits": { "smithy.api#documentation": "

Describes the location of the updated firmware.

" } }, "com.amazonaws.iot#DetachPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iot#DetachPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Detaches a policy from the specified target.

", "smithy.api#http": { "method": "POST", "uri": "/target-policies/{policyName}", "code": 200 } } }, "com.amazonaws.iot#DetachPolicyRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy to detach.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.iot#PolicyTarget", "traits": { "smithy.api#documentation": "

The target from which the policy will be detached.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#DetachPrincipalPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iot#DetachPrincipalPolicyRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

Removes the specified policy from the specified certificate.

\n

\n Note: This API is deprecated. Please use DetachPolicy instead.

", "smithy.api#http": { "method": "DELETE", "uri": "/principal-policies/{policyName}", "code": 200 } } }, "com.amazonaws.iot#DetachPrincipalPolicyRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The name of the policy to detach.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "principal": { "target": "com.amazonaws.iot#Principal", "traits": { "smithy.api#documentation": "

The principal.

\n

Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

", "smithy.api#httpHeader": "x-amzn-iot-principal", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DetachPrincipalPolicy operation.

" } }, "com.amazonaws.iot#DetachSecurityProfile": { "type": "operation", "input": { "target": "com.amazonaws.iot#DetachSecurityProfileRequest" }, "output": { "target": "com.amazonaws.iot#DetachSecurityProfileResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Disassociates a Device Defender security profile from a thing group or from this account.

", "smithy.api#http": { "method": "DELETE", "uri": "/security-profiles/{securityProfileName}/targets", "code": 200 } } }, "com.amazonaws.iot#DetachSecurityProfileRequest": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The security profile that is detached.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "securityProfileTargetArn": { "target": "com.amazonaws.iot#SecurityProfileTargetArn", "traits": { "smithy.api#documentation": "

The ARN of the thing group from which the security profile is detached.

", "smithy.api#httpQuery": "securityProfileTargetArn", "smithy.api#required": {} } } } }, "com.amazonaws.iot#DetachSecurityProfileResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#DetachThingPrincipal": { "type": "operation", "input": { "target": "com.amazonaws.iot#DetachThingPrincipalRequest" }, "output": { "target": "com.amazonaws.iot#DetachThingPrincipalResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Detaches the specified principal from the specified thing. A principal can be X.509\n\t\t\tcertificates, IAM users, groups, and roles, Amazon Cognito identities or federated\n\t\t\tidentities.

\n\t\t \n\t\t\t

This call is asynchronous. It might take several seconds for the detachment to\n\t\t\t\tpropagate.

\n\t\t
", "smithy.api#http": { "method": "DELETE", "uri": "/things/{thingName}/principals", "code": 200 } } }, "com.amazonaws.iot#DetachThingPrincipalRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "principal": { "target": "com.amazonaws.iot#Principal", "traits": { "smithy.api#documentation": "

If the principal is a certificate, this value must be ARN of the certificate. If\n\t\t\tthe principal is an Amazon Cognito identity, this value must be the ID of the Amazon\n\t\t\tCognito identity.

", "smithy.api#httpHeader": "x-amzn-principal", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DetachThingPrincipal operation.

" } }, "com.amazonaws.iot#DetachThingPrincipalResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The output from the DetachThingPrincipal operation.

" } }, "com.amazonaws.iot#DetailsKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#DetailsMap": { "type": "map", "key": { "target": "com.amazonaws.iot#DetailsKey" }, "value": { "target": "com.amazonaws.iot#DetailsValue" } }, "com.amazonaws.iot#DetailsValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "[^\\p{C}]+" } }, "com.amazonaws.iot#DetectMitigationActionExecution": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

\n The unique identifier of the task.\n

" } }, "violationId": { "target": "com.amazonaws.iot#ViolationId", "traits": { "smithy.api#documentation": "

\n The unique identifier of the violation.\n

" } }, "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { "smithy.api#documentation": "

\n The friendly name that uniquely identifies the mitigation action.\n

" } }, "thingName": { "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { "smithy.api#documentation": "

\n The name of the thing.\n

" } }, "executionStartDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The date a mitigation action was started.\n

" } }, "executionEndDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The date a mitigation action ended.\n

" } }, "status": { "target": "com.amazonaws.iot#DetectMitigationActionExecutionStatus", "traits": { "smithy.api#documentation": "

\n The status of a mitigation action.\n

" } }, "errorCode": { "target": "com.amazonaws.iot#DetectMitigationActionExecutionErrorCode", "traits": { "smithy.api#documentation": "

\n The error code of a mitigation action.\n

" } }, "message": { "target": "com.amazonaws.iot#ErrorMessage", "traits": { "smithy.api#documentation": "

\n The message of a mitigation action.\n

" } } }, "traits": { "smithy.api#documentation": "

\n Describes which mitigation actions should be executed.\n

" } }, "com.amazonaws.iot#DetectMitigationActionExecutionErrorCode": { "type": "string" }, "com.amazonaws.iot#DetectMitigationActionExecutionList": { "type": "list", "member": { "target": "com.amazonaws.iot#DetectMitigationActionExecution" } }, "com.amazonaws.iot#DetectMitigationActionExecutionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "SUCCESSFUL", "name": "SUCCESSFUL" }, { "value": "FAILED", "name": "FAILED" }, { "value": "SKIPPED", "name": "SKIPPED" } ] } }, "com.amazonaws.iot#DetectMitigationActionsTaskStatistics": { "type": "structure", "members": { "actionsExecuted": { "target": "com.amazonaws.iot#GenericLongValue", "traits": { "smithy.api#documentation": "

\n The actions that were performed.\n

" } }, "actionsSkipped": { "target": "com.amazonaws.iot#GenericLongValue", "traits": { "smithy.api#documentation": "

\n The actions that were skipped.\n

" } }, "actionsFailed": { "target": "com.amazonaws.iot#GenericLongValue", "traits": { "smithy.api#documentation": "

\n The actions that failed.\n

" } } }, "traits": { "smithy.api#documentation": "

\n The statistics of a mitigation action task.\n

" } }, "com.amazonaws.iot#DetectMitigationActionsTaskStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "SUCCESSFUL", "name": "SUCCESSFUL" }, { "value": "FAILED", "name": "FAILED" }, { "value": "CANCELED", "name": "CANCELED" } ] } }, "com.amazonaws.iot#DetectMitigationActionsTaskSummary": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

\n The unique identifier of the task.\n

" } }, "taskStatus": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskStatus", "traits": { "smithy.api#documentation": "

\n The status of the task.\n

" } }, "taskStartTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The date the task started.\n

" } }, "taskEndTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The date the task ended.\n

" } }, "target": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskTarget", "traits": { "smithy.api#documentation": "

\n Specifies the ML Detect findings to which the mitigation actions are applied.\n

" } }, "violationEventOccurrenceRange": { "target": "com.amazonaws.iot#ViolationEventOccurrenceRange", "traits": { "smithy.api#documentation": "

\n Specifies the time period of which violation events occurred between.\n

" } }, "onlyActiveViolationsIncluded": { "target": "com.amazonaws.iot#PrimitiveBoolean", "traits": { "smithy.api#documentation": "

\n Includes only active violations.\n

" } }, "suppressedAlertsIncluded": { "target": "com.amazonaws.iot#PrimitiveBoolean", "traits": { "smithy.api#documentation": "

\n Includes suppressed alerts.\n

" } }, "actionsDefinition": { "target": "com.amazonaws.iot#MitigationActionList", "traits": { "smithy.api#documentation": "

\n The definition of the actions.\n

" } }, "taskStatistics": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskStatistics", "traits": { "smithy.api#documentation": "

\n The statistics of a mitigation action task.\n

" } } }, "traits": { "smithy.api#documentation": "

\n The summary of the mitigation action tasks.\n

" } }, "com.amazonaws.iot#DetectMitigationActionsTaskSummaryList": { "type": "list", "member": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskSummary" } }, "com.amazonaws.iot#DetectMitigationActionsTaskTarget": { "type": "structure", "members": { "violationIds": { "target": "com.amazonaws.iot#TargetViolationIdsForDetectMitigationActions", "traits": { "smithy.api#documentation": "

\n The unique identifiers of the violations.\n

" } }, "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

\n The name of the security profile.\n

" } }, "behaviorName": { "target": "com.amazonaws.iot#BehaviorName", "traits": { "smithy.api#documentation": "

\n The name of the behavior.\n

" } } }, "traits": { "smithy.api#documentation": "

\n The target of a mitigation action task.\n

" } }, "com.amazonaws.iot#DetectMitigationActionsToExecuteList": { "type": "list", "member": { "target": "com.amazonaws.iot#MitigationActionName" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.iot#DeviceCertificateUpdateAction": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DEACTIVATE", "name": "DEACTIVATE" } ] } }, "com.amazonaws.iot#DeviceDefenderThingName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.iot#DimensionArn": { "type": "string" }, "com.amazonaws.iot#DimensionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#DimensionNames": { "type": "list", "member": { "target": "com.amazonaws.iot#DimensionName" } }, "com.amazonaws.iot#DimensionStringValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.iot#DimensionStringValues": { "type": "list", "member": { "target": "com.amazonaws.iot#DimensionStringValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.iot#DimensionType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "TOPIC_FILTER", "name": "TOPIC_FILTER" } ] } }, "com.amazonaws.iot#DimensionValueOperator": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN", "name": "IN" }, { "value": "NOT_IN", "name": "NOT_IN" } ] } }, "com.amazonaws.iot#DisableAllLogs": { "type": "boolean" }, "com.amazonaws.iot#DisableTopicRule": { "type": "operation", "input": { "target": "com.amazonaws.iot#DisableTopicRuleRequest" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Disables the rule.

", "smithy.api#http": { "method": "POST", "uri": "/rules/{ruleName}/disable", "code": 200 } } }, "com.amazonaws.iot#DisableTopicRuleRequest": { "type": "structure", "members": { "ruleName": { "target": "com.amazonaws.iot#RuleName", "traits": { "smithy.api#documentation": "

The name of the rule to disable.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DisableTopicRuleRequest operation.

" } }, "com.amazonaws.iot#DomainConfigurationArn": { "type": "string" }, "com.amazonaws.iot#DomainConfigurationName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[\\w.-]+" } }, "com.amazonaws.iot#DomainConfigurationStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENABLED", "name": "ENABLED" }, { "value": "DISABLED", "name": "DISABLED" } ] } }, "com.amazonaws.iot#DomainConfigurationSummary": { "type": "structure", "members": { "domainConfigurationName": { "target": "com.amazonaws.iot#ReservedDomainConfigurationName", "traits": { "smithy.api#documentation": "

The name of the domain configuration. This value must be unique to a region.

" } }, "domainConfigurationArn": { "target": "com.amazonaws.iot#DomainConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of the domain configuration.

" } }, "serviceType": { "target": "com.amazonaws.iot#ServiceType", "traits": { "smithy.api#documentation": "

The type of service delivered by the endpoint.

" } } }, "traits": { "smithy.api#documentation": "

The summary of a domain configuration. A domain configuration specifies custom IoT-specific information about a domain. \n A domain configuration can be associated with an AWS-managed domain \n (for example, dbc123defghijk.iot.us-west-2.amazonaws.com), a customer managed domain, or a default endpoint.

\n " } }, "com.amazonaws.iot#DomainConfigurations": { "type": "list", "member": { "target": "com.amazonaws.iot#DomainConfigurationSummary" } }, "com.amazonaws.iot#DomainName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 253 } } }, "com.amazonaws.iot#DomainType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENDPOINT", "name": "ENDPOINT" }, { "value": "AWS_MANAGED", "name": "AWS_MANAGED" }, { "value": "CUSTOMER_MANAGED", "name": "CUSTOMER_MANAGED" } ] } }, "com.amazonaws.iot#DurationSeconds": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#DynamicGroupStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "BUILDING", "name": "BUILDING" }, { "value": "REBUILDING", "name": "REBUILDING" } ] } }, "com.amazonaws.iot#DynamoDBAction": { "type": "structure", "members": { "tableName": { "target": "com.amazonaws.iot#TableName", "traits": { "smithy.api#documentation": "

The name of the DynamoDB table.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants access to the DynamoDB table.

", "smithy.api#required": {} } }, "operation": { "target": "com.amazonaws.iot#DynamoOperation", "traits": { "smithy.api#documentation": "

The type of operation to be performed. This follows the substitution template, so it\n can be ${operation}, but the substitution must result in one of the following:\n INSERT, UPDATE, or DELETE.

" } }, "hashKeyField": { "target": "com.amazonaws.iot#HashKeyField", "traits": { "smithy.api#documentation": "

The hash key name.

", "smithy.api#required": {} } }, "hashKeyValue": { "target": "com.amazonaws.iot#HashKeyValue", "traits": { "smithy.api#documentation": "

The hash key value.

", "smithy.api#required": {} } }, "hashKeyType": { "target": "com.amazonaws.iot#DynamoKeyType", "traits": { "smithy.api#documentation": "

The hash key type. Valid values are \"STRING\" or \"NUMBER\"

" } }, "rangeKeyField": { "target": "com.amazonaws.iot#RangeKeyField", "traits": { "smithy.api#documentation": "

The range key name.

" } }, "rangeKeyValue": { "target": "com.amazonaws.iot#RangeKeyValue", "traits": { "smithy.api#documentation": "

The range key value.

" } }, "rangeKeyType": { "target": "com.amazonaws.iot#DynamoKeyType", "traits": { "smithy.api#documentation": "

The range key type. Valid values are \"STRING\" or \"NUMBER\"

" } }, "payloadField": { "target": "com.amazonaws.iot#PayloadField", "traits": { "smithy.api#documentation": "

The action payload. This name can be customized.

" } } }, "traits": { "smithy.api#documentation": "

Describes an action to write to a DynamoDB table.

\n

The tableName, hashKeyField, and rangeKeyField\n values must match the values used when you created the table.

\n

The hashKeyValue and rangeKeyvalue fields use a\n substitution template syntax. These templates provide data at runtime. The syntax is as\n follows: ${sql-expression}.

\n

You can specify any valid expression in a WHERE or SELECT clause, including JSON\n properties, comparisons, calculations, and functions. For example, the following field uses\n the third level of the topic:

\n

\n \"hashKeyValue\": \"${topic(3)}\"\n

\n

The following field uses the timestamp:

\n

\n \"rangeKeyValue\": \"${timestamp()}\"\n

" } }, "com.amazonaws.iot#DynamoDBv2Action": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants access to the DynamoDB table.

", "smithy.api#required": {} } }, "putItem": { "target": "com.amazonaws.iot#PutItemInput", "traits": { "smithy.api#documentation": "

Specifies the DynamoDB table to which the message data will be written. For\n example:

\n

\n { \"dynamoDBv2\": { \"roleArn\": \"aws:iam:12341251:my-role\" \"putItem\": { \"tableName\":\n \"my-table\" } } }\n

\n

Each attribute in the message payload will be written to a separate column in the\n DynamoDB database.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an action to write to a DynamoDB table.

\n

This DynamoDB action writes each attribute in the message payload into it's own\n column in the DynamoDB table.

" } }, "com.amazonaws.iot#DynamoKeyType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "STRING", "name": "STRING" }, { "value": "NUMBER", "name": "NUMBER" } ] } }, "com.amazonaws.iot#DynamoOperation": { "type": "string" }, "com.amazonaws.iot#EffectivePolicies": { "type": "list", "member": { "target": "com.amazonaws.iot#EffectivePolicy" } }, "com.amazonaws.iot#EffectivePolicy": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

" } }, "policyArn": { "target": "com.amazonaws.iot#PolicyArn", "traits": { "smithy.api#documentation": "

The policy ARN.

" } }, "policyDocument": { "target": "com.amazonaws.iot#PolicyDocument", "traits": { "smithy.api#documentation": "

The IAM policy document.

" } } }, "traits": { "smithy.api#documentation": "

The policy that has the effect on the authorization results.

" } }, "com.amazonaws.iot#ElasticsearchAction": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The IAM role ARN that has access to Elasticsearch.

", "smithy.api#required": {} } }, "endpoint": { "target": "com.amazonaws.iot#ElasticsearchEndpoint", "traits": { "smithy.api#documentation": "

The endpoint of your Elasticsearch domain.

", "smithy.api#required": {} } }, "index": { "target": "com.amazonaws.iot#ElasticsearchIndex", "traits": { "smithy.api#documentation": "

The Elasticsearch index where you want to store your data.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.iot#ElasticsearchType", "traits": { "smithy.api#documentation": "

The type of document you are storing.

", "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.iot#ElasticsearchId", "traits": { "smithy.api#documentation": "

The unique identifier for the document you are storing.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an action that writes data to an Amazon Elasticsearch Service\n domain.

" } }, "com.amazonaws.iot#ElasticsearchEndpoint": { "type": "string", "traits": { "smithy.api#pattern": "https?://.*" } }, "com.amazonaws.iot#ElasticsearchId": { "type": "string" }, "com.amazonaws.iot#ElasticsearchIndex": { "type": "string" }, "com.amazonaws.iot#ElasticsearchType": { "type": "string" }, "com.amazonaws.iot#EnableIoTLoggingParams": { "type": "structure", "members": { "roleArnForLogging": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role used for logging.

", "smithy.api#required": {} } }, "logLevel": { "target": "com.amazonaws.iot#LogLevel", "traits": { "smithy.api#documentation": "

Specifies the type of information to be logged.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Parameters used when defining a mitigation action that enable AWS IoT logging.

" } }, "com.amazonaws.iot#EnableTopicRule": { "type": "operation", "input": { "target": "com.amazonaws.iot#EnableTopicRuleRequest" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Enables the rule.

", "smithy.api#http": { "method": "POST", "uri": "/rules/{ruleName}/enable", "code": 200 } } }, "com.amazonaws.iot#EnableTopicRuleRequest": { "type": "structure", "members": { "ruleName": { "target": "com.amazonaws.iot#RuleName", "traits": { "smithy.api#documentation": "

The name of the topic rule to enable.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the EnableTopicRuleRequest operation.

" } }, "com.amazonaws.iot#Enabled": { "type": "boolean" }, "com.amazonaws.iot#EndpointAddress": { "type": "string" }, "com.amazonaws.iot#EndpointType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 } } }, "com.amazonaws.iot#ErrorCode": { "type": "string" }, "com.amazonaws.iot#ErrorInfo": { "type": "structure", "members": { "code": { "target": "com.amazonaws.iot#Code", "traits": { "smithy.api#documentation": "

The error code.

" } }, "message": { "target": "com.amazonaws.iot#OTAUpdateErrorMessage", "traits": { "smithy.api#documentation": "

The error message.

" } } }, "traits": { "smithy.api#documentation": "

Error information.

" } }, "com.amazonaws.iot#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.iot#ErrorMessage2": { "type": "string" }, "com.amazonaws.iot#EvaluationStatistic": { "type": "string", "traits": { "smithy.api#pattern": "(p0|p0\\.1|p0\\.01|p1|p10|p50|p90|p99|p99\\.9|p99\\.99|p100)" } }, "com.amazonaws.iot#EventConfigurations": { "type": "map", "key": { "target": "com.amazonaws.iot#EventType" }, "value": { "target": "com.amazonaws.iot#Configuration" } }, "com.amazonaws.iot#EventType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "THING", "name": "THING" }, { "value": "THING_GROUP", "name": "THING_GROUP" }, { "value": "THING_TYPE", "name": "THING_TYPE" }, { "value": "THING_GROUP_MEMBERSHIP", "name": "THING_GROUP_MEMBERSHIP" }, { "value": "THING_GROUP_HIERARCHY", "name": "THING_GROUP_HIERARCHY" }, { "value": "THING_TYPE_ASSOCIATION", "name": "THING_TYPE_ASSOCIATION" }, { "value": "JOB", "name": "JOB" }, { "value": "JOB_EXECUTION", "name": "JOB_EXECUTION" }, { "value": "POLICY", "name": "POLICY" }, { "value": "CERTIFICATE", "name": "CERTIFICATE" }, { "value": "CA_CERTIFICATE", "name": "CA_CERTIFICATE" } ] } }, "com.amazonaws.iot#ExecutionNamePrefix": { "type": "string" }, "com.amazonaws.iot#ExecutionNumber": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#ExpectedVersion": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#ExpiresInSec": { "type": "long", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 60, "max": 3600 } } }, "com.amazonaws.iot#ExpiresInSeconds": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#ExplicitDeny": { "type": "structure", "members": { "policies": { "target": "com.amazonaws.iot#Policies", "traits": { "smithy.api#documentation": "

The policies that denied the authorization.

" } } }, "traits": { "smithy.api#documentation": "

Information that explicitly denies authorization.

" } }, "com.amazonaws.iot#ExponentialRolloutRate": { "type": "structure", "members": { "baseRatePerMinute": { "target": "com.amazonaws.iot#RolloutRatePerMinute", "traits": { "smithy.api#documentation": "

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout.\n This parameter allows you to define the initial rate of rollout.

", "smithy.api#required": {} } }, "incrementFactor": { "target": "com.amazonaws.iot#IncrementFactor", "traits": { "smithy.api#documentation": "

The exponential factor to increase the rate of rollout for a job.

\n

AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

", "smithy.api#required": {} } }, "rateIncreaseCriteria": { "target": "com.amazonaws.iot#RateIncreaseCriteria", "traits": { "smithy.api#documentation": "

The criteria to initiate the increase in rate of rollout for a job.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Allows you to create an exponential rate of rollout for a job.

" } }, "com.amazonaws.iot#FailedChecksCount": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#FailedFindingsCount": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#FailedThings": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#Field": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#FieldName", "traits": { "smithy.api#documentation": "

The name of the field.

" } }, "type": { "target": "com.amazonaws.iot#FieldType", "traits": { "smithy.api#documentation": "

The datatype of the field.

" } } }, "traits": { "smithy.api#documentation": "

Describes the name and data type at a field.

" } }, "com.amazonaws.iot#FieldName": { "type": "string" }, "com.amazonaws.iot#FieldType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Number", "name": "NUMBER" }, { "value": "String", "name": "STRING" }, { "value": "Boolean", "name": "BOOLEAN" } ] } }, "com.amazonaws.iot#Fields": { "type": "list", "member": { "target": "com.amazonaws.iot#Field" } }, "com.amazonaws.iot#FileId": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 255 } } }, "com.amazonaws.iot#FileLocation": { "type": "structure", "members": { "stream": { "target": "com.amazonaws.iot#Stream", "traits": { "smithy.api#documentation": "

The stream that contains the OTA update.

" } }, "s3Location": { "target": "com.amazonaws.iot#S3Location", "traits": { "smithy.api#documentation": "

The location of the updated firmware in S3.

" } } }, "traits": { "smithy.api#documentation": "

The location of the OTA update.

" } }, "com.amazonaws.iot#FileName": { "type": "string" }, "com.amazonaws.iot#FileType": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 255 } } }, "com.amazonaws.iot#FindingId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.iot#FindingIds": { "type": "list", "member": { "target": "com.amazonaws.iot#FindingId" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.iot#FirehoseAction": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The IAM role that grants access to the Amazon Kinesis Firehose stream.

", "smithy.api#required": {} } }, "deliveryStreamName": { "target": "com.amazonaws.iot#DeliveryStreamName", "traits": { "smithy.api#documentation": "

The delivery stream name.

", "smithy.api#required": {} } }, "separator": { "target": "com.amazonaws.iot#FirehoseSeparator", "traits": { "smithy.api#documentation": "

A character separator that will be used to separate records written to the Firehose\n stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ','\n (comma).

" } }, "batchMode": { "target": "com.amazonaws.iot#BatchMode", "traits": { "smithy.api#documentation": "

Whether to deliver the Kinesis Data Firehose stream as a batch by using \n PutRecordBatch\n . The default value is\n false.

\n

When batchMode is true and the rule's SQL statement\n evaluates to an Array, each Array element forms one record in the \n PutRecordBatch\n request. The resulting array can't have more\n than 500 records.

" } } }, "traits": { "smithy.api#documentation": "

Describes an action that writes data to an Amazon Kinesis Firehose stream.

" } }, "com.amazonaws.iot#FirehoseSeparator": { "type": "string", "traits": { "smithy.api#pattern": "([\\n\\t])|(\\r\\n)|(,)" } }, "com.amazonaws.iot#Flag": { "type": "boolean" }, "com.amazonaws.iot#ForceDelete": { "type": "boolean" }, "com.amazonaws.iot#ForceDeleteAWSJob": { "type": "boolean" }, "com.amazonaws.iot#ForceFlag": { "type": "boolean" }, "com.amazonaws.iot#Forced": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#FunctionArn": { "type": "string" }, "com.amazonaws.iot#GenerationId": { "type": "string" }, "com.amazonaws.iot#GenericLongValue": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#GetBehaviorModelTrainingSummaries": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetBehaviorModelTrainingSummariesRequest" }, "output": { "target": "com.amazonaws.iot#GetBehaviorModelTrainingSummariesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Returns a Device Defender's ML Detect Security Profile training model's status.\n

", "smithy.api#http": { "method": "GET", "uri": "/behavior-model-training/summaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "summaries", "pageSize": "maxResults" } } }, "com.amazonaws.iot#GetBehaviorModelTrainingSummariesRequest": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

\n The name of the security profile.\n

", "smithy.api#httpQuery": "securityProfileName" } }, "maxResults": { "target": "com.amazonaws.iot#TinyMaxResults", "traits": { "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 25.\n

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

\n The token for the next set of results.\n

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#GetBehaviorModelTrainingSummariesResponse": { "type": "structure", "members": { "summaries": { "target": "com.amazonaws.iot#BehaviorModelTrainingSummaries", "traits": { "smithy.api#documentation": "

\n A list of all ML Detect behaviors and their model status for a given Security Profile.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" } } } }, "com.amazonaws.iot#GetCardinality": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetCardinalityRequest" }, "output": { "target": "com.amazonaws.iot#GetCardinalityResponse" }, "errors": [ { "target": "com.amazonaws.iot#IndexNotReadyException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidAggregationException" }, { "target": "com.amazonaws.iot#InvalidQueryException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns the approximate count of unique values that match the query.

", "smithy.api#http": { "method": "POST", "uri": "/indices/cardinality", "code": 200 } } }, "com.amazonaws.iot#GetCardinalityRequest": { "type": "structure", "members": { "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The name of the index to search.

" } }, "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { "smithy.api#documentation": "

The search query.

", "smithy.api#required": {} } }, "aggregationField": { "target": "com.amazonaws.iot#AggregationField", "traits": { "smithy.api#documentation": "

The field to aggregate.

" } }, "queryVersion": { "target": "com.amazonaws.iot#QueryVersion", "traits": { "smithy.api#documentation": "

The query version.

" } } } }, "com.amazonaws.iot#GetCardinalityResponse": { "type": "structure", "members": { "cardinality": { "target": "com.amazonaws.iot#Count", "traits": { "smithy.api#documentation": "

The approximate count of unique values that match the query.

" } } } }, "com.amazonaws.iot#GetEffectivePolicies": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetEffectivePoliciesRequest" }, "output": { "target": "com.amazonaws.iot#GetEffectivePoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets a list of the policies that have an effect on the authorization behavior of the\n specified device when it connects to the AWS IoT device gateway.

", "smithy.api#http": { "method": "POST", "uri": "/effective-policies", "code": 200 } } }, "com.amazonaws.iot#GetEffectivePoliciesRequest": { "type": "structure", "members": { "principal": { "target": "com.amazonaws.iot#Principal", "traits": { "smithy.api#documentation": "

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

" } }, "cognitoIdentityPoolId": { "target": "com.amazonaws.iot#CognitoIdentityPoolId", "traits": { "smithy.api#documentation": "

The Cognito identity pool ID.

" } }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The thing name.

", "smithy.api#httpQuery": "thingName" } } } }, "com.amazonaws.iot#GetEffectivePoliciesResponse": { "type": "structure", "members": { "effectivePolicies": { "target": "com.amazonaws.iot#EffectivePolicies", "traits": { "smithy.api#documentation": "

The effective policies.

" } } } }, "com.amazonaws.iot#GetIndexingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetIndexingConfigurationRequest" }, "output": { "target": "com.amazonaws.iot#GetIndexingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets the indexing configuration.

", "smithy.api#http": { "method": "GET", "uri": "/indexing/config", "code": 200 } } }, "com.amazonaws.iot#GetIndexingConfigurationRequest": { "type": "structure", "members": {} }, "com.amazonaws.iot#GetIndexingConfigurationResponse": { "type": "structure", "members": { "thingIndexingConfiguration": { "target": "com.amazonaws.iot#ThingIndexingConfiguration", "traits": { "smithy.api#documentation": "

Thing indexing configuration.

" } }, "thingGroupIndexingConfiguration": { "target": "com.amazonaws.iot#ThingGroupIndexingConfiguration", "traits": { "smithy.api#documentation": "

The index configuration.

" } } } }, "com.amazonaws.iot#GetJobDocument": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetJobDocumentRequest" }, "output": { "target": "com.amazonaws.iot#GetJobDocumentResponse" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets a job document.

", "smithy.api#http": { "method": "GET", "uri": "/jobs/{jobId}/job-document", "code": 200 } } }, "com.amazonaws.iot#GetJobDocumentRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#GetJobDocumentResponse": { "type": "structure", "members": { "document": { "target": "com.amazonaws.iot#JobDocument", "traits": { "smithy.api#documentation": "

The job document content.

" } } } }, "com.amazonaws.iot#GetLoggingOptions": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetLoggingOptionsRequest" }, "output": { "target": "com.amazonaws.iot#GetLoggingOptionsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Gets the logging options.

\n

NOTE: use of this command is not recommended. Use GetV2LoggingOptions\n instead.

", "smithy.api#http": { "method": "GET", "uri": "/loggingOptions", "code": 200 } } }, "com.amazonaws.iot#GetLoggingOptionsRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The input for the GetLoggingOptions operation.

" } }, "com.amazonaws.iot#GetLoggingOptionsResponse": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants access.

" } }, "logLevel": { "target": "com.amazonaws.iot#LogLevel", "traits": { "smithy.api#documentation": "

The logging level.

" } } }, "traits": { "smithy.api#documentation": "

The output from the GetLoggingOptions operation.

" } }, "com.amazonaws.iot#GetOTAUpdate": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetOTAUpdateRequest" }, "output": { "target": "com.amazonaws.iot#GetOTAUpdateResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets an OTA update.

", "smithy.api#http": { "method": "GET", "uri": "/otaUpdates/{otaUpdateId}", "code": 200 } } }, "com.amazonaws.iot#GetOTAUpdateRequest": { "type": "structure", "members": { "otaUpdateId": { "target": "com.amazonaws.iot#OTAUpdateId", "traits": { "smithy.api#documentation": "

The OTA update ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#GetOTAUpdateResponse": { "type": "structure", "members": { "otaUpdateInfo": { "target": "com.amazonaws.iot#OTAUpdateInfo", "traits": { "smithy.api#documentation": "

The OTA update info.

" } } } }, "com.amazonaws.iot#GetPercentiles": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetPercentilesRequest" }, "output": { "target": "com.amazonaws.iot#GetPercentilesResponse" }, "errors": [ { "target": "com.amazonaws.iot#IndexNotReadyException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidAggregationException" }, { "target": "com.amazonaws.iot#InvalidQueryException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Groups the aggregated values that match the query into percentile groupings. The default \n percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own \n when you call GetPercentiles. This function returns a value for each \n percentile group specified (or the default percentile groupings). The percentile group \n \"1\" contains the aggregated field value that occurs in approximately one percent of the \n values that match the query. The percentile group \"5\" contains the aggregated field value \n that occurs in approximately five percent of the values that match the query, and so on. \n The result is an approximation, the more values that match the query, the more accurate \n the percentile values.

", "smithy.api#http": { "method": "POST", "uri": "/indices/percentiles", "code": 200 } } }, "com.amazonaws.iot#GetPercentilesRequest": { "type": "structure", "members": { "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The name of the index to search.

" } }, "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { "smithy.api#documentation": "

The query string.

", "smithy.api#required": {} } }, "aggregationField": { "target": "com.amazonaws.iot#AggregationField", "traits": { "smithy.api#documentation": "

The field to aggregate.

" } }, "queryVersion": { "target": "com.amazonaws.iot#QueryVersion", "traits": { "smithy.api#documentation": "

The query version.

" } }, "percents": { "target": "com.amazonaws.iot#PercentList", "traits": { "smithy.api#documentation": "

The percentile groups returned.

" } } } }, "com.amazonaws.iot#GetPercentilesResponse": { "type": "structure", "members": { "percentiles": { "target": "com.amazonaws.iot#Percentiles", "traits": { "smithy.api#documentation": "

The percentile values of the aggregated fields.

" } } } }, "com.amazonaws.iot#GetPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetPolicyRequest" }, "output": { "target": "com.amazonaws.iot#GetPolicyResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets information about the specified policy with the policy document of the default\n version.

", "smithy.api#http": { "method": "GET", "uri": "/policies/{policyName}", "code": 200 } } }, "com.amazonaws.iot#GetPolicyRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The name of the policy.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the GetPolicy operation.

" } }, "com.amazonaws.iot#GetPolicyResponse": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

" } }, "policyArn": { "target": "com.amazonaws.iot#PolicyArn", "traits": { "smithy.api#documentation": "

The policy ARN.

" } }, "policyDocument": { "target": "com.amazonaws.iot#PolicyDocument", "traits": { "smithy.api#documentation": "

The JSON document that describes the policy.

" } }, "defaultVersionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The default policy version ID.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the policy was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the policy was last modified.

" } }, "generationId": { "target": "com.amazonaws.iot#GenerationId", "traits": { "smithy.api#documentation": "

The generation ID of the policy.

" } } }, "traits": { "smithy.api#documentation": "

The output from the GetPolicy operation.

" } }, "com.amazonaws.iot#GetPolicyVersion": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetPolicyVersionRequest" }, "output": { "target": "com.amazonaws.iot#GetPolicyVersionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets information about the specified policy version.

", "smithy.api#http": { "method": "GET", "uri": "/policies/{policyName}/version/{policyVersionId}", "code": 200 } } }, "com.amazonaws.iot#GetPolicyVersionRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The name of the policy.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "policyVersionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The policy version ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the GetPolicyVersion operation.

" } }, "com.amazonaws.iot#GetPolicyVersionResponse": { "type": "structure", "members": { "policyArn": { "target": "com.amazonaws.iot#PolicyArn", "traits": { "smithy.api#documentation": "

The policy ARN.

" } }, "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

" } }, "policyDocument": { "target": "com.amazonaws.iot#PolicyDocument", "traits": { "smithy.api#documentation": "

The JSON document that describes the policy.

" } }, "policyVersionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The policy version ID.

" } }, "isDefaultVersion": { "target": "com.amazonaws.iot#IsDefaultVersion", "traits": { "smithy.api#documentation": "

Specifies whether the policy version is the default.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the policy was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the policy was last modified.

" } }, "generationId": { "target": "com.amazonaws.iot#GenerationId", "traits": { "smithy.api#documentation": "

The generation ID of the policy version.

" } } }, "traits": { "smithy.api#documentation": "

The output from the GetPolicyVersion operation.

" } }, "com.amazonaws.iot#GetRegistrationCode": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetRegistrationCodeRequest" }, "output": { "target": "com.amazonaws.iot#GetRegistrationCodeResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets a registration code used to register a CA certificate with AWS IoT.

", "smithy.api#http": { "method": "GET", "uri": "/registrationcode", "code": 200 } } }, "com.amazonaws.iot#GetRegistrationCodeRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The input to the GetRegistrationCode operation.

" } }, "com.amazonaws.iot#GetRegistrationCodeResponse": { "type": "structure", "members": { "registrationCode": { "target": "com.amazonaws.iot#RegistrationCode", "traits": { "smithy.api#documentation": "

The CA certificate registration code.

" } } }, "traits": { "smithy.api#documentation": "

The output from the GetRegistrationCode operation.

" } }, "com.amazonaws.iot#GetStatistics": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetStatisticsRequest" }, "output": { "target": "com.amazonaws.iot#GetStatisticsResponse" }, "errors": [ { "target": "com.amazonaws.iot#IndexNotReadyException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidAggregationException" }, { "target": "com.amazonaws.iot#InvalidQueryException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Returns the count, average, sum, minimum, maximum, sum of squares, variance,\n and standard deviation for the specified aggregated field. If the aggregation field is of type\n String, only the count statistic is returned.

", "smithy.api#http": { "method": "POST", "uri": "/indices/statistics", "code": 200 } } }, "com.amazonaws.iot#GetStatisticsRequest": { "type": "structure", "members": { "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The name of the index to search. The default value is AWS_Things.

" } }, "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { "smithy.api#documentation": "

The query used to search. You can specify \"*\" for the query string to get the count of all\n indexed things in your AWS account.

", "smithy.api#required": {} } }, "aggregationField": { "target": "com.amazonaws.iot#AggregationField", "traits": { "smithy.api#documentation": "

The aggregation field name.

" } }, "queryVersion": { "target": "com.amazonaws.iot#QueryVersion", "traits": { "smithy.api#documentation": "

The version of the query used to search.

" } } } }, "com.amazonaws.iot#GetStatisticsResponse": { "type": "structure", "members": { "statistics": { "target": "com.amazonaws.iot#Statistics", "traits": { "smithy.api#documentation": "

The statistics returned by the Fleet Indexing service based on the query and aggregation\n field.

" } } } }, "com.amazonaws.iot#GetTopicRule": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetTopicRuleRequest" }, "output": { "target": "com.amazonaws.iot#GetTopicRuleResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets information about the rule.

", "smithy.api#http": { "method": "GET", "uri": "/rules/{ruleName}", "code": 200 } } }, "com.amazonaws.iot#GetTopicRuleDestination": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetTopicRuleDestinationRequest" }, "output": { "target": "com.amazonaws.iot#GetTopicRuleDestinationResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Gets information about a topic rule destination.

", "smithy.api#http": { "method": "GET", "uri": "/destinations/{arn+}", "code": 200 } } }, "com.amazonaws.iot#GetTopicRuleDestinationRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the topic rule destination.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#GetTopicRuleDestinationResponse": { "type": "structure", "members": { "topicRuleDestination": { "target": "com.amazonaws.iot#TopicRuleDestination", "traits": { "smithy.api#documentation": "

The topic rule destination.

" } } } }, "com.amazonaws.iot#GetTopicRuleRequest": { "type": "structure", "members": { "ruleName": { "target": "com.amazonaws.iot#RuleName", "traits": { "smithy.api#documentation": "

The name of the rule.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the GetTopicRule operation.

" } }, "com.amazonaws.iot#GetTopicRuleResponse": { "type": "structure", "members": { "ruleArn": { "target": "com.amazonaws.iot#RuleArn", "traits": { "smithy.api#documentation": "

The rule ARN.

" } }, "rule": { "target": "com.amazonaws.iot#TopicRule", "traits": { "smithy.api#documentation": "

The rule.

" } } }, "traits": { "smithy.api#documentation": "

The output from the GetTopicRule operation.

" } }, "com.amazonaws.iot#GetV2LoggingOptions": { "type": "operation", "input": { "target": "com.amazonaws.iot#GetV2LoggingOptionsRequest" }, "output": { "target": "com.amazonaws.iot#GetV2LoggingOptionsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#NotConfiguredException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Gets the fine grained logging options.

", "smithy.api#http": { "method": "GET", "uri": "/v2LoggingOptions", "code": 200 } } }, "com.amazonaws.iot#GetV2LoggingOptionsRequest": { "type": "structure", "members": {} }, "com.amazonaws.iot#GetV2LoggingOptionsResponse": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The IAM role ARN AWS IoT uses to write to your CloudWatch logs.

" } }, "defaultLogLevel": { "target": "com.amazonaws.iot#LogLevel", "traits": { "smithy.api#documentation": "

The default log level.

" } }, "disableAllLogs": { "target": "com.amazonaws.iot#DisableAllLogs", "traits": { "smithy.api#documentation": "

Disables all logs.

" } } } }, "com.amazonaws.iot#GroupNameAndArn": { "type": "structure", "members": { "groupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The group name.

" } }, "groupArn": { "target": "com.amazonaws.iot#ThingGroupArn", "traits": { "smithy.api#documentation": "

The group ARN.

" } } }, "traits": { "smithy.api#documentation": "

The name and ARN of a group.

" } }, "com.amazonaws.iot#HashAlgorithm": { "type": "string" }, "com.amazonaws.iot#HashKeyField": { "type": "string" }, "com.amazonaws.iot#HashKeyValue": { "type": "string" }, "com.amazonaws.iot#HeaderKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.iot#HeaderList": { "type": "list", "member": { "target": "com.amazonaws.iot#HttpActionHeader" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.iot#HeaderValue": { "type": "string" }, "com.amazonaws.iot#HttpAction": { "type": "structure", "members": { "url": { "target": "com.amazonaws.iot#Url", "traits": { "smithy.api#documentation": "

The endpoint URL. If substitution templates are used in the URL, you must also specify a\n confirmationUrl. If this is a new destination, a new\n TopicRuleDestination is created if possible.

", "smithy.api#required": {} } }, "confirmationUrl": { "target": "com.amazonaws.iot#Url", "traits": { "smithy.api#documentation": "

The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL\n must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses\n the endpoint URL as the confirmation URL. If you use substitution templates in the\n confirmationUrl, you must create and enable topic rule destinations that match each\n possible value of the substitution template before traffic is allowed to your endpoint\n URL.

" } }, "headers": { "target": "com.amazonaws.iot#HeaderList", "traits": { "smithy.api#documentation": "

The HTTP headers to send with the message data.

" } }, "auth": { "target": "com.amazonaws.iot#HttpAuthorization", "traits": { "smithy.api#documentation": "

The authentication method to use when sending data to an HTTPS endpoint.

" } } }, "traits": { "smithy.api#documentation": "

Send data to an HTTPS endpoint.

" } }, "com.amazonaws.iot#HttpActionHeader": { "type": "structure", "members": { "key": { "target": "com.amazonaws.iot#HeaderKey", "traits": { "smithy.api#documentation": "

The HTTP header key.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.iot#HeaderValue", "traits": { "smithy.api#documentation": "

The HTTP header value. Substitution templates are supported.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The HTTP action header.

" } }, "com.amazonaws.iot#HttpAuthorization": { "type": "structure", "members": { "sigv4": { "target": "com.amazonaws.iot#SigV4Authorization", "traits": { "smithy.api#documentation": "

Use Sig V4 authorization. For more information, see Signature\n Version 4 Signing Process.

" } } }, "traits": { "smithy.api#documentation": "

The authorization method used to send messages.

" } }, "com.amazonaws.iot#HttpContext": { "type": "structure", "members": { "headers": { "target": "com.amazonaws.iot#HttpHeaders", "traits": { "smithy.api#documentation": "

The header keys and values in an HTTP authorization request.

" } }, "queryString": { "target": "com.amazonaws.iot#HttpQueryString", "traits": { "smithy.api#documentation": "

The query string keys and values in an HTTP authorization request.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the HTTP context to use for the test authorizer request.

" } }, "com.amazonaws.iot#HttpHeaderName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8192 } } }, "com.amazonaws.iot#HttpHeaderValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 8192 } } }, "com.amazonaws.iot#HttpHeaders": { "type": "map", "key": { "target": "com.amazonaws.iot#HttpHeaderName" }, "value": { "target": "com.amazonaws.iot#HttpHeaderValue" } }, "com.amazonaws.iot#HttpQueryString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.iot#HttpUrlDestinationConfiguration": { "type": "structure", "members": { "confirmationUrl": { "target": "com.amazonaws.iot#Url", "traits": { "smithy.api#documentation": "

The URL AWS IoT uses to confirm ownership of or access to the topic rule destination\n URL.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

HTTP URL destination configuration used by the topic rule's HTTP action.

" } }, "com.amazonaws.iot#HttpUrlDestinationProperties": { "type": "structure", "members": { "confirmationUrl": { "target": "com.amazonaws.iot#Url", "traits": { "smithy.api#documentation": "

The URL used to confirm the HTTP topic rule destination URL.

" } } }, "traits": { "smithy.api#documentation": "

HTTP URL destination properties.

" } }, "com.amazonaws.iot#HttpUrlDestinationSummary": { "type": "structure", "members": { "confirmationUrl": { "target": "com.amazonaws.iot#Url", "traits": { "smithy.api#documentation": "

The URL used to confirm ownership of or access to the HTTP topic rule destination\n URL.

" } } }, "traits": { "smithy.api#documentation": "

Information about an HTTP URL destination.

" } }, "com.amazonaws.iot#ImplicitDeny": { "type": "structure", "members": { "policies": { "target": "com.amazonaws.iot#Policies", "traits": { "smithy.api#documentation": "

Policies that don't contain a matching allow or deny statement for the specified\n action on the specified resource.

" } } }, "traits": { "smithy.api#documentation": "

Information that implicitly denies authorization. When policy doesn't explicitly deny\n or allow an action on a resource it is considered an implicit deny.

" } }, "com.amazonaws.iot#InProgressChecksCount": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#InProgressThings": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#InProgressTimeoutInMinutes": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#IncrementFactor": { "type": "double", "traits": { "smithy.api#range": { "min": 1, "max": 5 } } }, "com.amazonaws.iot#IndexName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#IndexNamesList": { "type": "list", "member": { "target": "com.amazonaws.iot#IndexName" } }, "com.amazonaws.iot#IndexNotReadyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The index is not ready.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#IndexSchema": { "type": "string" }, "com.amazonaws.iot#IndexStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "BUILDING", "name": "BUILDING" }, { "value": "REBUILDING", "name": "REBUILDING" } ] } }, "com.amazonaws.iot#InlineDocument": { "type": "string" }, "com.amazonaws.iot#InputName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.iot#InternalException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

An unexpected error has occurred.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.iot#InternalFailureException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

An unexpected error has occurred.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.iot#InvalidAggregationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2" } }, "traits": { "smithy.api#documentation": "

The aggregation is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#InvalidQueryException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The query is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#InvalidRequestException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The request is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#InvalidResponseException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The response is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#InvalidStateTransitionException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

An attempt was made to change to an invalid state, for example by deleting a job or a\n job execution which is \"IN_PROGRESS\" without setting the force\n parameter.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iot#IotAnalyticsAction": { "type": "structure", "members": { "channelArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

(deprecated) The ARN of the IoT Analytics channel to which message data will be\n sent.

" } }, "channelName": { "target": "com.amazonaws.iot#ChannelName", "traits": { "smithy.api#documentation": "

The name of the IoT Analytics channel to which message data will be sent.

" } }, "batchMode": { "target": "com.amazonaws.iot#BatchMode", "traits": { "smithy.api#documentation": "

Whether to process the action as a batch. The default value is\n false.

\n

When batchMode is true and the rule SQL statement evaluates\n to an Array, each Array element is delivered as a separate message when passed by \n BatchPutMessage\n to the AWS IoT Analytics channel. The resulting array can't have more\n than 100 messages.

" } }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the role which has a policy that grants IoT Analytics permission to send\n message data via IoT Analytics (iotanalytics:BatchPutMessage).

" } } }, "traits": { "smithy.api#documentation": "

Sends message data to an AWS IoT Analytics channel.

" } }, "com.amazonaws.iot#IotEventsAction": { "type": "structure", "members": { "inputName": { "target": "com.amazonaws.iot#InputName", "traits": { "smithy.api#documentation": "

The name of the AWS IoT Events input.

", "smithy.api#required": {} } }, "messageId": { "target": "com.amazonaws.iot#MessageId", "traits": { "smithy.api#documentation": "

The ID of the message. The default messageId is a new UUID value.

\n

When batchMode is true, you can't specify a\n messageId--a new UUID value will be assigned.

\n

Assign a value to this property to ensure that only one input (message) with a given\n messageId will be processed by an AWS IoT Events detector.

" } }, "batchMode": { "target": "com.amazonaws.iot#BatchMode", "traits": { "smithy.api#documentation": "

Whether to process the event actions as a batch. The default value is\n false.

\n

When batchMode is true, you can't specify a\n messageId.

\n

When batchMode is true and the rule SQL statement evaluates\n to an Array, each Array element is treated as a separate message when it's sent to AWS IoT\n Events by calling \n BatchPutMessage\n . The resulting array can't have more\n than 10 messages.

" } }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT\n Events detector. (\"Action\":\"iotevents:BatchPutMessage\").

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Sends an input to an AWS IoT Events detector.

" } }, "com.amazonaws.iot#IotSiteWiseAction": { "type": "structure", "members": { "putAssetPropertyValueEntries": { "target": "com.amazonaws.iot#PutAssetPropertyValueEntryList", "traits": { "smithy.api#documentation": "

A list of asset property value entries.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the role that grants AWS IoT permission to send an asset property value to AWS\n IoTSiteWise. (\"Action\": \"iotsitewise:BatchPutAssetPropertyValue\"). The trust\n policy can restrict access to specific asset hierarchy paths.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an action to send data from an MQTT message that triggered the rule to AWS IoT\n SiteWise asset properties.

" } }, "com.amazonaws.iot#IsAuthenticated": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#IsDefaultVersion": { "type": "boolean" }, "com.amazonaws.iot#IsDisabled": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#IsSuppressed": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#Job": { "type": "structure", "members": { "jobArn": { "target": "com.amazonaws.iot#JobArn", "traits": { "smithy.api#documentation": "

An ARN identifying the job with format \"arn:aws:iot:region:account:job/jobId\".

" } }, "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" } }, "targetSelection": { "target": "com.amazonaws.iot#TargetSelection", "traits": { "smithy.api#documentation": "

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a device when the thing representing\n the device is added to a target group, even after the job was completed by all things originally in the \n group.

" } }, "status": { "target": "com.amazonaws.iot#JobStatus", "traits": { "smithy.api#documentation": "

The status of the job, one of IN_PROGRESS, CANCELED, \n DELETION_IN_PROGRESS or COMPLETED.

" } }, "forceCanceled": { "target": "com.amazonaws.iot#Forced", "traits": { "smithy.api#documentation": "

Will be true if the job was canceled with the optional force parameter set to \n true.

" } }, "reasonCode": { "target": "com.amazonaws.iot#ReasonCode", "traits": { "smithy.api#documentation": "

If the job was updated, provides the reason code for the update.

" } }, "comment": { "target": "com.amazonaws.iot#Comment", "traits": { "smithy.api#documentation": "

If the job was updated, describes the reason for the update.

" } }, "targets": { "target": "com.amazonaws.iot#JobTargets", "traits": { "smithy.api#documentation": "

A list of IoT things and thing groups to which the job should be sent.

" } }, "description": { "target": "com.amazonaws.iot#JobDescription", "traits": { "smithy.api#documentation": "

A short text description of the job.

" } }, "presignedUrlConfig": { "target": "com.amazonaws.iot#PresignedUrlConfig", "traits": { "smithy.api#documentation": "

Configuration for pre-signed S3 URLs.

" } }, "jobExecutionsRolloutConfig": { "target": "com.amazonaws.iot#JobExecutionsRolloutConfig", "traits": { "smithy.api#documentation": "

Allows you to create a staged rollout of a job.

" } }, "abortConfig": { "target": "com.amazonaws.iot#AbortConfig", "traits": { "smithy.api#documentation": "

Configuration for criteria to abort the job.

" } }, "createdAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was last updated.

" } }, "completedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was completed.

" } }, "jobProcessDetails": { "target": "com.amazonaws.iot#JobProcessDetails", "traits": { "smithy.api#documentation": "

Details about the job process.

" } }, "timeoutConfig": { "target": "com.amazonaws.iot#TimeoutConfig", "traits": { "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. A timer \n is started when the job execution status is set to IN_PROGRESS. If the job \n execution status is not set to another terminal state before the timer expires, it will\n be automatically set to TIMED_OUT.

" } }, "namespaceId": { "target": "com.amazonaws.iot#NamespaceId", "traits": { "smithy.api#documentation": "

The namespace used to indicate that a job is a customer-managed job.

\n

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that \n contain the value in the following format.

\n

\n $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/\n

\n \n

The namespaceId feature is in public preview.

\n
" } }, "jobTemplateArn": { "target": "com.amazonaws.iot#JobTemplateArn", "traits": { "smithy.api#documentation": "

The ARN of the job template used to create the job.

" } } }, "traits": { "smithy.api#documentation": "

The Job object contains details about a job.

" } }, "com.amazonaws.iot#JobArn": { "type": "string" }, "com.amazonaws.iot#JobDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2028 }, "smithy.api#pattern": "[^\\p{C}]+" } }, "com.amazonaws.iot#JobDocument": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 32768 } } }, "com.amazonaws.iot#JobDocumentSource": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1350 } } }, "com.amazonaws.iot#JobExecution": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to the job when it was created.

" } }, "status": { "target": "com.amazonaws.iot#JobExecutionStatus", "traits": { "smithy.api#documentation": "

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, \n CANCELED, or REJECTED).

" } }, "forceCanceled": { "target": "com.amazonaws.iot#Forced", "traits": { "smithy.api#documentation": "

Will be true if the job execution was canceled with the optional force \n parameter set to true.

" } }, "statusDetails": { "target": "com.amazonaws.iot#JobExecutionStatusDetails", "traits": { "smithy.api#documentation": "

A collection of name/value pairs that describe the status of the job execution.

" } }, "thingArn": { "target": "com.amazonaws.iot#ThingArn", "traits": { "smithy.api#documentation": "

The ARN of the thing on which the job execution is running.

" } }, "queuedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was queued.

" } }, "startedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution started.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was last updated.

" } }, "executionNumber": { "target": "com.amazonaws.iot#ExecutionNumber", "traits": { "smithy.api#documentation": "

A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on\n this particular device. It can be used in commands which return or update job execution information.\n

" } }, "versionNumber": { "target": "com.amazonaws.iot#VersionNumber", "traits": { "smithy.api#documentation": "

The version of the job execution. Job execution versions are incremented each time they are updated\n by a device.

" } }, "approximateSecondsBeforeTimedOut": { "target": "com.amazonaws.iot#ApproximateSecondsBeforeTimedOut", "traits": { "smithy.api#documentation": "

The estimated number of seconds that remain before the job execution status will be\n changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). \n The actual job execution timeout can occur up to 60 seconds later than the estimated duration. \n This value will not be included if the job execution has reached a terminal status.

" } } }, "traits": { "smithy.api#documentation": "

The job execution object represents the execution of a job on a particular device.

" } }, "com.amazonaws.iot#JobExecutionFailureType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "FAILED", "name": "FAILED" }, { "value": "REJECTED", "name": "REJECTED" }, { "value": "TIMED_OUT", "name": "TIMED_OUT" }, { "value": "ALL", "name": "ALL" } ] } }, "com.amazonaws.iot#JobExecutionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "QUEUED", "name": "QUEUED" }, { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "SUCCEEDED", "name": "SUCCEEDED" }, { "value": "FAILED", "name": "FAILED" }, { "value": "TIMED_OUT", "name": "TIMED_OUT" }, { "value": "REJECTED", "name": "REJECTED" }, { "value": "REMOVED", "name": "REMOVED" }, { "value": "CANCELED", "name": "CANCELED" } ] } }, "com.amazonaws.iot#JobExecutionStatusDetails": { "type": "structure", "members": { "detailsMap": { "target": "com.amazonaws.iot#DetailsMap", "traits": { "smithy.api#documentation": "

The job execution status.

" } } }, "traits": { "smithy.api#documentation": "

Details of the job execution status.

" } }, "com.amazonaws.iot#JobExecutionSummary": { "type": "structure", "members": { "status": { "target": "com.amazonaws.iot#JobExecutionStatus", "traits": { "smithy.api#documentation": "

The status of the job execution.

" } }, "queuedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was queued.

" } }, "startedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution started.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job execution was last updated.

" } }, "executionNumber": { "target": "com.amazonaws.iot#ExecutionNumber", "traits": { "smithy.api#documentation": "

A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on\n this particular device. It can be used later in commands which return or update job execution\n information.

" } } }, "traits": { "smithy.api#documentation": "

The job execution summary.

" } }, "com.amazonaws.iot#JobExecutionSummaryForJob": { "type": "structure", "members": { "thingArn": { "target": "com.amazonaws.iot#ThingArn", "traits": { "smithy.api#documentation": "

The ARN of the thing on which the job execution is running.

" } }, "jobExecutionSummary": { "target": "com.amazonaws.iot#JobExecutionSummary", "traits": { "smithy.api#documentation": "

Contains a subset of information about a job execution.

" } } }, "traits": { "smithy.api#documentation": "

Contains a summary of information about job executions for a specific job.

" } }, "com.amazonaws.iot#JobExecutionSummaryForJobList": { "type": "list", "member": { "target": "com.amazonaws.iot#JobExecutionSummaryForJob" } }, "com.amazonaws.iot#JobExecutionSummaryForThing": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" } }, "jobExecutionSummary": { "target": "com.amazonaws.iot#JobExecutionSummary", "traits": { "smithy.api#documentation": "

Contains a subset of information about a job execution.

" } } }, "traits": { "smithy.api#documentation": "

The job execution summary for a thing.

" } }, "com.amazonaws.iot#JobExecutionSummaryForThingList": { "type": "list", "member": { "target": "com.amazonaws.iot#JobExecutionSummaryForThing" } }, "com.amazonaws.iot#JobExecutionsRolloutConfig": { "type": "structure", "members": { "maximumPerMinute": { "target": "com.amazonaws.iot#MaxJobExecutionsPerMin", "traits": { "smithy.api#documentation": "

The maximum number of things that will be notified of a pending job, per minute.\n This parameter allows you to create a staged rollout.

" } }, "exponentialRate": { "target": "com.amazonaws.iot#ExponentialRolloutRate", "traits": { "smithy.api#documentation": "

The rate of increase for a job rollout.\n This parameter allows you to define an exponential rate for a job rollout.

" } } }, "traits": { "smithy.api#documentation": "

Allows you to create a staged rollout of a job.

" } }, "com.amazonaws.iot#JobId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.iot#JobProcessDetails": { "type": "structure", "members": { "processingTargets": { "target": "com.amazonaws.iot#ProcessingTargetNameList", "traits": { "smithy.api#documentation": "

The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.

" } }, "numberOfCanceledThings": { "target": "com.amazonaws.iot#CanceledThings", "traits": { "smithy.api#documentation": "

The number of things that cancelled the job.

" } }, "numberOfSucceededThings": { "target": "com.amazonaws.iot#SucceededThings", "traits": { "smithy.api#documentation": "

The number of things which successfully completed the job.

" } }, "numberOfFailedThings": { "target": "com.amazonaws.iot#FailedThings", "traits": { "smithy.api#documentation": "

The number of things that failed executing the job.

" } }, "numberOfRejectedThings": { "target": "com.amazonaws.iot#RejectedThings", "traits": { "smithy.api#documentation": "

The number of things that rejected the job.

" } }, "numberOfQueuedThings": { "target": "com.amazonaws.iot#QueuedThings", "traits": { "smithy.api#documentation": "

The number of things that are awaiting execution of the job.

" } }, "numberOfInProgressThings": { "target": "com.amazonaws.iot#InProgressThings", "traits": { "smithy.api#documentation": "

The number of things currently executing the job.

" } }, "numberOfRemovedThings": { "target": "com.amazonaws.iot#RemovedThings", "traits": { "smithy.api#documentation": "

The number of things that are no longer scheduled to execute the job because they have been deleted or\n have been removed from the group that was a target of the job.

" } }, "numberOfTimedOutThings": { "target": "com.amazonaws.iot#TimedOutThings", "traits": { "smithy.api#documentation": "

The number of things whose job execution status is TIMED_OUT.

" } } }, "traits": { "smithy.api#documentation": "

The job process details.

" } }, "com.amazonaws.iot#JobStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "CANCELED", "name": "CANCELED" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "DELETION_IN_PROGRESS", "name": "DELETION_IN_PROGRESS" } ] } }, "com.amazonaws.iot#JobSummary": { "type": "structure", "members": { "jobArn": { "target": "com.amazonaws.iot#JobArn", "traits": { "smithy.api#documentation": "

The job ARN.

" } }, "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

" } }, "thingGroupId": { "target": "com.amazonaws.iot#ThingGroupId", "traits": { "smithy.api#documentation": "

The ID of the thing group.

" } }, "targetSelection": { "target": "com.amazonaws.iot#TargetSelection", "traits": { "smithy.api#documentation": "

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.

" } }, "status": { "target": "com.amazonaws.iot#JobStatus", "traits": { "smithy.api#documentation": "

The job summary status.

" } }, "createdAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job was last updated.

" } }, "completedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job completed.

" } } }, "traits": { "smithy.api#documentation": "

The job summary.

" } }, "com.amazonaws.iot#JobSummaryList": { "type": "list", "member": { "target": "com.amazonaws.iot#JobSummary" } }, "com.amazonaws.iot#JobTargets": { "type": "list", "member": { "target": "com.amazonaws.iot#TargetArn" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#JobTemplateArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1600 }, "smithy.api#pattern": "^arn:[!-~]+$" } }, "com.amazonaws.iot#JobTemplateId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.iot#JobTemplateSummary": { "type": "structure", "members": { "jobTemplateArn": { "target": "com.amazonaws.iot#JobTemplateArn", "traits": { "smithy.api#documentation": "

The ARN of the job template.

" } }, "jobTemplateId": { "target": "com.amazonaws.iot#JobTemplateId", "traits": { "smithy.api#documentation": "

The unique identifier of the job template.

" } }, "description": { "target": "com.amazonaws.iot#JobDescription", "traits": { "smithy.api#documentation": "

A description of the job template.

" } }, "createdAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The time, in seconds since the epoch, when the job template was created.

" } } }, "traits": { "smithy.api#documentation": "

An object that contains information about the job template.

" } }, "com.amazonaws.iot#JobTemplateSummaryList": { "type": "list", "member": { "target": "com.amazonaws.iot#JobTemplateSummary" } }, "com.amazonaws.iot#JsonDocument": { "type": "string" }, "com.amazonaws.iot#KafkaAction": { "type": "structure", "members": { "destinationArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of Kafka action's VPC TopicRuleDestination.

", "smithy.api#required": {} } }, "topic": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

The Kafka topic for messages to be sent to the Kafka broker.

", "smithy.api#required": {} } }, "key": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

The Kafka message key.

" } }, "partition": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

The Kafka message partition.

" } }, "clientProperties": { "target": "com.amazonaws.iot#ClientProperties", "traits": { "smithy.api#documentation": "

Properties of the Apache Kafka producer client.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

" } }, "com.amazonaws.iot#Key": { "type": "string" }, "com.amazonaws.iot#KeyName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#KeyPair": { "type": "structure", "members": { "PublicKey": { "target": "com.amazonaws.iot#PublicKey", "traits": { "smithy.api#documentation": "

The public key.

" } }, "PrivateKey": { "target": "com.amazonaws.iot#PrivateKey", "traits": { "smithy.api#documentation": "

The private key.

" } } }, "traits": { "smithy.api#documentation": "

Describes a key pair.

" } }, "com.amazonaws.iot#KeyValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 5120 } } }, "com.amazonaws.iot#KinesisAction": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

", "smithy.api#required": {} } }, "streamName": { "target": "com.amazonaws.iot#StreamName", "traits": { "smithy.api#documentation": "

The name of the Amazon Kinesis stream.

", "smithy.api#required": {} } }, "partitionKey": { "target": "com.amazonaws.iot#PartitionKey", "traits": { "smithy.api#documentation": "

The partition key.

" } } }, "traits": { "smithy.api#documentation": "

Describes an action to write data to an Amazon Kinesis stream.

" } }, "com.amazonaws.iot#LambdaAction": { "type": "structure", "members": { "functionArn": { "target": "com.amazonaws.iot#FunctionArn", "traits": { "smithy.api#documentation": "

The ARN of the Lambda function.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an action to invoke a Lambda function.

" } }, "com.amazonaws.iot#LaserMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 250 } } }, "com.amazonaws.iot#LastModifiedDate": { "type": "timestamp" }, "com.amazonaws.iot#LastUpdatedAtDate": { "type": "timestamp" }, "com.amazonaws.iot#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

A limit has been exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 410 } }, "com.amazonaws.iot#ListActiveViolations": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListActiveViolationsRequest" }, "output": { "target": "com.amazonaws.iot#ListActiveViolationsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the active violations for a given Device Defender security profile.

", "smithy.api#http": { "method": "GET", "uri": "/active-violations", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "activeViolations", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListActiveViolationsRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { "smithy.api#documentation": "

The name of the thing whose active violations are listed.

", "smithy.api#httpQuery": "thingName" } }, "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name of the Device Defender security profile for which violations are listed.

", "smithy.api#httpQuery": "securityProfileName" } }, "behaviorCriteriaType": { "target": "com.amazonaws.iot#BehaviorCriteriaType", "traits": { "smithy.api#documentation": "

\n The criteria for a behavior.\n

", "smithy.api#httpQuery": "behaviorCriteriaType" } }, "listSuppressedAlerts": { "target": "com.amazonaws.iot#ListSuppressedAlerts", "traits": { "smithy.api#documentation": "

\n A list of all suppressed alerts.\n

", "smithy.api#httpQuery": "listSuppressedAlerts" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListActiveViolationsResponse": { "type": "structure", "members": { "activeViolations": { "target": "com.amazonaws.iot#ActiveViolations", "traits": { "smithy.api#documentation": "

The list of active violations.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListAttachedPolicies": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListAttachedPoliciesRequest" }, "output": { "target": "com.amazonaws.iot#ListAttachedPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the policies attached to the specified thing group.

", "smithy.api#http": { "method": "POST", "uri": "/attached-policies/{target}", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "policies", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListAttachedPoliciesRequest": { "type": "structure", "members": { "target": { "target": "com.amazonaws.iot#PolicyTarget", "traits": { "smithy.api#documentation": "

The group or principal for which the policies will be listed. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "recursive": { "target": "com.amazonaws.iot#Recursive", "traits": { "smithy.api#documentation": "

When true, recursively list attached policies.

", "smithy.api#httpQuery": "recursive" } }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The token to retrieve the next set of results.

", "smithy.api#httpQuery": "marker" } }, "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to be returned per request.

", "smithy.api#httpQuery": "pageSize" } } } }, "com.amazonaws.iot#ListAttachedPoliciesResponse": { "type": "structure", "members": { "policies": { "target": "com.amazonaws.iot#Policies", "traits": { "smithy.api#documentation": "

The policies.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The token to retrieve the next set of results, or ``null`` if there are no more\n results.

" } } } }, "com.amazonaws.iot#ListAuditFindings": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListAuditFindingsRequest" }, "output": { "target": "com.amazonaws.iot#ListAuditFindingsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the findings (results) of a Device Defender audit or of the audits\n performed during a specified time period. (Findings are retained for 90 days.)

", "smithy.api#http": { "method": "POST", "uri": "/audit/findings", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "findings", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListAuditFindingsRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { "smithy.api#documentation": "

A filter to limit results to the audit with the specified ID. You must\n specify either the taskId or the startTime and endTime, but not both.

" } }, "checkName": { "target": "com.amazonaws.iot#AuditCheckName", "traits": { "smithy.api#documentation": "

A filter to limit results to the findings for the specified audit check.

" } }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier", "traits": { "smithy.api#documentation": "

Information identifying the noncompliant resource.

" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.

" } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

A filter to limit results to those found before the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.

" } }, "listSuppressedFindings": { "target": "com.amazonaws.iot#ListSuppressedFindings", "traits": { "smithy.api#documentation": "

\n Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn't provided, the response will list both suppressed and unsuppressed findings.\n

" } } } }, "com.amazonaws.iot#ListAuditFindingsResponse": { "type": "structure", "members": { "findings": { "target": "com.amazonaws.iot#AuditFindings", "traits": { "smithy.api#documentation": "

The findings (results) of the audit.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null \n if there are no additional results.

" } } } }, "com.amazonaws.iot#ListAuditMitigationActionsExecutions": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListAuditMitigationActionsExecutionsRequest" }, "output": { "target": "com.amazonaws.iot#ListAuditMitigationActionsExecutionsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets the status of audit mitigation action tasks that were\n executed.

", "smithy.api#http": { "method": "GET", "uri": "/audit/mitigationactions/executions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "actionsExecutions", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListAuditMitigationActionsExecutionsRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

Specify this filter to limit results to actions for a specific audit mitigation actions task.

", "smithy.api#httpQuery": "taskId", "smithy.api#required": {} } }, "actionStatus": { "target": "com.amazonaws.iot#AuditMitigationActionsExecutionStatus", "traits": { "smithy.api#documentation": "

Specify this filter to limit results to those with a specific status.

", "smithy.api#httpQuery": "actionStatus" } }, "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { "smithy.api#documentation": "

Specify this filter to limit results to those that were applied to a specific audit finding.

", "smithy.api#httpQuery": "findingId", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#ListAuditMitigationActionsExecutionsResponse": { "type": "structure", "members": { "actionsExecutions": { "target": "com.amazonaws.iot#AuditMitigationActionExecutionMetadataList", "traits": { "smithy.api#documentation": "

A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

" } } } }, "com.amazonaws.iot#ListAuditMitigationActionsTasks": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListAuditMitigationActionsTasksRequest" }, "output": { "target": "com.amazonaws.iot#ListAuditMitigationActionsTasksResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets a list of audit mitigation action tasks that match the specified filters.

", "smithy.api#http": { "method": "GET", "uri": "/audit/mitigationactions/tasks", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "tasks", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListAuditMitigationActionsTasksRequest": { "type": "structure", "members": { "auditTaskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { "smithy.api#documentation": "

Specify this filter to limit results to tasks that were applied to results for a specific audit.

", "smithy.api#httpQuery": "auditTaskId" } }, "findingId": { "target": "com.amazonaws.iot#FindingId", "traits": { "smithy.api#documentation": "

Specify this filter to limit results to tasks that were applied to a specific audit finding.

", "smithy.api#httpQuery": "findingId" } }, "taskStatus": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskStatus", "traits": { "smithy.api#documentation": "

Specify this filter to limit results to tasks that are in a specific state.

", "smithy.api#httpQuery": "taskStatus" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

Specify this filter to limit results to tasks that began on or after a specific date and time.

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } } } }, "com.amazonaws.iot#ListAuditMitigationActionsTasksResponse": { "type": "structure", "members": { "tasks": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskMetadataList", "traits": { "smithy.api#documentation": "

The collection of audit mitigation tasks that matched the filter criteria.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

" } } } }, "com.amazonaws.iot#ListAuditSuppressions": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListAuditSuppressionsRequest" }, "output": { "target": "com.amazonaws.iot#ListAuditSuppressionsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Lists your Device Defender audit listings.\n

", "smithy.api#http": { "method": "POST", "uri": "/audit/suppressions/list", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "suppressions", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListAuditSuppressionsRequest": { "type": "structure", "members": { "checkName": { "target": "com.amazonaws.iot#AuditCheckName" }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier" }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

\n Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn't provided, ascendingOrder=true.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

\n The token for the next set of results.\n

" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 25.\n

" } } } }, "com.amazonaws.iot#ListAuditSuppressionsResponse": { "type": "structure", "members": { "suppressions": { "target": "com.amazonaws.iot#AuditSuppressionList", "traits": { "smithy.api#documentation": "

\n List of audit suppressions.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" } } } }, "com.amazonaws.iot#ListAuditTasks": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListAuditTasksRequest" }, "output": { "target": "com.amazonaws.iot#ListAuditTasksResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the Device Defender audits that have been performed during a given\n time period.

", "smithy.api#http": { "method": "GET", "uri": "/audit/tasks", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "tasks", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListAuditTasksRequest": { "type": "structure", "members": { "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The beginning of the time period. Audit information is retained for a \n limited time (90 days). Requesting a start time prior to what is retained \n results in an \"InvalidRequestException\".

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The end of the time period.

", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } }, "taskType": { "target": "com.amazonaws.iot#AuditTaskType", "traits": { "smithy.api#documentation": "

A filter to limit the output to the specified type of audit: can be one of\n \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".

", "smithy.api#httpQuery": "taskType" } }, "taskStatus": { "target": "com.amazonaws.iot#AuditTaskStatus", "traits": { "smithy.api#documentation": "

A filter to limit the output to audits with the specified completion\n status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".

", "smithy.api#httpQuery": "taskStatus" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListAuditTasksResponse": { "type": "structure", "members": { "tasks": { "target": "com.amazonaws.iot#AuditTaskMetadataList", "traits": { "smithy.api#documentation": "

The audits that were performed during the specified time period.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null \n if there are no additional results.

" } } } }, "com.amazonaws.iot#ListAuthorizers": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListAuthorizersRequest" }, "output": { "target": "com.amazonaws.iot#ListAuthorizersResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the authorizers registered in your account.

", "smithy.api#http": { "method": "GET", "uri": "/authorizers", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "authorizers", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListAuthorizersRequest": { "type": "structure", "members": { "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "pageSize" } }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

A marker used to get the next set of results.

", "smithy.api#httpQuery": "marker" } }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Return the list of authorizers in ascending alphabetical order.

", "smithy.api#httpQuery": "isAscendingOrder" } }, "status": { "target": "com.amazonaws.iot#AuthorizerStatus", "traits": { "smithy.api#documentation": "

The status of the list authorizers request.

", "smithy.api#httpQuery": "status" } } } }, "com.amazonaws.iot#ListAuthorizersResponse": { "type": "structure", "members": { "authorizers": { "target": "com.amazonaws.iot#Authorizers", "traits": { "smithy.api#documentation": "

The authorizers.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

A marker used to get the next set of results.

" } } } }, "com.amazonaws.iot#ListBillingGroups": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListBillingGroupsRequest" }, "output": { "target": "com.amazonaws.iot#ListBillingGroupsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the billing groups you have created.

", "smithy.api#http": { "method": "GET", "uri": "/billing-groups", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "billingGroups", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListBillingGroupsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per request.

", "smithy.api#httpQuery": "maxResults" } }, "namePrefixFilter": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

Limit the results to billing groups whose names have the given prefix.

", "smithy.api#httpQuery": "namePrefixFilter" } } } }, "com.amazonaws.iot#ListBillingGroupsResponse": { "type": "structure", "members": { "billingGroups": { "target": "com.amazonaws.iot#BillingGroupNameAndArnList", "traits": { "smithy.api#documentation": "

The list of billing groups.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListCACertificates": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListCACertificatesRequest" }, "output": { "target": "com.amazonaws.iot#ListCACertificatesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the CA certificates registered for your AWS account.

\n

The results are paginated with a default page size of 25. You can use the returned\n marker to retrieve additional results.

", "smithy.api#http": { "method": "GET", "uri": "/cacertificates", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "certificates", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListCACertificatesRequest": { "type": "structure", "members": { "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The result page size.

", "smithy.api#httpQuery": "pageSize" } }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results.

", "smithy.api#httpQuery": "marker" } }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Determines the order of the results.

", "smithy.api#httpQuery": "isAscendingOrder" } } }, "traits": { "smithy.api#documentation": "

Input for the ListCACertificates operation.

" } }, "com.amazonaws.iot#ListCACertificatesResponse": { "type": "structure", "members": { "certificates": { "target": "com.amazonaws.iot#CACertificates", "traits": { "smithy.api#documentation": "

The CA certificates registered in your AWS account.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The current position within the list of CA certificates.

" } } }, "traits": { "smithy.api#documentation": "

The output from the ListCACertificates operation.

" } }, "com.amazonaws.iot#ListCertificates": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListCertificatesRequest" }, "output": { "target": "com.amazonaws.iot#ListCertificatesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the certificates registered in your AWS account.

\n

The results are paginated with a default page size of 25. You can use the returned\n marker to retrieve additional results.

", "smithy.api#http": { "method": "GET", "uri": "/certificates", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "certificates", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListCertificatesByCA": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListCertificatesByCARequest" }, "output": { "target": "com.amazonaws.iot#ListCertificatesByCAResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

List the device certificates signed by the specified CA certificate.

", "smithy.api#http": { "method": "GET", "uri": "/certificates-by-ca/{caCertificateId}", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "certificates", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListCertificatesByCARequest": { "type": "structure", "members": { "caCertificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the CA certificate. This operation will list all registered device\n certificate that were signed by this CA certificate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The result page size.

", "smithy.api#httpQuery": "pageSize" } }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results.

", "smithy.api#httpQuery": "marker" } }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Specifies the order for results. If True, the results are returned in ascending\n order, based on the creation date.

", "smithy.api#httpQuery": "isAscendingOrder" } } }, "traits": { "smithy.api#documentation": "

The input to the ListCertificatesByCA operation.

" } }, "com.amazonaws.iot#ListCertificatesByCAResponse": { "type": "structure", "members": { "certificates": { "target": "com.amazonaws.iot#Certificates", "traits": { "smithy.api#documentation": "

The device certificates signed by the specified CA certificate.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results, or null if there are no additional\n results.

" } } }, "traits": { "smithy.api#documentation": "

The output of the ListCertificatesByCA operation.

" } }, "com.amazonaws.iot#ListCertificatesRequest": { "type": "structure", "members": { "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The result page size.

", "smithy.api#httpQuery": "pageSize" } }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results.

", "smithy.api#httpQuery": "marker" } }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Specifies the order for results. If True, the results are returned in ascending\n order, based on the creation date.

", "smithy.api#httpQuery": "isAscendingOrder" } } }, "traits": { "smithy.api#documentation": "

The input for the ListCertificates operation.

" } }, "com.amazonaws.iot#ListCertificatesResponse": { "type": "structure", "members": { "certificates": { "target": "com.amazonaws.iot#Certificates", "traits": { "smithy.api#documentation": "

The descriptions of the certificates.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results, or null if there are no additional\n results.

" } } }, "traits": { "smithy.api#documentation": "

The output of the ListCertificates operation.

" } }, "com.amazonaws.iot#ListCustomMetrics": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListCustomMetricsRequest" }, "output": { "target": "com.amazonaws.iot#ListCustomMetricsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Lists your Device Defender detect custom metrics.\n

", "smithy.api#http": { "method": "GET", "uri": "/custom-metrics", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "metricNames", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListCustomMetricsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

\n The token for the next set of results.\n

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 25.\n

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListCustomMetricsResponse": { "type": "structure", "members": { "metricNames": { "target": "com.amazonaws.iot#MetricNames", "traits": { "smithy.api#documentation": "

\n The name of the custom metric.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, \n or null if there are no additional results.\n

" } } } }, "com.amazonaws.iot#ListDetectMitigationActionsExecutions": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListDetectMitigationActionsExecutionsRequest" }, "output": { "target": "com.amazonaws.iot#ListDetectMitigationActionsExecutionsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Lists mitigation actions executions for a Device Defender ML Detect Security Profile.\n

", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/executions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "actionsExecutions", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListDetectMitigationActionsExecutionsRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

\n The unique identifier of the task.\n

", "smithy.api#httpQuery": "taskId" } }, "violationId": { "target": "com.amazonaws.iot#ViolationId", "traits": { "smithy.api#documentation": "

\n The unique identifier of the violation.\n

", "smithy.api#httpQuery": "violationId" } }, "thingName": { "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { "smithy.api#documentation": "

\n The name of the thing whose mitigation actions are listed.\n

", "smithy.api#httpQuery": "thingName" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.\n

", "smithy.api#httpQuery": "startTime" } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The end of the time period for which ML Detect mitigation actions executions are returned.\n

", "smithy.api#httpQuery": "endTime" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

\n The maximum number of results to return at one time. The default is 25.\n

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

\n The token for the next set of results.\n

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#ListDetectMitigationActionsExecutionsResponse": { "type": "structure", "members": { "actionsExecutions": { "target": "com.amazonaws.iot#DetectMitigationActionExecutionList", "traits": { "smithy.api#documentation": "

\n List of actions executions.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" } } } }, "com.amazonaws.iot#ListDetectMitigationActionsTasks": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListDetectMitigationActionsTasksRequest" }, "output": { "target": "com.amazonaws.iot#ListDetectMitigationActionsTasksResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n List of Device Defender ML Detect mitigation actions tasks.\n

", "smithy.api#http": { "method": "GET", "uri": "/detect/mitigationactions/tasks", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "tasks", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListDetectMitigationActionsTasksRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

\n The token for the next set of results.\n

", "smithy.api#httpQuery": "nextToken" } }, "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n A filter to limit results to those found after the specified time. You must\n specify either the startTime and endTime or the taskId, but not both.\n

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The end of the time period for which ML Detect mitigation actions tasks are returned.\n

", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } } } }, "com.amazonaws.iot#ListDetectMitigationActionsTasksResponse": { "type": "structure", "members": { "tasks": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskSummaryList", "traits": { "smithy.api#documentation": "

\n The collection of ML Detect mitigation tasks that matched the filter criteria.\n

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

\n A token that can be used to retrieve the next set of results, or null if there are no additional results.\n

" } } } }, "com.amazonaws.iot#ListDimensions": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListDimensionsRequest" }, "output": { "target": "com.amazonaws.iot#ListDimensionsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

List the set of dimensions that are defined for your AWS account.

", "smithy.api#http": { "method": "GET", "uri": "/dimensions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "dimensionNames", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListDimensionsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to retrieve at one time.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListDimensionsResponse": { "type": "structure", "members": { "dimensionNames": { "target": "com.amazonaws.iot#DimensionNames", "traits": { "smithy.api#documentation": "

A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListDomainConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListDomainConfigurationsRequest" }, "output": { "target": "com.amazonaws.iot#ListDomainConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/domainConfigurations", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "domainConfigurations", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListDomainConfigurationsRequest": { "type": "structure", "members": { "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results.

", "smithy.api#httpQuery": "marker" } }, "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The result page size.

", "smithy.api#httpQuery": "pageSize" } }, "serviceType": { "target": "com.amazonaws.iot#ServiceType", "traits": { "smithy.api#documentation": "

The type of service delivered by the endpoint.

", "smithy.api#httpQuery": "serviceType" } } } }, "com.amazonaws.iot#ListDomainConfigurationsResponse": { "type": "structure", "members": { "domainConfigurations": { "target": "com.amazonaws.iot#DomainConfigurations", "traits": { "smithy.api#documentation": "

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

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results.

" } } } }, "com.amazonaws.iot#ListIndices": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListIndicesRequest" }, "output": { "target": "com.amazonaws.iot#ListIndicesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the search indices.

", "smithy.api#http": { "method": "GET", "uri": "/indices", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "indexNames", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListIndicesRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional\n results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#QueryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListIndicesResponse": { "type": "structure", "members": { "indexNames": { "target": "com.amazonaws.iot#IndexNamesList", "traits": { "smithy.api#documentation": "

The index names.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional\n results.

" } } } }, "com.amazonaws.iot#ListJobExecutionsForJob": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListJobExecutionsForJobRequest" }, "output": { "target": "com.amazonaws.iot#ListJobExecutionsForJobResponse" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the job executions for a job.

", "smithy.api#http": { "method": "GET", "uri": "/jobs/{jobId}/things", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "executionSummaries", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListJobExecutionsForJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The unique identifier you assigned to this job when it was created.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.iot#JobExecutionStatus", "traits": { "smithy.api#documentation": "

The status of the job.

", "smithy.api#httpQuery": "status" } }, "maxResults": { "target": "com.amazonaws.iot#LaserMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to be returned per request.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#ListJobExecutionsForJobResponse": { "type": "structure", "members": { "executionSummaries": { "target": "com.amazonaws.iot#JobExecutionSummaryForJobList", "traits": { "smithy.api#documentation": "

A list of job execution summaries.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results, or null if there are no\n additional results.

" } } } }, "com.amazonaws.iot#ListJobExecutionsForThing": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListJobExecutionsForThingRequest" }, "output": { "target": "com.amazonaws.iot#ListJobExecutionsForThingResponse" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the job executions for the specified thing.

", "smithy.api#http": { "method": "GET", "uri": "/things/{thingName}/jobs", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "executionSummaries", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListJobExecutionsForThingRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The thing name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.iot#JobExecutionStatus", "traits": { "smithy.api#documentation": "

An optional filter that lets you search for jobs that have the specified status.

", "smithy.api#httpQuery": "status" } }, "namespaceId": { "target": "com.amazonaws.iot#NamespaceId", "traits": { "smithy.api#documentation": "

The namespace used to indicate that a job is a customer-managed job.

\n

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that \n contain the value in the following format.

\n

\n $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/\n

\n \n

The namespaceId feature is in public preview.

\n
", "smithy.api#httpQuery": "namespaceId" } }, "maxResults": { "target": "com.amazonaws.iot#LaserMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to be returned per request.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#ListJobExecutionsForThingResponse": { "type": "structure", "members": { "executionSummaries": { "target": "com.amazonaws.iot#JobExecutionSummaryForThingList", "traits": { "smithy.api#documentation": "

A list of job execution summaries.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results, or null if there are no\n additional results.

" } } } }, "com.amazonaws.iot#ListJobTemplates": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListJobTemplatesRequest" }, "output": { "target": "com.amazonaws.iot#ListJobTemplatesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Returns a list of job templates.

", "smithy.api#http": { "method": "GET", "uri": "/job-templates", "code": 200 } } }, "com.amazonaws.iot#ListJobTemplatesRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.iot#LaserMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in the list.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to return the next set of results in the list.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#ListJobTemplatesResponse": { "type": "structure", "members": { "jobTemplates": { "target": "com.amazonaws.iot#JobTemplateSummaryList", "traits": { "smithy.api#documentation": "

A list of objects that contain information about the job templates.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results, or null if there are no\n additional results.

" } } } }, "com.amazonaws.iot#ListJobs": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListJobsRequest" }, "output": { "target": "com.amazonaws.iot#ListJobsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists jobs.

", "smithy.api#http": { "method": "GET", "uri": "/jobs", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "jobs", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListJobsRequest": { "type": "structure", "members": { "status": { "target": "com.amazonaws.iot#JobStatus", "traits": { "smithy.api#documentation": "

An optional filter that lets you search for jobs that have the specified status.

", "smithy.api#httpQuery": "status" } }, "targetSelection": { "target": "com.amazonaws.iot#TargetSelection", "traits": { "smithy.api#documentation": "

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things\n specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing\n when a change is detected in a target. For example, a job will run on a thing when the thing is added to a\n target group, even after the job was completed by all things originally in the group.

", "smithy.api#httpQuery": "targetSelection" } }, "maxResults": { "target": "com.amazonaws.iot#LaserMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per request.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

A filter that limits the returned jobs to those for the specified group.

", "smithy.api#httpQuery": "thingGroupName" } }, "thingGroupId": { "target": "com.amazonaws.iot#ThingGroupId", "traits": { "smithy.api#documentation": "

A filter that limits the returned jobs to those for the specified group.

", "smithy.api#httpQuery": "thingGroupId" } }, "namespaceId": { "target": "com.amazonaws.iot#NamespaceId", "traits": { "smithy.api#documentation": "

The namespace used to indicate that a job is a customer-managed job.

\n

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that \n contain the value in the following format.

\n

\n $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/\n

\n \n

The namespaceId feature is in public preview.

\n
", "smithy.api#httpQuery": "namespaceId" } } } }, "com.amazonaws.iot#ListJobsResponse": { "type": "structure", "members": { "jobs": { "target": "com.amazonaws.iot#JobSummaryList", "traits": { "smithy.api#documentation": "

A list of jobs.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results, or null if there are no\n additional results.

" } } } }, "com.amazonaws.iot#ListMitigationActions": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListMitigationActionsRequest" }, "output": { "target": "com.amazonaws.iot#ListMitigationActionsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Gets a list of all mitigation actions that match the specified filter criteria.

", "smithy.api#http": { "method": "GET", "uri": "/mitigationactions/actions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "actionIdentifiers", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListMitigationActionsRequest": { "type": "structure", "members": { "actionType": { "target": "com.amazonaws.iot#MitigationActionType", "traits": { "smithy.api#documentation": "

Specify a value to limit the result to mitigation actions with a specific action type.

", "smithy.api#httpQuery": "actionType" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#ListMitigationActionsResponse": { "type": "structure", "members": { "actionIdentifiers": { "target": "com.amazonaws.iot#MitigationActionIdentifierList", "traits": { "smithy.api#documentation": "

A set of actions that matched the specified filter criteria.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

" } } } }, "com.amazonaws.iot#ListOTAUpdates": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListOTAUpdatesRequest" }, "output": { "target": "com.amazonaws.iot#ListOTAUpdatesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists OTA updates.

", "smithy.api#http": { "method": "GET", "uri": "/otaUpdates", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "otaUpdates", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListOTAUpdatesRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token used to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "otaUpdateStatus": { "target": "com.amazonaws.iot#OTAUpdateStatus", "traits": { "smithy.api#documentation": "

The OTA update job status.

", "smithy.api#httpQuery": "otaUpdateStatus" } } } }, "com.amazonaws.iot#ListOTAUpdatesResponse": { "type": "structure", "members": { "otaUpdates": { "target": "com.amazonaws.iot#OTAUpdatesSummary", "traits": { "smithy.api#documentation": "

A list of OTA update jobs.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token to use to get the next set of results.

" } } } }, "com.amazonaws.iot#ListOutgoingCertificates": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListOutgoingCertificatesRequest" }, "output": { "target": "com.amazonaws.iot#ListOutgoingCertificatesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists certificates that are being transferred but not yet accepted.

", "smithy.api#http": { "method": "GET", "uri": "/certificates-out-going", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "outgoingCertificates", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListOutgoingCertificatesRequest": { "type": "structure", "members": { "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The result page size.

", "smithy.api#httpQuery": "pageSize" } }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results.

", "smithy.api#httpQuery": "marker" } }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Specifies the order for results. If True, the results are returned in ascending\n order, based on the creation date.

", "smithy.api#httpQuery": "isAscendingOrder" } } }, "traits": { "smithy.api#documentation": "

The input to the ListOutgoingCertificates operation.

" } }, "com.amazonaws.iot#ListOutgoingCertificatesResponse": { "type": "structure", "members": { "outgoingCertificates": { "target": "com.amazonaws.iot#OutgoingCertificates", "traits": { "smithy.api#documentation": "

The certificates that are being transferred but not yet accepted.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results.

" } } }, "traits": { "smithy.api#documentation": "

The output from the ListOutgoingCertificates operation.

" } }, "com.amazonaws.iot#ListPolicies": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListPoliciesRequest" }, "output": { "target": "com.amazonaws.iot#ListPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists your policies.

", "smithy.api#http": { "method": "GET", "uri": "/policies", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "policies", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListPoliciesRequest": { "type": "structure", "members": { "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results.

", "smithy.api#httpQuery": "marker" } }, "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The result page size.

", "smithy.api#httpQuery": "pageSize" } }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Specifies the order for results. If true, the results are returned in ascending\n creation order.

", "smithy.api#httpQuery": "isAscendingOrder" } } }, "traits": { "smithy.api#documentation": "

The input for the ListPolicies operation.

" } }, "com.amazonaws.iot#ListPoliciesResponse": { "type": "structure", "members": { "policies": { "target": "com.amazonaws.iot#Policies", "traits": { "smithy.api#documentation": "

The descriptions of the policies.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results, or null if there are no additional\n results.

" } } }, "traits": { "smithy.api#documentation": "

The output from the ListPolicies operation.

" } }, "com.amazonaws.iot#ListPolicyPrincipals": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListPolicyPrincipalsRequest" }, "output": { "target": "com.amazonaws.iot#ListPolicyPrincipalsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

Lists the principals associated with the specified policy.

\n

\n Note: This API is deprecated. Please use ListTargetsForPolicy instead.

", "smithy.api#http": { "method": "GET", "uri": "/policy-principals", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "principals", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListPolicyPrincipalsRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

", "smithy.api#httpHeader": "x-amzn-iot-policy", "smithy.api#required": {} } }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results.

", "smithy.api#httpQuery": "marker" } }, "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The result page size.

", "smithy.api#httpQuery": "pageSize" } }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Specifies the order for results. If true, the results are returned in ascending\n creation order.

", "smithy.api#httpQuery": "isAscendingOrder" } } }, "traits": { "smithy.api#documentation": "

The input for the ListPolicyPrincipals operation.

" } }, "com.amazonaws.iot#ListPolicyPrincipalsResponse": { "type": "structure", "members": { "principals": { "target": "com.amazonaws.iot#Principals", "traits": { "smithy.api#documentation": "

The descriptions of the principals.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results, or null if there are no additional\n results.

" } } }, "traits": { "smithy.api#documentation": "

The output from the ListPolicyPrincipals operation.

" } }, "com.amazonaws.iot#ListPolicyVersions": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListPolicyVersionsRequest" }, "output": { "target": "com.amazonaws.iot#ListPolicyVersionsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the versions of the specified policy and identifies the default\n version.

", "smithy.api#http": { "method": "GET", "uri": "/policies/{policyName}/version", "code": 200 } } }, "com.amazonaws.iot#ListPolicyVersionsRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the ListPolicyVersions operation.

" } }, "com.amazonaws.iot#ListPolicyVersionsResponse": { "type": "structure", "members": { "policyVersions": { "target": "com.amazonaws.iot#PolicyVersions", "traits": { "smithy.api#documentation": "

The policy versions.

" } } }, "traits": { "smithy.api#documentation": "

The output from the ListPolicyVersions operation.

" } }, "com.amazonaws.iot#ListPrincipalPolicies": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListPrincipalPoliciesRequest" }, "output": { "target": "com.amazonaws.iot#ListPrincipalPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

Lists the policies attached to the specified principal. If you use an Cognito\n identity, the ID must be in AmazonCognito Identity format.

\n

\n Note: This API is deprecated. Please use ListAttachedPolicies instead.

", "smithy.api#http": { "method": "GET", "uri": "/principal-policies", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "policies", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListPrincipalPoliciesRequest": { "type": "structure", "members": { "principal": { "target": "com.amazonaws.iot#Principal", "traits": { "smithy.api#documentation": "

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

", "smithy.api#httpHeader": "x-amzn-iot-principal", "smithy.api#required": {} } }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results.

", "smithy.api#httpQuery": "marker" } }, "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The result page size.

", "smithy.api#httpQuery": "pageSize" } }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Specifies the order for results. If true, results are returned in ascending creation\n order.

", "smithy.api#httpQuery": "isAscendingOrder" } } }, "traits": { "smithy.api#documentation": "

The input for the ListPrincipalPolicies operation.

" } }, "com.amazonaws.iot#ListPrincipalPoliciesResponse": { "type": "structure", "members": { "policies": { "target": "com.amazonaws.iot#Policies", "traits": { "smithy.api#documentation": "

The policies.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

The marker for the next set of results, or null if there are no additional\n results.

" } } }, "traits": { "smithy.api#documentation": "

The output from the ListPrincipalPolicies operation.

" } }, "com.amazonaws.iot#ListPrincipalThings": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListPrincipalThingsRequest" }, "output": { "target": "com.amazonaws.iot#ListPrincipalThingsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the things associated with the specified principal. A principal can be X.509\n\t\t\tcertificates, IAM users, groups, and roles, Amazon Cognito identities or federated\n\t\t\tidentities.

", "smithy.api#http": { "method": "GET", "uri": "/principals/things", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "things", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListPrincipalThingsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in this operation.

", "smithy.api#httpQuery": "maxResults" } }, "principal": { "target": "com.amazonaws.iot#Principal", "traits": { "smithy.api#documentation": "

The principal.

", "smithy.api#httpHeader": "x-amzn-principal", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the ListPrincipalThings operation.

" } }, "com.amazonaws.iot#ListPrincipalThingsResponse": { "type": "structure", "members": { "things": { "target": "com.amazonaws.iot#ThingNameList", "traits": { "smithy.api#documentation": "

The things.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } }, "traits": { "smithy.api#documentation": "

The output from the ListPrincipalThings operation.

" } }, "com.amazonaws.iot#ListProvisioningTemplateVersions": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListProvisioningTemplateVersionsRequest" }, "output": { "target": "com.amazonaws.iot#ListProvisioningTemplateVersionsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

A list of fleet provisioning template versions.

", "smithy.api#http": { "method": "GET", "uri": "/provisioning-templates/{templateName}/versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "versions", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListProvisioningTemplateVersionsRequest": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provisioning template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#ListProvisioningTemplateVersionsResponse": { "type": "structure", "members": { "versions": { "target": "com.amazonaws.iot#ProvisioningTemplateVersionListing", "traits": { "smithy.api#documentation": "

The list of fleet provisioning template versions.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token to retrieve the next set of results.

" } } } }, "com.amazonaws.iot#ListProvisioningTemplates": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListProvisioningTemplatesRequest" }, "output": { "target": "com.amazonaws.iot#ListProvisioningTemplatesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the fleet provisioning templates in your AWS account.

", "smithy.api#http": { "method": "GET", "uri": "/provisioning-templates", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "templates", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListProvisioningTemplatesRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token to retrieve the next set of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#ListProvisioningTemplatesResponse": { "type": "structure", "members": { "templates": { "target": "com.amazonaws.iot#ProvisioningTemplateListing", "traits": { "smithy.api#documentation": "

A list of fleet provisioning templates

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token to retrieve the next set of results.

" } } } }, "com.amazonaws.iot#ListRoleAliases": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListRoleAliasesRequest" }, "output": { "target": "com.amazonaws.iot#ListRoleAliasesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the role aliases registered in your account.

", "smithy.api#http": { "method": "GET", "uri": "/role-aliases", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "roleAliases", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListRoleAliasesRequest": { "type": "structure", "members": { "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "pageSize" } }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

A marker used to get the next set of results.

", "smithy.api#httpQuery": "marker" } }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Return the list of role aliases in ascending alphabetical order.

", "smithy.api#httpQuery": "isAscendingOrder" } } } }, "com.amazonaws.iot#ListRoleAliasesResponse": { "type": "structure", "members": { "roleAliases": { "target": "com.amazonaws.iot#RoleAliases", "traits": { "smithy.api#documentation": "

The role aliases.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

A marker used to get the next set of results.

" } } } }, "com.amazonaws.iot#ListScheduledAudits": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListScheduledAuditsRequest" }, "output": { "target": "com.amazonaws.iot#ListScheduledAuditsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists all of your scheduled audits.

", "smithy.api#http": { "method": "GET", "uri": "/audit/scheduledaudits", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "scheduledAudits", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListScheduledAuditsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time. The default is 25.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListScheduledAuditsResponse": { "type": "structure", "members": { "scheduledAudits": { "target": "com.amazonaws.iot#ScheduledAuditMetadataList", "traits": { "smithy.api#documentation": "

The list of scheduled audits.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, \n or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListSecurityProfiles": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListSecurityProfilesRequest" }, "output": { "target": "com.amazonaws.iot#ListSecurityProfilesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the Device Defender security profiles\n you've\n created. You can filter security profiles by dimension or custom metric.

\n \n

\n dimensionName and metricName cannot be used in the same request.

\n
", "smithy.api#http": { "method": "GET", "uri": "/security-profiles", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "securityProfileIdentifiers", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListSecurityProfilesForTarget": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListSecurityProfilesForTargetRequest" }, "output": { "target": "com.amazonaws.iot#ListSecurityProfilesForTargetResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the Device Defender security profiles attached to a target (thing group).

", "smithy.api#http": { "method": "GET", "uri": "/security-profiles-for-target", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "securityProfileTargetMappings", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListSecurityProfilesForTargetRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } }, "recursive": { "target": "com.amazonaws.iot#Recursive", "traits": { "smithy.api#documentation": "

If true, return child groups too.

", "smithy.api#httpQuery": "recursive" } }, "securityProfileTargetArn": { "target": "com.amazonaws.iot#SecurityProfileTargetArn", "traits": { "smithy.api#documentation": "

The ARN of the target (thing group) whose attached security profiles you want to get.

", "smithy.api#httpQuery": "securityProfileTargetArn", "smithy.api#required": {} } } } }, "com.amazonaws.iot#ListSecurityProfilesForTargetResponse": { "type": "structure", "members": { "securityProfileTargetMappings": { "target": "com.amazonaws.iot#SecurityProfileTargetMappings", "traits": { "smithy.api#documentation": "

A list of security profiles and their associated targets.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" } } } }, "com.amazonaws.iot#ListSecurityProfilesRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } }, "dimensionName": { "target": "com.amazonaws.iot#DimensionName", "traits": { "smithy.api#documentation": "

A filter to limit results to the security profiles that use the defined dimension.\n Cannot be used with metricName\n

", "smithy.api#httpQuery": "dimensionName" } }, "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { "smithy.api#documentation": "

The name of the custom metric.\n Cannot be used with dimensionName.

", "smithy.api#httpQuery": "metricName" } } } }, "com.amazonaws.iot#ListSecurityProfilesResponse": { "type": "structure", "members": { "securityProfileIdentifiers": { "target": "com.amazonaws.iot#SecurityProfileIdentifiers", "traits": { "smithy.api#documentation": "

A list of security profile identifiers (names and ARNs).

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" } } } }, "com.amazonaws.iot#ListStreams": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListStreamsRequest" }, "output": { "target": "com.amazonaws.iot#ListStreamsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists all of the streams in your AWS account.

", "smithy.api#http": { "method": "GET", "uri": "/streams", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "streams", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListStreamsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at a time.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token used to get the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "ascendingOrder": { "target": "com.amazonaws.iot#AscendingOrder", "traits": { "smithy.api#documentation": "

Set to true to return the list of streams in ascending order.

", "smithy.api#httpQuery": "isAscendingOrder" } } } }, "com.amazonaws.iot#ListStreamsResponse": { "type": "structure", "members": { "streams": { "target": "com.amazonaws.iot#StreamsSummary", "traits": { "smithy.api#documentation": "

A list of streams.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token used to get the next set of results.

" } } } }, "com.amazonaws.iot#ListSuppressedAlerts": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#ListSuppressedFindings": { "type": "boolean" }, "com.amazonaws.iot#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.iot#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the tags (metadata) you have assigned to the resource.

", "smithy.api#http": { "method": "GET", "uri": "/tags", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "tags" } } }, "com.amazonaws.iot#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.iot#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

The list of tags assigned to the resource.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListTargetsForPolicy": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListTargetsForPolicyRequest" }, "output": { "target": "com.amazonaws.iot#ListTargetsForPolicyResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

List targets for the specified policy.

", "smithy.api#http": { "method": "POST", "uri": "/policy-targets/{policyName}", "code": 200 }, "smithy.api#paginated": { "inputToken": "marker", "outputToken": "nextMarker", "items": "targets", "pageSize": "pageSize" } } }, "com.amazonaws.iot#ListTargetsForPolicyRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "marker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

A marker used to get the next set of results.

", "smithy.api#httpQuery": "marker" } }, "pageSize": { "target": "com.amazonaws.iot#PageSize", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "pageSize" } } } }, "com.amazonaws.iot#ListTargetsForPolicyResponse": { "type": "structure", "members": { "targets": { "target": "com.amazonaws.iot#PolicyTargets", "traits": { "smithy.api#documentation": "

The policy targets.

" } }, "nextMarker": { "target": "com.amazonaws.iot#Marker", "traits": { "smithy.api#documentation": "

A marker used to get the next set of results.

" } } } }, "com.amazonaws.iot#ListTargetsForSecurityProfile": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListTargetsForSecurityProfileRequest" }, "output": { "target": "com.amazonaws.iot#ListTargetsForSecurityProfileResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the targets (thing groups) associated with a given Device Defender security profile.

", "smithy.api#http": { "method": "GET", "uri": "/security-profiles/{securityProfileName}/targets", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "securityProfileTargets", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListTargetsForSecurityProfileRequest": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The security profile.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListTargetsForSecurityProfileResponse": { "type": "structure", "members": { "securityProfileTargets": { "target": "com.amazonaws.iot#SecurityProfileTargets", "traits": { "smithy.api#documentation": "

The thing groups to which the security profile is attached.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" } } } }, "com.amazonaws.iot#ListThingGroups": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListThingGroupsRequest" }, "output": { "target": "com.amazonaws.iot#ListThingGroupsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

List the thing groups in your account.

", "smithy.api#http": { "method": "GET", "uri": "/thing-groups", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "thingGroups", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingGroupsForThing": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListThingGroupsForThingRequest" }, "output": { "target": "com.amazonaws.iot#ListThingGroupsForThingResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

List the thing groups to which the specified thing belongs.

", "smithy.api#http": { "method": "GET", "uri": "/things/{thingName}/thing-groups", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "thingGroups", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingGroupsForThingRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The thing name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListThingGroupsForThingResponse": { "type": "structure", "members": { "thingGroups": { "target": "com.amazonaws.iot#ThingGroupNameAndArnList", "traits": { "smithy.api#documentation": "

The thing groups.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListThingGroupsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } }, "parentGroup": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

A filter that limits the results to those with the specified parent group.

", "smithy.api#httpQuery": "parentGroup" } }, "namePrefixFilter": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

A filter that limits the results to those with the specified name prefix.

", "smithy.api#httpQuery": "namePrefixFilter" } }, "recursive": { "target": "com.amazonaws.iot#RecursiveWithoutDefault", "traits": { "smithy.api#documentation": "

If true, return child groups as well.

", "smithy.api#httpQuery": "recursive" } } } }, "com.amazonaws.iot#ListThingGroupsResponse": { "type": "structure", "members": { "thingGroups": { "target": "com.amazonaws.iot#ThingGroupNameAndArnList", "traits": { "smithy.api#documentation": "

The thing groups.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results. Will not be returned if operation has returned all results.

" } } } }, "com.amazonaws.iot#ListThingPrincipals": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListThingPrincipalsRequest" }, "output": { "target": "com.amazonaws.iot#ListThingPrincipalsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the principals associated with the specified thing. A principal can be X.509\n\t\t\tcertificates, IAM users, groups, and roles, Amazon Cognito identities or federated\n\t\t\tidentities.

", "smithy.api#http": { "method": "GET", "uri": "/things/{thingName}/principals", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "principals", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingPrincipalsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in this operation.

", "smithy.api#httpQuery": "maxResults" } }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the ListThingPrincipal operation.

" } }, "com.amazonaws.iot#ListThingPrincipalsResponse": { "type": "structure", "members": { "principals": { "target": "com.amazonaws.iot#Principals", "traits": { "smithy.api#documentation": "

The principals associated with the thing.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } }, "traits": { "smithy.api#documentation": "

The output from the ListThingPrincipals operation.

" } }, "com.amazonaws.iot#ListThingRegistrationTaskReports": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListThingRegistrationTaskReportsRequest" }, "output": { "target": "com.amazonaws.iot#ListThingRegistrationTaskReportsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Information about the thing registration tasks.

", "smithy.api#http": { "method": "GET", "uri": "/thing-registration-tasks/{taskId}/reports", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "resourceLinks", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingRegistrationTaskReportsRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#TaskId", "traits": { "smithy.api#documentation": "

The id of the task.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "reportType": { "target": "com.amazonaws.iot#ReportType", "traits": { "smithy.api#documentation": "

The type of task report.

", "smithy.api#httpQuery": "reportType", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per request.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListThingRegistrationTaskReportsResponse": { "type": "structure", "members": { "resourceLinks": { "target": "com.amazonaws.iot#S3FileUrlList", "traits": { "smithy.api#documentation": "

Links to the task resources.

" } }, "reportType": { "target": "com.amazonaws.iot#ReportType", "traits": { "smithy.api#documentation": "

The type of task report.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListThingRegistrationTasks": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListThingRegistrationTasksRequest" }, "output": { "target": "com.amazonaws.iot#ListThingRegistrationTasksResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

List bulk thing provisioning tasks.

", "smithy.api#http": { "method": "GET", "uri": "/thing-registration-tasks", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "taskIds", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingRegistrationTasksRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } }, "status": { "target": "com.amazonaws.iot#Status", "traits": { "smithy.api#documentation": "

The status of the bulk thing provisioning task.

", "smithy.api#httpQuery": "status" } } } }, "com.amazonaws.iot#ListThingRegistrationTasksResponse": { "type": "structure", "members": { "taskIds": { "target": "com.amazonaws.iot#TaskIdList", "traits": { "smithy.api#documentation": "

A list of bulk thing provisioning task IDs.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListThingTypes": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListThingTypesRequest" }, "output": { "target": "com.amazonaws.iot#ListThingTypesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists the existing thing types.

", "smithy.api#http": { "method": "GET", "uri": "/thing-types", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "thingTypes", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingTypesRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in this operation.

", "smithy.api#httpQuery": "maxResults" } }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type.

", "smithy.api#httpQuery": "thingTypeName" } } }, "traits": { "smithy.api#documentation": "

The input for the ListThingTypes operation.

" } }, "com.amazonaws.iot#ListThingTypesResponse": { "type": "structure", "members": { "thingTypes": { "target": "com.amazonaws.iot#ThingTypeList", "traits": { "smithy.api#documentation": "

The thing types.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results. Will not be returned if operation has returned all results.

" } } }, "traits": { "smithy.api#documentation": "

The output for the ListThingTypes operation.

" } }, "com.amazonaws.iot#ListThings": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListThingsRequest" }, "output": { "target": "com.amazonaws.iot#ListThingsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists your things. Use the attributeName and\n\t\t\t\tattributeValue parameters to filter your things.\n\t\t\tFor example, calling ListThings with attributeName=Color and\n\t\t\tattributeValue=Red retrieves all things in the registry that contain an attribute\n\t\t\t\tColor with the value Red.

\n\t\t \n\t\t\t

You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

\n\t\t
", "smithy.api#http": { "method": "GET", "uri": "/things", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "things", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingsInBillingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListThingsInBillingGroupRequest" }, "output": { "target": "com.amazonaws.iot#ListThingsInBillingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

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

", "smithy.api#http": { "method": "GET", "uri": "/billing-groups/{billingGroupName}/things", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "things", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingsInBillingGroupRequest": { "type": "structure", "members": { "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name of the billing group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return per request.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListThingsInBillingGroupResponse": { "type": "structure", "members": { "things": { "target": "com.amazonaws.iot#ThingNameList", "traits": { "smithy.api#documentation": "

A list of things in the billing group.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results. Will not be returned if operation has returned all results.

" } } } }, "com.amazonaws.iot#ListThingsInThingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListThingsInThingGroupRequest" }, "output": { "target": "com.amazonaws.iot#ListThingsInThingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the things in the specified group.

", "smithy.api#http": { "method": "GET", "uri": "/thing-groups/{thingGroupName}/things", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "things", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListThingsInThingGroupRequest": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The thing group name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "recursive": { "target": "com.amazonaws.iot#Recursive", "traits": { "smithy.api#documentation": "

When true, list things in this thing group and in all child groups as\n\t\t\twell.

", "smithy.api#httpQuery": "recursive" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListThingsInThingGroupResponse": { "type": "structure", "members": { "things": { "target": "com.amazonaws.iot#ThingNameList", "traits": { "smithy.api#documentation": "

The things in the specified thing group.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListThingsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n\t\t\tvalue from a previous response; otherwise null to receive\n\t\t\tthe first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#RegistryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return in this operation.

", "smithy.api#httpQuery": "maxResults" } }, "attributeName": { "target": "com.amazonaws.iot#AttributeName", "traits": { "smithy.api#documentation": "

The attribute name used to search for things.

", "smithy.api#httpQuery": "attributeName" } }, "attributeValue": { "target": "com.amazonaws.iot#AttributeValue", "traits": { "smithy.api#documentation": "

The attribute value used to search for things.

", "smithy.api#httpQuery": "attributeValue" } }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type used to search for things.

", "smithy.api#httpQuery": "thingTypeName" } }, "usePrefixAttributeValue": { "target": "com.amazonaws.iot#usePrefixAttributeValue", "traits": { "smithy.api#documentation": "

When true, the action returns the thing resources with attribute values\n that start with the attributeValue provided.

\n

When false, or not present, the action returns only the thing\n\t\t\tresources with attribute values that match the entire attributeValue\n\t\t\tprovided.

", "smithy.api#httpQuery": "usePrefixAttributeValue" } } }, "traits": { "smithy.api#documentation": "

The input for the ListThings operation.

" } }, "com.amazonaws.iot#ListThingsResponse": { "type": "structure", "members": { "things": { "target": "com.amazonaws.iot#ThingAttributeList", "traits": { "smithy.api#documentation": "

The things.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results. Will not be returned if operation has returned all results.

" } } }, "traits": { "smithy.api#documentation": "

The output from the ListThings operation.

" } }, "com.amazonaws.iot#ListTopicRuleDestinations": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListTopicRuleDestinationsRequest" }, "output": { "target": "com.amazonaws.iot#ListTopicRuleDestinationsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Lists all the topic rule destinations in your AWS account.

", "smithy.api#http": { "method": "GET", "uri": "/destinations", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "destinationSummaries", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListTopicRuleDestinationsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.iot#TopicRuleDestinationMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n value from a previous response; otherwise null to receive\n the first set of results.

", "smithy.api#httpQuery": "nextToken" } } } }, "com.amazonaws.iot#ListTopicRuleDestinationsResponse": { "type": "structure", "members": { "destinationSummaries": { "target": "com.amazonaws.iot#TopicRuleDestinationSummaries", "traits": { "smithy.api#documentation": "

Information about a topic rule destination.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListTopicRules": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListTopicRulesRequest" }, "output": { "target": "com.amazonaws.iot#ListTopicRulesResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Lists the rules for the specific topic.

", "smithy.api#http": { "method": "GET", "uri": "/rules", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "rules", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListTopicRulesRequest": { "type": "structure", "members": { "topic": { "target": "com.amazonaws.iot#Topic", "traits": { "smithy.api#documentation": "

The topic.

", "smithy.api#httpQuery": "topic" } }, "maxResults": { "target": "com.amazonaws.iot#TopicRuleMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return.

", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n value from a previous response; otherwise null to receive\n the first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "ruleDisabled": { "target": "com.amazonaws.iot#IsDisabled", "traits": { "smithy.api#documentation": "

Specifies whether the rule is disabled.

", "smithy.api#httpQuery": "ruleDisabled" } } }, "traits": { "smithy.api#documentation": "

The input for the ListTopicRules operation.

" } }, "com.amazonaws.iot#ListTopicRulesResponse": { "type": "structure", "members": { "rules": { "target": "com.amazonaws.iot#TopicRuleList", "traits": { "smithy.api#documentation": "

The rules.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } }, "traits": { "smithy.api#documentation": "

The output from the ListTopicRules operation.

" } }, "com.amazonaws.iot#ListV2LoggingLevels": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListV2LoggingLevelsRequest" }, "output": { "target": "com.amazonaws.iot#ListV2LoggingLevelsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#NotConfiguredException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Lists logging levels.

", "smithy.api#http": { "method": "GET", "uri": "/v2LoggingLevel", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "logTargetConfigurations", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListV2LoggingLevelsRequest": { "type": "structure", "members": { "targetType": { "target": "com.amazonaws.iot#LogTargetType", "traits": { "smithy.api#documentation": "

The type of resource for which you are configuring logging. Must be\n THING_Group.

", "smithy.api#httpQuery": "targetType" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n value from a previous response; otherwise null to receive\n the first set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#SkyfallMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListV2LoggingLevelsResponse": { "type": "structure", "members": { "logTargetConfigurations": { "target": "com.amazonaws.iot#LogTargetConfigurations", "traits": { "smithy.api#documentation": "

The logging configuration for a target.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } } } }, "com.amazonaws.iot#ListViolationEvents": { "type": "operation", "input": { "target": "com.amazonaws.iot#ListViolationEventsRequest" }, "output": { "target": "com.amazonaws.iot#ListViolationEventsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Lists the Device Defender security profile violations discovered during the given time period. \n You can use filters to limit the results to those alerts issued for a particular security profile, \n behavior, or thing (device).

", "smithy.api#http": { "method": "GET", "uri": "/violation-events", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "violationEvents", "pageSize": "maxResults" } } }, "com.amazonaws.iot#ListViolationEventsRequest": { "type": "structure", "members": { "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The start time for the alerts to be listed.

", "smithy.api#httpQuery": "startTime", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The end time for the alerts to be listed.

", "smithy.api#httpQuery": "endTime", "smithy.api#required": {} } }, "thingName": { "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { "smithy.api#documentation": "

A filter to limit results to those alerts caused by the specified thing.

", "smithy.api#httpQuery": "thingName" } }, "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

A filter to limit results to those alerts generated by the specified security profile.

", "smithy.api#httpQuery": "securityProfileName" } }, "behaviorCriteriaType": { "target": "com.amazonaws.iot#BehaviorCriteriaType", "traits": { "smithy.api#documentation": "

\n The criteria for a behavior.\n

", "smithy.api#httpQuery": "behaviorCriteriaType" } }, "listSuppressedAlerts": { "target": "com.amazonaws.iot#ListSuppressedAlerts", "traits": { "smithy.api#documentation": "

\n A list of all suppressed alerts.\n

", "smithy.api#httpQuery": "listSuppressedAlerts" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token for the next set of results.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.iot#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.iot#ListViolationEventsResponse": { "type": "structure", "members": { "violationEvents": { "target": "com.amazonaws.iot#ViolationEvents", "traits": { "smithy.api#documentation": "

The security profile violation alerts issued for this account during the given time period, \n potentially filtered by security profile, behavior violated, or thing (device) violating.

" } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

A token that can be used to retrieve the next set of results, or null if there are no\n additional results.

" } } } }, "com.amazonaws.iot#LogGroupName": { "type": "string" }, "com.amazonaws.iot#LogLevel": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DEBUG", "name": "DEBUG" }, { "value": "INFO", "name": "INFO" }, { "value": "ERROR", "name": "ERROR" }, { "value": "WARN", "name": "WARN" }, { "value": "DISABLED", "name": "DISABLED" } ] } }, "com.amazonaws.iot#LogTarget": { "type": "structure", "members": { "targetType": { "target": "com.amazonaws.iot#LogTargetType", "traits": { "smithy.api#documentation": "

The target type.

", "smithy.api#required": {} } }, "targetName": { "target": "com.amazonaws.iot#LogTargetName", "traits": { "smithy.api#documentation": "

The target name.

" } } }, "traits": { "smithy.api#documentation": "

A log target.

" } }, "com.amazonaws.iot#LogTargetConfiguration": { "type": "structure", "members": { "logTarget": { "target": "com.amazonaws.iot#LogTarget", "traits": { "smithy.api#documentation": "

A log target

" } }, "logLevel": { "target": "com.amazonaws.iot#LogLevel", "traits": { "smithy.api#documentation": "

The logging level.

" } } }, "traits": { "smithy.api#documentation": "

The target configuration.

" } }, "com.amazonaws.iot#LogTargetConfigurations": { "type": "list", "member": { "target": "com.amazonaws.iot#LogTargetConfiguration" } }, "com.amazonaws.iot#LogTargetName": { "type": "string" }, "com.amazonaws.iot#LogTargetType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DEFAULT", "name": "DEFAULT" }, { "value": "THING_GROUP", "name": "THING_GROUP" } ] } }, "com.amazonaws.iot#LoggingOptionsPayload": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants access.

", "smithy.api#required": {} } }, "logLevel": { "target": "com.amazonaws.iot#LogLevel", "traits": { "smithy.api#documentation": "

The log level.

" } } }, "traits": { "smithy.api#documentation": "

Describes the logging options payload.

" } }, "com.amazonaws.iot#MachineLearningDetectionConfig": { "type": "structure", "members": { "confidenceLevel": { "target": "com.amazonaws.iot#ConfidenceLevel", "traits": { "smithy.api#documentation": "

\n The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.\n

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

\n The configuration of an ML Detect Security Profile.\n

" } }, "com.amazonaws.iot#MalformedPolicyException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The policy documentation is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#Marker": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "[A-Za-z0-9+/]+={0,2}" } }, "com.amazonaws.iot#MaxJobExecutionsPerMin": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.iot#MaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 250 } } }, "com.amazonaws.iot#Maximum": { "type": "double" }, "com.amazonaws.iot#MaximumPerMinute": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.iot#Message": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 } } }, "com.amazonaws.iot#MessageFormat": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "RAW", "name": "RAW" }, { "value": "JSON", "name": "JSON" } ] } }, "com.amazonaws.iot#MessageId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 } } }, "com.amazonaws.iot#MetricDimension": { "type": "structure", "members": { "dimensionName": { "target": "com.amazonaws.iot#DimensionName", "traits": { "smithy.api#documentation": "

A unique identifier for the dimension.

", "smithy.api#required": {} } }, "operator": { "target": "com.amazonaws.iot#DimensionValueOperator", "traits": { "smithy.api#documentation": "

Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

" } } }, "traits": { "smithy.api#documentation": "

The dimension of a metric.

" } }, "com.amazonaws.iot#MetricName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#MetricNames": { "type": "list", "member": { "target": "com.amazonaws.iot#MetricName" } }, "com.amazonaws.iot#MetricToRetain": { "type": "structure", "members": { "metric": { "target": "com.amazonaws.iot#BehaviorMetric", "traits": { "smithy.api#documentation": "

What is measured by the behavior.

", "smithy.api#required": {} } }, "metricDimension": { "target": "com.amazonaws.iot#MetricDimension", "traits": { "smithy.api#documentation": "

The dimension of a metric. This can't be used with custom metrics.

" } } }, "traits": { "smithy.api#documentation": "

The metric you want to retain. Dimensions are optional.

" } }, "com.amazonaws.iot#MetricValue": { "type": "structure", "members": { "count": { "target": "com.amazonaws.iot#UnsignedLong", "traits": { "smithy.api#documentation": "

If the comparisonOperator calls for a numeric value, use this \n to specify that numeric value to be compared with the metric.

" } }, "cidrs": { "target": "com.amazonaws.iot#Cidrs", "traits": { "smithy.api#documentation": "

If the comparisonOperator calls for a set of CIDRs, use this\n to specify that set to be compared with the metric.

" } }, "ports": { "target": "com.amazonaws.iot#Ports", "traits": { "smithy.api#documentation": "

If the comparisonOperator calls for a set of ports, use this\n to specify that set to be compared with the metric.

" } }, "number": { "target": "com.amazonaws.iot#Number", "traits": { "smithy.api#documentation": "

\n The numeral value of a metric.\n

" } }, "numbers": { "target": "com.amazonaws.iot#NumberList", "traits": { "smithy.api#documentation": "

\n The numeral values of a metric.\n

" } }, "strings": { "target": "com.amazonaws.iot#StringList", "traits": { "smithy.api#documentation": "

\n The string values of a metric.\n

" } } }, "traits": { "smithy.api#documentation": "

The value to be compared with the metric.

" } }, "com.amazonaws.iot#Minimum": { "type": "double" }, "com.amazonaws.iot#MinimumNumberOfExecutedThings": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.iot#MissingContextValue": { "type": "string" }, "com.amazonaws.iot#MissingContextValues": { "type": "list", "member": { "target": "com.amazonaws.iot#MissingContextValue" } }, "com.amazonaws.iot#MitigationAction": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { "smithy.api#documentation": "

A user-friendly name for the mitigation action.

" } }, "id": { "target": "com.amazonaws.iot#MitigationActionId", "traits": { "smithy.api#documentation": "

A unique identifier for the mitigation action.

" } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The IAM role ARN used to apply this mitigation action.

" } }, "actionParams": { "target": "com.amazonaws.iot#MitigationActionParams", "traits": { "smithy.api#documentation": "

The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.

" } } }, "traits": { "smithy.api#documentation": "

Describes which changes should be applied as part of a mitigation action.

" } }, "com.amazonaws.iot#MitigationActionArn": { "type": "string" }, "com.amazonaws.iot#MitigationActionId": { "type": "string" }, "com.amazonaws.iot#MitigationActionIdentifier": { "type": "structure", "members": { "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { "smithy.api#documentation": "

The friendly name of the mitigation action.

" } }, "actionArn": { "target": "com.amazonaws.iot#MitigationActionArn", "traits": { "smithy.api#documentation": "

The IAM role ARN used to apply this mitigation action.

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date when this mitigation action was created.

" } } }, "traits": { "smithy.api#documentation": "

Information that identifies a mitigation action. This information is returned by ListMitigationActions.

" } }, "com.amazonaws.iot#MitigationActionIdentifierList": { "type": "list", "member": { "target": "com.amazonaws.iot#MitigationActionIdentifier" } }, "com.amazonaws.iot#MitigationActionList": { "type": "list", "member": { "target": "com.amazonaws.iot#MitigationAction" } }, "com.amazonaws.iot#MitigationActionName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.iot#MitigationActionNameList": { "type": "list", "member": { "target": "com.amazonaws.iot#MitigationActionName" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.iot#MitigationActionParams": { "type": "structure", "members": { "updateDeviceCertificateParams": { "target": "com.amazonaws.iot#UpdateDeviceCertificateParams", "traits": { "smithy.api#documentation": "

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

" } }, "updateCACertificateParams": { "target": "com.amazonaws.iot#UpdateCACertificateParams", "traits": { "smithy.api#documentation": "

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

" } }, "addThingsToThingGroupParams": { "target": "com.amazonaws.iot#AddThingsToThingGroupParams", "traits": { "smithy.api#documentation": "

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

" } }, "replaceDefaultPolicyVersionParams": { "target": "com.amazonaws.iot#ReplaceDefaultPolicyVersionParams", "traits": { "smithy.api#documentation": "

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

" } }, "enableIoTLoggingParams": { "target": "com.amazonaws.iot#EnableIoTLoggingParams", "traits": { "smithy.api#documentation": "

Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.

" } }, "publishFindingToSnsParams": { "target": "com.amazonaws.iot#PublishFindingToSnsParams", "traits": { "smithy.api#documentation": "

Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

" } } }, "traits": { "smithy.api#documentation": "

The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).

" } }, "com.amazonaws.iot#MitigationActionType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "UPDATE_DEVICE_CERTIFICATE", "name": "UPDATE_DEVICE_CERTIFICATE" }, { "value": "UPDATE_CA_CERTIFICATE", "name": "UPDATE_CA_CERTIFICATE" }, { "value": "ADD_THINGS_TO_THING_GROUP", "name": "ADD_THINGS_TO_THING_GROUP" }, { "value": "REPLACE_DEFAULT_POLICY_VERSION", "name": "REPLACE_DEFAULT_POLICY_VERSION" }, { "value": "ENABLE_IOT_LOGGING", "name": "ENABLE_IOT_LOGGING" }, { "value": "PUBLISH_FINDING_TO_SNS", "name": "PUBLISH_FINDING_TO_SNS" } ] } }, "com.amazonaws.iot#MitigationActionsTaskId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.iot#ModelStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PENDING_BUILD", "name": "PENDING_BUILD" }, { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "EXPIRED", "name": "EXPIRED" } ] } }, "com.amazonaws.iot#MqttClientId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65535 } } }, "com.amazonaws.iot#MqttContext": { "type": "structure", "members": { "username": { "target": "com.amazonaws.iot#MqttUsername", "traits": { "smithy.api#documentation": "

The value of the username key in an MQTT authorization request.

" } }, "password": { "target": "com.amazonaws.iot#MqttPassword", "traits": { "smithy.api#documentation": "

The value of the password key in an MQTT authorization request.

" } }, "clientId": { "target": "com.amazonaws.iot#MqttClientId", "traits": { "smithy.api#documentation": "

The value of the clientId key in an MQTT authorization request.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the MQTT context to use for the test authorizer request

" } }, "com.amazonaws.iot#MqttPassword": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 65535 } } }, "com.amazonaws.iot#MqttUsername": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65535 } } }, "com.amazonaws.iot#NamespaceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.iot#NextToken": { "type": "string" }, "com.amazonaws.iot#NonCompliantChecksCount": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#NonCompliantResource": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.iot#ResourceType", "traits": { "smithy.api#documentation": "

The type of the noncompliant resource.

" } }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier", "traits": { "smithy.api#documentation": "

Information that identifies the noncompliant resource.

" } }, "additionalInfo": { "target": "com.amazonaws.iot#StringMap", "traits": { "smithy.api#documentation": "

Other information about the noncompliant resource.

" } } }, "traits": { "smithy.api#documentation": "

Information about the resource that was noncompliant with the audit check.

" } }, "com.amazonaws.iot#NonCompliantResourcesCount": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#NotConfiguredException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The resource is not configured.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.iot#NullableBoolean": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#Number": { "type": "double", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#NumberList": { "type": "list", "member": { "target": "com.amazonaws.iot#Number" } }, "com.amazonaws.iot#NumberOfThings": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "com.amazonaws.iot#OTAUpdateArn": { "type": "string" }, "com.amazonaws.iot#OTAUpdateDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2028 }, "smithy.api#pattern": "[^\\p{C}]+" } }, "com.amazonaws.iot#OTAUpdateErrorMessage": { "type": "string" }, "com.amazonaws.iot#OTAUpdateFile": { "type": "structure", "members": { "fileName": { "target": "com.amazonaws.iot#FileName", "traits": { "smithy.api#documentation": "

The name of the file.

" } }, "fileType": { "target": "com.amazonaws.iot#FileType", "traits": { "smithy.api#documentation": "

An integer value you can include in the job document to allow your devices to identify the type of file received \n from the cloud.

" } }, "fileVersion": { "target": "com.amazonaws.iot#OTAUpdateFileVersion", "traits": { "smithy.api#documentation": "

The file version.

" } }, "fileLocation": { "target": "com.amazonaws.iot#FileLocation", "traits": { "smithy.api#documentation": "

The location of the updated firmware.

" } }, "codeSigning": { "target": "com.amazonaws.iot#CodeSigning", "traits": { "smithy.api#documentation": "

The code signing method of the file.

" } }, "attributes": { "target": "com.amazonaws.iot#AttributesMap", "traits": { "smithy.api#documentation": "

A list of name/attribute pairs.

" } } }, "traits": { "smithy.api#documentation": "

Describes a file to be associated with an OTA update.

" } }, "com.amazonaws.iot#OTAUpdateFileVersion": { "type": "string" }, "com.amazonaws.iot#OTAUpdateFiles": { "type": "list", "member": { "target": "com.amazonaws.iot#OTAUpdateFile" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.iot#OTAUpdateId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.iot#OTAUpdateInfo": { "type": "structure", "members": { "otaUpdateId": { "target": "com.amazonaws.iot#OTAUpdateId", "traits": { "smithy.api#documentation": "

The OTA update ID.

" } }, "otaUpdateArn": { "target": "com.amazonaws.iot#OTAUpdateArn", "traits": { "smithy.api#documentation": "

The OTA update ARN.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the OTA update was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the OTA update was last updated.

" } }, "description": { "target": "com.amazonaws.iot#OTAUpdateDescription", "traits": { "smithy.api#documentation": "

A description of the OTA update.

" } }, "targets": { "target": "com.amazonaws.iot#Targets", "traits": { "smithy.api#documentation": "

The targets of the OTA update.

" } }, "protocols": { "target": "com.amazonaws.iot#Protocols", "traits": { "smithy.api#documentation": "

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both\n HTTP and MQTT are specified, the target device can choose the protocol.

" } }, "awsJobExecutionsRolloutConfig": { "target": "com.amazonaws.iot#AwsJobExecutionsRolloutConfig", "traits": { "smithy.api#documentation": "

Configuration for the rollout of OTA updates.

" } }, "awsJobPresignedUrlConfig": { "target": "com.amazonaws.iot#AwsJobPresignedUrlConfig", "traits": { "smithy.api#documentation": "

Configuration information for pre-signed URLs. Valid when protocols\n contains HTTP.

" } }, "targetSelection": { "target": "com.amazonaws.iot#TargetSelection", "traits": { "smithy.api#documentation": "

Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those\n things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also\n be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when\n the thing is added to a target group, even after the OTA update was completed by all things originally in\n the group.

" } }, "otaUpdateFiles": { "target": "com.amazonaws.iot#OTAUpdateFiles", "traits": { "smithy.api#documentation": "

A list of files associated with the OTA update.

" } }, "otaUpdateStatus": { "target": "com.amazonaws.iot#OTAUpdateStatus", "traits": { "smithy.api#documentation": "

The status of the OTA update.

" } }, "awsIotJobId": { "target": "com.amazonaws.iot#AwsIotJobId", "traits": { "smithy.api#documentation": "

The AWS IoT job ID associated with the OTA update.

" } }, "awsIotJobArn": { "target": "com.amazonaws.iot#AwsIotJobArn", "traits": { "smithy.api#documentation": "

The AWS IoT job ARN associated with the OTA update.

" } }, "errorInfo": { "target": "com.amazonaws.iot#ErrorInfo", "traits": { "smithy.api#documentation": "

Error information associated with the OTA update.

" } }, "additionalParameters": { "target": "com.amazonaws.iot#AdditionalParameterMap", "traits": { "smithy.api#documentation": "

A collection of name/value pairs

" } } }, "traits": { "smithy.api#documentation": "

Information about an OTA update.

" } }, "com.amazonaws.iot#OTAUpdateStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CREATE_PENDING", "name": "CREATE_PENDING" }, { "value": "CREATE_IN_PROGRESS", "name": "CREATE_IN_PROGRESS" }, { "value": "CREATE_COMPLETE", "name": "CREATE_COMPLETE" }, { "value": "CREATE_FAILED", "name": "CREATE_FAILED" } ] } }, "com.amazonaws.iot#OTAUpdateSummary": { "type": "structure", "members": { "otaUpdateId": { "target": "com.amazonaws.iot#OTAUpdateId", "traits": { "smithy.api#documentation": "

The OTA update ID.

" } }, "otaUpdateArn": { "target": "com.amazonaws.iot#OTAUpdateArn", "traits": { "smithy.api#documentation": "

The OTA update ARN.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the OTA update was created.

" } } }, "traits": { "smithy.api#documentation": "

An OTA update summary.

" } }, "com.amazonaws.iot#OTAUpdatesSummary": { "type": "list", "member": { "target": "com.amazonaws.iot#OTAUpdateSummary" } }, "com.amazonaws.iot#OptionalVersion": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#OutgoingCertificate": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The certificate ARN.

" } }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The certificate ID.

" } }, "transferredTo": { "target": "com.amazonaws.iot#AwsAccountId", "traits": { "smithy.api#documentation": "

The AWS account to which the transfer was made.

" } }, "transferDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the transfer was initiated.

" } }, "transferMessage": { "target": "com.amazonaws.iot#Message", "traits": { "smithy.api#documentation": "

The transfer message.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The certificate creation date.

" } } }, "traits": { "smithy.api#documentation": "

A certificate that has been transferred but not yet accepted.

" } }, "com.amazonaws.iot#OutgoingCertificates": { "type": "list", "member": { "target": "com.amazonaws.iot#OutgoingCertificate" } }, "com.amazonaws.iot#OverrideDynamicGroups": { "type": "boolean" }, "com.amazonaws.iot#PageSize": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 250 } } }, "com.amazonaws.iot#Parameter": { "type": "string" }, "com.amazonaws.iot#Parameters": { "type": "map", "key": { "target": "com.amazonaws.iot#Parameter" }, "value": { "target": "com.amazonaws.iot#Value" } }, "com.amazonaws.iot#PartitionKey": { "type": "string" }, "com.amazonaws.iot#PayloadField": { "type": "string" }, "com.amazonaws.iot#PayloadVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 32 }, "smithy.api#pattern": "^[0-9-]+$" } }, "com.amazonaws.iot#Percent": { "type": "double", "traits": { "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.iot#PercentList": { "type": "list", "member": { "target": "com.amazonaws.iot#Percent" } }, "com.amazonaws.iot#PercentPair": { "type": "structure", "members": { "percent": { "target": "com.amazonaws.iot#Percent", "traits": { "smithy.api#documentation": "

The percentile.

" } }, "value": { "target": "com.amazonaws.iot#PercentValue", "traits": { "smithy.api#documentation": "

The value of the percentile.

" } } }, "traits": { "smithy.api#documentation": "

Describes the percentile and percentile value.

" } }, "com.amazonaws.iot#PercentValue": { "type": "double" }, "com.amazonaws.iot#Percentage": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.iot#Percentiles": { "type": "list", "member": { "target": "com.amazonaws.iot#PercentPair" } }, "com.amazonaws.iot#Platform": { "type": "string" }, "com.amazonaws.iot#Policies": { "type": "list", "member": { "target": "com.amazonaws.iot#Policy" } }, "com.amazonaws.iot#Policy": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

" } }, "policyArn": { "target": "com.amazonaws.iot#PolicyArn", "traits": { "smithy.api#documentation": "

The policy ARN.

" } } }, "traits": { "smithy.api#documentation": "

Describes an AWS IoT policy.

" } }, "com.amazonaws.iot#PolicyArn": { "type": "string" }, "com.amazonaws.iot#PolicyDocument": { "type": "string" }, "com.amazonaws.iot#PolicyDocuments": { "type": "list", "member": { "target": "com.amazonaws.iot#PolicyDocument" } }, "com.amazonaws.iot#PolicyName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[\\w+=,.@-]+" } }, "com.amazonaws.iot#PolicyNames": { "type": "list", "member": { "target": "com.amazonaws.iot#PolicyName" } }, "com.amazonaws.iot#PolicyTarget": { "type": "string" }, "com.amazonaws.iot#PolicyTargets": { "type": "list", "member": { "target": "com.amazonaws.iot#PolicyTarget" } }, "com.amazonaws.iot#PolicyTemplateName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "BLANK_POLICY", "name": "BLANK_POLICY" } ] } }, "com.amazonaws.iot#PolicyVersion": { "type": "structure", "members": { "versionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The policy version ID.

" } }, "isDefaultVersion": { "target": "com.amazonaws.iot#IsDefaultVersion", "traits": { "smithy.api#documentation": "

Specifies whether the policy version is the default.

" } }, "createDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date and time the policy was created.

" } } }, "traits": { "smithy.api#documentation": "

Describes a policy version.

" } }, "com.amazonaws.iot#PolicyVersionId": { "type": "string", "traits": { "smithy.api#pattern": "[0-9]+" } }, "com.amazonaws.iot#PolicyVersionIdentifier": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The name of the policy.

" } }, "policyVersionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The ID of the version of the policy associated with the resource.

" } } }, "traits": { "smithy.api#documentation": "

Information about the version of the policy associated with the resource.

" } }, "com.amazonaws.iot#PolicyVersions": { "type": "list", "member": { "target": "com.amazonaws.iot#PolicyVersion" } }, "com.amazonaws.iot#Port": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 65535 } } }, "com.amazonaws.iot#Ports": { "type": "list", "member": { "target": "com.amazonaws.iot#Port" } }, "com.amazonaws.iot#Prefix": { "type": "string" }, "com.amazonaws.iot#PresignedUrlConfig": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job\n data/updates are stored. The role must also grant permission for IoT to download the files.

" } }, "expiresInSec": { "target": "com.amazonaws.iot#ExpiresInSec", "traits": { "smithy.api#documentation": "

How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600\n seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.

" } } }, "traits": { "smithy.api#documentation": "

Configuration for pre-signed S3 URLs.

" } }, "com.amazonaws.iot#PrimitiveBoolean": { "type": "boolean" }, "com.amazonaws.iot#Principal": { "type": "string" }, "com.amazonaws.iot#PrincipalArn": { "type": "string" }, "com.amazonaws.iot#PrincipalId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9]+" } }, "com.amazonaws.iot#Principals": { "type": "list", "member": { "target": "com.amazonaws.iot#PrincipalArn" } }, "com.amazonaws.iot#PrivateKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#sensitive": {} } }, "com.amazonaws.iot#ProcessingTargetName": { "type": "string" }, "com.amazonaws.iot#ProcessingTargetNameList": { "type": "list", "member": { "target": "com.amazonaws.iot#ProcessingTargetName" } }, "com.amazonaws.iot#Protocol": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "MQTT", "name": "MQTT" }, { "value": "HTTP", "name": "HTTP" } ] } }, "com.amazonaws.iot#Protocols": { "type": "list", "member": { "target": "com.amazonaws.iot#Protocol" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.iot#ProvisioningHook": { "type": "structure", "members": { "payloadVersion": { "target": "com.amazonaws.iot#PayloadVersion", "traits": { "smithy.api#documentation": "

The payload that was sent to the target function.

\n

\n Note: Only Lambda functions are currently supported.

" } }, "targetArn": { "target": "com.amazonaws.iot#TargetArn", "traits": { "smithy.api#documentation": "

The ARN of the target function.

\n

\n Note: Only Lambda functions are currently supported.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Structure that contains payloadVersion and\n targetArn.

" } }, "com.amazonaws.iot#ProvisioningTemplateListing": { "type": "list", "member": { "target": "com.amazonaws.iot#ProvisioningTemplateSummary" } }, "com.amazonaws.iot#ProvisioningTemplateSummary": { "type": "structure", "members": { "templateArn": { "target": "com.amazonaws.iot#TemplateArn", "traits": { "smithy.api#documentation": "

The ARN of the fleet provisioning template.

" } }, "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provisioning template.

" } }, "description": { "target": "com.amazonaws.iot#TemplateDescription", "traits": { "smithy.api#documentation": "

The description of the fleet provisioning template.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the fleet provisioning template summary was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the fleet provisioning template summary was last modified.

" } }, "enabled": { "target": "com.amazonaws.iot#Enabled", "traits": { "smithy.api#documentation": "

True if the fleet provision template is enabled, otherwise false.

" } } }, "traits": { "smithy.api#documentation": "

A summary of information about a fleet provisioning template.

" } }, "com.amazonaws.iot#ProvisioningTemplateVersionListing": { "type": "list", "member": { "target": "com.amazonaws.iot#ProvisioningTemplateVersionSummary" } }, "com.amazonaws.iot#ProvisioningTemplateVersionSummary": { "type": "structure", "members": { "versionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { "smithy.api#documentation": "

The ID of the fleet privisioning template version.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the fleet provisioning template version was created

" } }, "isDefaultVersion": { "target": "com.amazonaws.iot#IsDefaultVersion", "traits": { "smithy.api#documentation": "

True if the fleet provisioning template version is the default version, otherwise\n false.

" } } }, "traits": { "smithy.api#documentation": "

A summary of information about a fleet provision template version.

" } }, "com.amazonaws.iot#PublicKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#PublicKeyMap": { "type": "map", "key": { "target": "com.amazonaws.iot#KeyName" }, "value": { "target": "com.amazonaws.iot#KeyValue" } }, "com.amazonaws.iot#PublishFindingToSnsParams": { "type": "structure", "members": { "topicArn": { "target": "com.amazonaws.iot#SnsTopicArn", "traits": { "smithy.api#documentation": "

The ARN of the topic to which you want to publish the findings.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

" } }, "com.amazonaws.iot#PutAssetPropertyValueEntry": { "type": "structure", "members": { "entryId": { "target": "com.amazonaws.iot#AssetPropertyEntryId", "traits": { "smithy.api#documentation": "

Optional. A unique identifier for this entry that you can define to better track which\n message caused an error in case of failure. Accepts substitution templates. Defaults to a new\n UUID.

" } }, "assetId": { "target": "com.amazonaws.iot#AssetId", "traits": { "smithy.api#documentation": "

The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias\n or both an aliasId and a propertyId. Accepts substitution\n templates.

" } }, "propertyId": { "target": "com.amazonaws.iot#AssetPropertyId", "traits": { "smithy.api#documentation": "

The ID of the asset's property. You must specify either a propertyAlias or\n both an aliasId and a propertyId. Accepts substitution\n templates.

" } }, "propertyAlias": { "target": "com.amazonaws.iot#AssetPropertyAlias", "traits": { "smithy.api#documentation": "

The name of the property alias associated with your asset property. You must specify\n either a propertyAlias or both an aliasId and a\n propertyId. Accepts substitution templates.

" } }, "propertyValues": { "target": "com.amazonaws.iot#AssetPropertyValueList", "traits": { "smithy.api#documentation": "

A list of property values to insert that each contain timestamp, quality, and value (TQV)\n information.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An asset property value entry containing the following information.

" } }, "com.amazonaws.iot#PutAssetPropertyValueEntryList": { "type": "list", "member": { "target": "com.amazonaws.iot#PutAssetPropertyValueEntry" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#PutItemInput": { "type": "structure", "members": { "tableName": { "target": "com.amazonaws.iot#TableName", "traits": { "smithy.api#documentation": "

The table where the message data will be written.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the DynamoActionVS action that specifies the DynamoDB table to which\n the message data will be written.

" } }, "com.amazonaws.iot#Qos": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 1 } } }, "com.amazonaws.iot#QueryMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 500 } } }, "com.amazonaws.iot#QueryString": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#QueryVersion": { "type": "string" }, "com.amazonaws.iot#QueueUrl": { "type": "string" }, "com.amazonaws.iot#QueuedThings": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#RangeKeyField": { "type": "string" }, "com.amazonaws.iot#RangeKeyValue": { "type": "string" }, "com.amazonaws.iot#RateIncreaseCriteria": { "type": "structure", "members": { "numberOfNotifiedThings": { "target": "com.amazonaws.iot#NumberOfThings", "traits": { "smithy.api#documentation": "

The threshold for number of notified things that will initiate the increase in rate of rollout.

" } }, "numberOfSucceededThings": { "target": "com.amazonaws.iot#NumberOfThings", "traits": { "smithy.api#documentation": "

The threshold for number of succeeded things that will initiate the increase in rate of rollout.

" } } }, "traits": { "smithy.api#documentation": "

Allows you to define a criteria to initiate the increase in rate of rollout for a job.

" } }, "com.amazonaws.iot#ReasonCode": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 }, "smithy.api#pattern": "[\\p{Upper}\\p{Digit}_]+" } }, "com.amazonaws.iot#ReasonForNonCompliance": { "type": "string" }, "com.amazonaws.iot#ReasonForNonComplianceCode": { "type": "string" }, "com.amazonaws.iot#ReasonForNonComplianceCodes": { "type": "list", "member": { "target": "com.amazonaws.iot#ReasonForNonComplianceCode" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.iot#Recursive": { "type": "boolean" }, "com.amazonaws.iot#RecursiveWithoutDefault": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#RegisterCACertificate": { "type": "operation", "input": { "target": "com.amazonaws.iot#RegisterCACertificateRequest" }, "output": { "target": "com.amazonaws.iot#RegisterCACertificateResponse" }, "errors": [ { "target": "com.amazonaws.iot#CertificateValidationException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#RegistrationCodeValidationException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign\n device certificates, which can be then registered with AWS IoT. You can register up to 10\n CA certificates per AWS account that have the same subject field. This enables you to have\n up to 10 certificate authorities sign your device certificates. If you have more than one\n CA certificate registered, make sure you pass the CA certificate when you register your\n device certificates with the RegisterCertificate API.

", "smithy.api#http": { "method": "POST", "uri": "/cacertificate", "code": 200 } } }, "com.amazonaws.iot#RegisterCACertificateRequest": { "type": "structure", "members": { "caCertificate": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The CA certificate.

", "smithy.api#required": {} } }, "verificationCertificate": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The private key verification certificate.

", "smithy.api#required": {} } }, "setAsActive": { "target": "com.amazonaws.iot#SetAsActive", "traits": { "smithy.api#documentation": "

A boolean value that specifies if the CA certificate is set to active.

", "smithy.api#httpQuery": "setAsActive" } }, "allowAutoRegistration": { "target": "com.amazonaws.iot#AllowAutoRegistration", "traits": { "smithy.api#documentation": "

Allows this CA certificate to be used for auto registration of device\n certificates.

", "smithy.api#httpQuery": "allowAutoRegistration" } }, "registrationConfig": { "target": "com.amazonaws.iot#RegistrationConfig", "traits": { "smithy.api#documentation": "

Information about the registration configuration.

" } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

Metadata which can be used to manage the CA certificate.

\n \n

For URI Request parameters use format: ...key1=value1&key2=value2...

\n

For the CLI command-line parameter use format: &&tags\n \"key1=value1&key2=value2...\"

\n

For the cli-input-json file use format: \"tags\":\n \"key1=value1&key2=value2...\"

\n
" } } }, "traits": { "smithy.api#documentation": "

The input to the RegisterCACertificate operation.

" } }, "com.amazonaws.iot#RegisterCACertificateResponse": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The CA certificate ARN.

" } }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The CA certificate identifier.

" } } }, "traits": { "smithy.api#documentation": "

The output from the RegisterCACertificateResponse operation.

" } }, "com.amazonaws.iot#RegisterCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iot#RegisterCertificateRequest" }, "output": { "target": "com.amazonaws.iot#RegisterCertificateResponse" }, "errors": [ { "target": "com.amazonaws.iot#CertificateConflictException" }, { "target": "com.amazonaws.iot#CertificateStateException" }, { "target": "com.amazonaws.iot#CertificateValidationException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Registers a device certificate with AWS IoT. If you have more than one CA certificate\n that has the same subject field, you must specify the CA certificate that was used to sign\n the device certificate being registered.

", "smithy.api#http": { "method": "POST", "uri": "/certificate/register", "code": 200 } } }, "com.amazonaws.iot#RegisterCertificateRequest": { "type": "structure", "members": { "certificatePem": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The certificate data, in PEM format.

", "smithy.api#required": {} } }, "caCertificatePem": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The CA certificate used to sign the device certificate being registered.

" } }, "setAsActive": { "target": "com.amazonaws.iot#SetAsActiveFlag", "traits": { "smithy.api#deprecated": {}, "smithy.api#documentation": "

A boolean value that specifies if the certificate is set to active.

", "smithy.api#httpQuery": "setAsActive" } }, "status": { "target": "com.amazonaws.iot#CertificateStatus", "traits": { "smithy.api#documentation": "

The status of the register certificate request.

" } } }, "traits": { "smithy.api#documentation": "

The input to the RegisterCertificate operation.

" } }, "com.amazonaws.iot#RegisterCertificateResponse": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The certificate ARN.

" } }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The certificate identifier.

" } } }, "traits": { "smithy.api#documentation": "

The output from the RegisterCertificate operation.

" } }, "com.amazonaws.iot#RegisterCertificateWithoutCA": { "type": "operation", "input": { "target": "com.amazonaws.iot#RegisterCertificateWithoutCARequest" }, "output": { "target": "com.amazonaws.iot#RegisterCertificateWithoutCAResponse" }, "errors": [ { "target": "com.amazonaws.iot#CertificateStateException" }, { "target": "com.amazonaws.iot#CertificateValidationException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Register a certificate that does not have a certificate authority (CA).

", "smithy.api#http": { "method": "POST", "uri": "/certificate/register-no-ca", "code": 200 } } }, "com.amazonaws.iot#RegisterCertificateWithoutCARequest": { "type": "structure", "members": { "certificatePem": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The certificate data, in PEM format.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.iot#CertificateStatus", "traits": { "smithy.api#documentation": "

The status of the register certificate request.

" } } } }, "com.amazonaws.iot#RegisterCertificateWithoutCAResponse": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the registered certificate.

" } }, "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the registered certificate. (The last part of the certificate ARN contains the\n certificate ID.

" } } } }, "com.amazonaws.iot#RegisterThing": { "type": "operation", "input": { "target": "com.amazonaws.iot#RegisterThingRequest" }, "output": { "target": "com.amazonaws.iot#RegisterThingResponse" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceRegistrationFailureException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Provisions a thing in the device registry. RegisterThing calls other AWS IoT control\n plane APIs. These calls might exceed your account level \n AWS IoT Throttling Limits and cause throttle errors. Please contact AWS Customer Support to raise\n your throttling limits if necessary.

", "smithy.api#http": { "method": "POST", "uri": "/things", "code": 200 } } }, "com.amazonaws.iot#RegisterThingRequest": { "type": "structure", "members": { "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { "smithy.api#documentation": "

The provisioning template. See Provisioning Devices That Have Device Certificates for more information.

", "smithy.api#required": {} } }, "parameters": { "target": "com.amazonaws.iot#Parameters", "traits": { "smithy.api#documentation": "

The parameters for provisioning a thing. See Provisioning Templates for more information.

" } } } }, "com.amazonaws.iot#RegisterThingResponse": { "type": "structure", "members": { "certificatePem": { "target": "com.amazonaws.iot#CertificatePem", "traits": { "smithy.api#documentation": "

The certificate data, in PEM format.

" } }, "resourceArns": { "target": "com.amazonaws.iot#ResourceArns", "traits": { "smithy.api#documentation": "

ARNs for the generated resources.

" } } } }, "com.amazonaws.iot#RegistrationCode": { "type": "string", "traits": { "smithy.api#length": { "min": 64, "max": 64 }, "smithy.api#pattern": "(0x)?[a-fA-F0-9]+" } }, "com.amazonaws.iot#RegistrationCodeValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

Additional information about the exception.

" } } }, "traits": { "smithy.api#documentation": "

The registration code is invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#RegistrationConfig": { "type": "structure", "members": { "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { "smithy.api#documentation": "

The template body.

" } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the role.

" } } }, "traits": { "smithy.api#documentation": "

The registration configuration.

" } }, "com.amazonaws.iot#RegistryMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 250 } } }, "com.amazonaws.iot#RegistryS3BucketName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 256 }, "smithy.api#pattern": "[a-zA-Z0-9._-]+" } }, "com.amazonaws.iot#RegistryS3KeyName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "[a-zA-Z0-9!_.*'()-\\/]+" } }, "com.amazonaws.iot#RejectCertificateTransfer": { "type": "operation", "input": { "target": "com.amazonaws.iot#RejectCertificateTransferRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#TransferAlreadyCompletedException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer,\n the certificate status changes from PENDING_TRANSFER to\n INACTIVE.

\n

To check for pending certificate transfers, call ListCertificates\n to enumerate your certificates.

\n

This operation can only be called by the transfer destination. After it is called,\n the certificate will be returned to the source's account in the INACTIVE state.

", "smithy.api#http": { "method": "PATCH", "uri": "/reject-certificate-transfer/{certificateId}", "code": 200 } } }, "com.amazonaws.iot#RejectCertificateTransferRequest": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "rejectReason": { "target": "com.amazonaws.iot#Message", "traits": { "smithy.api#documentation": "

The reason the certificate transfer was rejected.

" } } }, "traits": { "smithy.api#documentation": "

The input for the RejectCertificateTransfer operation.

" } }, "com.amazonaws.iot#RejectedThings": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#RelatedResource": { "type": "structure", "members": { "resourceType": { "target": "com.amazonaws.iot#ResourceType", "traits": { "smithy.api#documentation": "

The type of resource.

" } }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier", "traits": { "smithy.api#documentation": "

Information that identifies the resource.

" } }, "additionalInfo": { "target": "com.amazonaws.iot#StringMap", "traits": { "smithy.api#documentation": "

Other information about the resource.

" } } }, "traits": { "smithy.api#documentation": "

Information about a related resource.

" } }, "com.amazonaws.iot#RelatedResources": { "type": "list", "member": { "target": "com.amazonaws.iot#RelatedResource" } }, "com.amazonaws.iot#RemoveAuthorizerConfig": { "type": "boolean" }, "com.amazonaws.iot#RemoveAutoRegistration": { "type": "boolean" }, "com.amazonaws.iot#RemoveHook": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#RemoveThingFromBillingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#RemoveThingFromBillingGroupRequest" }, "output": { "target": "com.amazonaws.iot#RemoveThingFromBillingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Removes the given thing from the billing group.

", "smithy.api#http": { "method": "PUT", "uri": "/billing-groups/removeThingFromBillingGroup", "code": 200 } } }, "com.amazonaws.iot#RemoveThingFromBillingGroupRequest": { "type": "structure", "members": { "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name of the billing group.

" } }, "billingGroupArn": { "target": "com.amazonaws.iot#BillingGroupArn", "traits": { "smithy.api#documentation": "

The ARN of the billing group.

" } }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing to be removed from the billing group.

" } }, "thingArn": { "target": "com.amazonaws.iot#ThingArn", "traits": { "smithy.api#documentation": "

The ARN of the thing to be removed from the billing group.

" } } } }, "com.amazonaws.iot#RemoveThingFromBillingGroupResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#RemoveThingFromThingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#RemoveThingFromThingGroupRequest" }, "output": { "target": "com.amazonaws.iot#RemoveThingFromThingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Remove the specified thing from the specified group.

\n\t\t

You must specify either a thingGroupArn or a\n\t\t\tthingGroupName to identify the thing group and\n\t\t\teither a thingArn or a thingName to\n\t\t\tidentify the thing to remove from the thing group.\n\t\t

", "smithy.api#http": { "method": "PUT", "uri": "/thing-groups/removeThingFromThingGroup", "code": 200 } } }, "com.amazonaws.iot#RemoveThingFromThingGroupRequest": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The group name.

" } }, "thingGroupArn": { "target": "com.amazonaws.iot#ThingGroupArn", "traits": { "smithy.api#documentation": "

The group ARN.

" } }, "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing to remove from the group.

" } }, "thingArn": { "target": "com.amazonaws.iot#ThingArn", "traits": { "smithy.api#documentation": "

The ARN of the thing to remove from the group.

" } } } }, "com.amazonaws.iot#RemoveThingFromThingGroupResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#RemoveThingType": { "type": "boolean" }, "com.amazonaws.iot#RemovedThings": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#ReplaceDefaultPolicyVersionParams": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.iot#PolicyTemplateName", "traits": { "smithy.api#documentation": "

The name of the template to be applied. The only supported value is BLANK_POLICY.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

" } }, "com.amazonaws.iot#ReplaceTopicRule": { "type": "operation", "input": { "target": "com.amazonaws.iot#ReplaceTopicRuleRequest" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#SqlParseException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Replaces the rule. You must specify all parameters for the new rule. Creating rules\n is an administrator-level action. Any user who has permission to create rules will be able\n to access data processed by the rule.

", "smithy.api#http": { "method": "PATCH", "uri": "/rules/{ruleName}", "code": 200 } } }, "com.amazonaws.iot#ReplaceTopicRuleRequest": { "type": "structure", "members": { "ruleName": { "target": "com.amazonaws.iot#RuleName", "traits": { "smithy.api#documentation": "

The name of the rule.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "topicRulePayload": { "target": "com.amazonaws.iot#TopicRulePayload", "traits": { "smithy.api#documentation": "

The rule payload.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the ReplaceTopicRule operation.

" } }, "com.amazonaws.iot#ReportType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ERRORS", "name": "ERRORS" }, { "value": "RESULTS", "name": "RESULTS" } ] } }, "com.amazonaws.iot#RepublishAction": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants access.

", "smithy.api#required": {} } }, "topic": { "target": "com.amazonaws.iot#TopicPattern", "traits": { "smithy.api#documentation": "

The name of the MQTT topic.

", "smithy.api#required": {} } }, "qos": { "target": "com.amazonaws.iot#Qos", "traits": { "smithy.api#documentation": "

The Quality of Service (QoS) level to use when republishing messages. The default value\n is 0.

" } } }, "traits": { "smithy.api#documentation": "

Describes an action to republish to another topic.

" } }, "com.amazonaws.iot#ReservedDomainConfigurationName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[\\w.:-]+" } }, "com.amazonaws.iot#Resource": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.iot#ResourceAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } }, "resourceId": { "target": "com.amazonaws.iot#resourceId", "traits": { "smithy.api#documentation": "

The ID of the resource that caused the exception.

" } }, "resourceArn": { "target": "com.amazonaws.iot#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource that caused the exception.

" } } }, "traits": { "smithy.api#documentation": "

The resource already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iot#ResourceArn": { "type": "string" }, "com.amazonaws.iot#ResourceArns": { "type": "map", "key": { "target": "com.amazonaws.iot#ResourceLogicalId" }, "value": { "target": "com.amazonaws.iot#ResourceArn" } }, "com.amazonaws.iot#ResourceIdentifier": { "type": "structure", "members": { "deviceCertificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate attached to the resource.

" } }, "caCertificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the CA certificate used to authorize the certificate.

" } }, "cognitoIdentityPoolId": { "target": "com.amazonaws.iot#CognitoIdentityPoolId", "traits": { "smithy.api#documentation": "

The ID of the Amazon Cognito identity pool.

" } }, "clientId": { "target": "com.amazonaws.iot#ClientId", "traits": { "smithy.api#documentation": "

The client ID.

" } }, "policyVersionIdentifier": { "target": "com.amazonaws.iot#PolicyVersionIdentifier", "traits": { "smithy.api#documentation": "

The version of the policy associated with the resource.

" } }, "account": { "target": "com.amazonaws.iot#AwsAccountId", "traits": { "smithy.api#documentation": "

The account with which the resource is associated.

" } }, "iamRoleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that has overly permissive actions.

" } }, "roleAliasArn": { "target": "com.amazonaws.iot#RoleAliasArn", "traits": { "smithy.api#documentation": "

The ARN of the role alias that has overly permissive actions.

" } } }, "traits": { "smithy.api#documentation": "

Information that identifies the noncompliant resource.

" } }, "com.amazonaws.iot#ResourceLogicalId": { "type": "string" }, "com.amazonaws.iot#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The specified resource does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.iot#ResourceRegistrationFailureException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The resource registration failed.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#ResourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DEVICE_CERTIFICATE", "name": "DEVICE_CERTIFICATE" }, { "value": "CA_CERTIFICATE", "name": "CA_CERTIFICATE" }, { "value": "IOT_POLICY", "name": "IOT_POLICY" }, { "value": "COGNITO_IDENTITY_POOL", "name": "COGNITO_IDENTITY_POOL" }, { "value": "CLIENT_ID", "name": "CLIENT_ID" }, { "value": "ACCOUNT_SETTINGS", "name": "ACCOUNT_SETTINGS" }, { "value": "ROLE_ALIAS", "name": "ROLE_ALIAS" }, { "value": "IAM_ROLE", "name": "IAM_ROLE" } ] } }, "com.amazonaws.iot#Resources": { "type": "list", "member": { "target": "com.amazonaws.iot#Resource" } }, "com.amazonaws.iot#RoleAlias": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[\\w=,@-]+" } }, "com.amazonaws.iot#RoleAliasArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.iot#RoleAliasDescription": { "type": "structure", "members": { "roleAlias": { "target": "com.amazonaws.iot#RoleAlias", "traits": { "smithy.api#documentation": "

The role alias.

" } }, "roleAliasArn": { "target": "com.amazonaws.iot#RoleAliasArn", "traits": { "smithy.api#documentation": "

The ARN of the role alias.

" } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The role ARN.

" } }, "owner": { "target": "com.amazonaws.iot#AwsAccountId", "traits": { "smithy.api#documentation": "

The role alias owner.

" } }, "credentialDurationSeconds": { "target": "com.amazonaws.iot#CredentialDurationSeconds", "traits": { "smithy.api#documentation": "

The number of seconds for which the credential is valid.

" } }, "creationDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The UNIX timestamp of when the role alias was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The UNIX timestamp of when the role alias was last modified.

" } } }, "traits": { "smithy.api#documentation": "

Role alias description.

" } }, "com.amazonaws.iot#RoleAliases": { "type": "list", "member": { "target": "com.amazonaws.iot#RoleAlias" } }, "com.amazonaws.iot#RoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 } } }, "com.amazonaws.iot#RolloutRatePerMinute": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.iot#RuleArn": { "type": "string" }, "com.amazonaws.iot#RuleName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_]+$" } }, "com.amazonaws.iot#S3Action": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants access.

", "smithy.api#required": {} } }, "bucketName": { "target": "com.amazonaws.iot#BucketName", "traits": { "smithy.api#documentation": "

The Amazon S3 bucket.

", "smithy.api#required": {} } }, "key": { "target": "com.amazonaws.iot#Key", "traits": { "smithy.api#documentation": "

The object key. For more information, see Actions, resources, and condition keys for Amazon S3.

", "smithy.api#required": {} } }, "cannedAcl": { "target": "com.amazonaws.iot#CannedAccessControlList", "traits": { "smithy.api#documentation": "

The Amazon S3 canned ACL that controls access to the object identified by the object\n key. For more information, see S3 canned ACLs.

" } } }, "traits": { "smithy.api#documentation": "

Describes an action to write data to an Amazon S3 bucket.

" } }, "com.amazonaws.iot#S3Bucket": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#S3Destination": { "type": "structure", "members": { "bucket": { "target": "com.amazonaws.iot#S3Bucket", "traits": { "smithy.api#documentation": "

The S3 bucket that contains the updated firmware.

" } }, "prefix": { "target": "com.amazonaws.iot#Prefix", "traits": { "smithy.api#documentation": "

The S3 prefix.

" } } }, "traits": { "smithy.api#documentation": "

Describes the location of updated firmware in S3.

" } }, "com.amazonaws.iot#S3FileUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 65535 } } }, "com.amazonaws.iot#S3FileUrlList": { "type": "list", "member": { "target": "com.amazonaws.iot#S3FileUrl" } }, "com.amazonaws.iot#S3Key": { "type": "string", "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#S3Location": { "type": "structure", "members": { "bucket": { "target": "com.amazonaws.iot#S3Bucket", "traits": { "smithy.api#documentation": "

The S3 bucket.

" } }, "key": { "target": "com.amazonaws.iot#S3Key", "traits": { "smithy.api#documentation": "

The S3 key.

" } }, "version": { "target": "com.amazonaws.iot#S3Version", "traits": { "smithy.api#documentation": "

The S3 bucket version.

" } } }, "traits": { "smithy.api#documentation": "

The S3 location.

" } }, "com.amazonaws.iot#S3Version": { "type": "string" }, "com.amazonaws.iot#SQL": { "type": "string" }, "com.amazonaws.iot#SalesforceAction": { "type": "structure", "members": { "token": { "target": "com.amazonaws.iot#SalesforceToken", "traits": { "smithy.api#documentation": "

The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The\n token is available from the Salesforce IoT Cloud platform after creation of the Input\n Stream.

", "smithy.api#required": {} } }, "url": { "target": "com.amazonaws.iot#SalesforceEndpoint", "traits": { "smithy.api#documentation": "

The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from\n the Salesforce IoT Cloud platform after creation of the Input Stream.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes an action to write a message to a Salesforce IoT Cloud Input\n Stream.

" } }, "com.amazonaws.iot#SalesforceEndpoint": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2000 }, "smithy.api#pattern": "https://ingestion-[a-zA-Z0-9]{1,12}\\.[a-zA-Z0-9]+\\.((sfdc-matrix\\.net)|(sfdcnow\\.com))/streams/\\w{1,20}/\\w{1,20}/event" } }, "com.amazonaws.iot#SalesforceToken": { "type": "string", "traits": { "smithy.api#length": { "min": 40 } } }, "com.amazonaws.iot#ScheduledAuditArn": { "type": "string" }, "com.amazonaws.iot#ScheduledAuditMetadata": { "type": "structure", "members": { "scheduledAuditName": { "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { "smithy.api#documentation": "

The name of the scheduled audit.

" } }, "scheduledAuditArn": { "target": "com.amazonaws.iot#ScheduledAuditArn", "traits": { "smithy.api#documentation": "

The ARN of the scheduled audit.

" } }, "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { "smithy.api#documentation": "

How often the scheduled audit occurs.

" } }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { "smithy.api#documentation": "

The day of the month on which the scheduled audit is run (if the\n frequency is \"MONTHLY\").\n If days 29-31 are specified, and the month does not have that many\n days, the audit takes place on the \"LAST\" day of the month.

" } }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { "smithy.api#documentation": "

The day of the week on which the scheduled audit is run (if the\n frequency is \"WEEKLY\" or \"BIWEEKLY\").

" } } }, "traits": { "smithy.api#documentation": "

Information about the scheduled audit.

" } }, "com.amazonaws.iot#ScheduledAuditMetadataList": { "type": "list", "member": { "target": "com.amazonaws.iot#ScheduledAuditMetadata" } }, "com.amazonaws.iot#ScheduledAuditName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.iot#SearchIndex": { "type": "operation", "input": { "target": "com.amazonaws.iot#SearchIndexRequest" }, "output": { "target": "com.amazonaws.iot#SearchIndexResponse" }, "errors": [ { "target": "com.amazonaws.iot#IndexNotReadyException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidQueryException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

The query search index.

", "smithy.api#http": { "method": "POST", "uri": "/indices/search", "code": 200 } } }, "com.amazonaws.iot#SearchIndexRequest": { "type": "structure", "members": { "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The search index name.

" } }, "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { "smithy.api#documentation": "

The search query string.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional\n results.

" } }, "maxResults": { "target": "com.amazonaws.iot#QueryMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return at one time.

" } }, "queryVersion": { "target": "com.amazonaws.iot#QueryVersion", "traits": { "smithy.api#documentation": "

The query version.

" } } } }, "com.amazonaws.iot#SearchIndexResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.iot#NextToken", "traits": { "smithy.api#documentation": "

The token used to get the next set of results, or null if there are no additional\n results.

" } }, "things": { "target": "com.amazonaws.iot#ThingDocumentList", "traits": { "smithy.api#documentation": "

The things that match the search query.

" } }, "thingGroups": { "target": "com.amazonaws.iot#ThingGroupDocumentList", "traits": { "smithy.api#documentation": "

The thing groups that match the search query.

" } } } }, "com.amazonaws.iot#SearchableAttributes": { "type": "list", "member": { "target": "com.amazonaws.iot#AttributeName" } }, "com.amazonaws.iot#Seconds": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#SecurityGroupId": { "type": "string" }, "com.amazonaws.iot#SecurityGroupList": { "type": "list", "member": { "target": "com.amazonaws.iot#SecurityGroupId" } }, "com.amazonaws.iot#SecurityProfileArn": { "type": "string" }, "com.amazonaws.iot#SecurityProfileDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "[\\p{Graph}\\x20]*" } }, "com.amazonaws.iot#SecurityProfileIdentifier": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name you've given to the security profile.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.iot#SecurityProfileArn", "traits": { "smithy.api#documentation": "

The ARN of the security profile.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Identifying information for a Device Defender security profile.

" } }, "com.amazonaws.iot#SecurityProfileIdentifiers": { "type": "list", "member": { "target": "com.amazonaws.iot#SecurityProfileIdentifier" } }, "com.amazonaws.iot#SecurityProfileName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#SecurityProfileTarget": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.iot#SecurityProfileTargetArn", "traits": { "smithy.api#documentation": "

The ARN of the security profile.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A target to which an alert is sent when a security profile behavior is \n violated.

" } }, "com.amazonaws.iot#SecurityProfileTargetArn": { "type": "string" }, "com.amazonaws.iot#SecurityProfileTargetMapping": { "type": "structure", "members": { "securityProfileIdentifier": { "target": "com.amazonaws.iot#SecurityProfileIdentifier", "traits": { "smithy.api#documentation": "

Information that identifies the security profile.

" } }, "target": { "target": "com.amazonaws.iot#SecurityProfileTarget", "traits": { "smithy.api#documentation": "

Information about the target (thing group) associated with the security profile.

" } } }, "traits": { "smithy.api#documentation": "

Information about a security profile and the target associated with it.

" } }, "com.amazonaws.iot#SecurityProfileTargetMappings": { "type": "list", "member": { "target": "com.amazonaws.iot#SecurityProfileTargetMapping" } }, "com.amazonaws.iot#SecurityProfileTargets": { "type": "list", "member": { "target": "com.amazonaws.iot#SecurityProfileTarget" } }, "com.amazonaws.iot#ServerCertificateArns": { "type": "list", "member": { "target": "com.amazonaws.iot#AcmCertificateArn" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.iot#ServerCertificateStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "INVALID", "name": "INVALID" }, { "value": "VALID", "name": "VALID" } ] } }, "com.amazonaws.iot#ServerCertificateStatusDetail": { "type": "string" }, "com.amazonaws.iot#ServerCertificateSummary": { "type": "structure", "members": { "serverCertificateArn": { "target": "com.amazonaws.iot#AcmCertificateArn", "traits": { "smithy.api#documentation": "

The ARN of the server certificate.

" } }, "serverCertificateStatus": { "target": "com.amazonaws.iot#ServerCertificateStatus", "traits": { "smithy.api#documentation": "

The status of the server certificate.

" } }, "serverCertificateStatusDetail": { "target": "com.amazonaws.iot#ServerCertificateStatusDetail", "traits": { "smithy.api#documentation": "

Details that explain the status of the server certificate.

" } } }, "traits": { "smithy.api#documentation": "

An object that contains information about a server certificate.

" } }, "com.amazonaws.iot#ServerCertificates": { "type": "list", "member": { "target": "com.amazonaws.iot#ServerCertificateSummary" } }, "com.amazonaws.iot#ServerName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 253 } } }, "com.amazonaws.iot#ServiceName": { "type": "string" }, "com.amazonaws.iot#ServiceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DATA", "name": "DATA" }, { "value": "CREDENTIAL_PROVIDER", "name": "CREDENTIAL_PROVIDER" }, { "value": "JOBS", "name": "JOBS" } ] } }, "com.amazonaws.iot#ServiceUnavailableException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The service is temporarily unavailable.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.iot#SetAsActive": { "type": "boolean" }, "com.amazonaws.iot#SetAsActiveFlag": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#SetAsDefault": { "type": "boolean" }, "com.amazonaws.iot#SetDefaultAuthorizer": { "type": "operation", "input": { "target": "com.amazonaws.iot#SetDefaultAuthorizerRequest" }, "output": { "target": "com.amazonaws.iot#SetDefaultAuthorizerResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Sets the default authorizer. This will be used if a websocket connection is made\n without specifying an authorizer.

", "smithy.api#http": { "method": "POST", "uri": "/default-authorizer", "code": 200 } } }, "com.amazonaws.iot#SetDefaultAuthorizerRequest": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The authorizer name.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#SetDefaultAuthorizerResponse": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The authorizer name.

" } }, "authorizerArn": { "target": "com.amazonaws.iot#AuthorizerArn", "traits": { "smithy.api#documentation": "

The authorizer ARN.

" } } } }, "com.amazonaws.iot#SetDefaultPolicyVersion": { "type": "operation", "input": { "target": "com.amazonaws.iot#SetDefaultPolicyVersionRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Sets the specified version of the specified policy as the policy's default\n (operative) version. This action affects all certificates to which the policy is attached.\n To list the principals the policy is attached to, use the ListPrincipalPolicy\n API.

", "smithy.api#http": { "method": "PATCH", "uri": "/policies/{policyName}/version/{policyVersionId}", "code": 200 } } }, "com.amazonaws.iot#SetDefaultPolicyVersionRequest": { "type": "structure", "members": { "policyName": { "target": "com.amazonaws.iot#PolicyName", "traits": { "smithy.api#documentation": "

The policy name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "policyVersionId": { "target": "com.amazonaws.iot#PolicyVersionId", "traits": { "smithy.api#documentation": "

The policy version ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the SetDefaultPolicyVersion operation.

" } }, "com.amazonaws.iot#SetLoggingOptions": { "type": "operation", "input": { "target": "com.amazonaws.iot#SetLoggingOptionsRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Sets the logging options.

\n

NOTE: use of this command is not recommended. Use SetV2LoggingOptions\n instead.

", "smithy.api#http": { "method": "POST", "uri": "/loggingOptions", "code": 200 } } }, "com.amazonaws.iot#SetLoggingOptionsRequest": { "type": "structure", "members": { "loggingOptionsPayload": { "target": "com.amazonaws.iot#LoggingOptionsPayload", "traits": { "smithy.api#documentation": "

The logging options payload.

", "smithy.api#httpPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the SetLoggingOptions operation.

" } }, "com.amazonaws.iot#SetV2LoggingLevel": { "type": "operation", "input": { "target": "com.amazonaws.iot#SetV2LoggingLevelRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#NotConfiguredException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Sets the logging level.

", "smithy.api#http": { "method": "POST", "uri": "/v2LoggingLevel", "code": 200 } } }, "com.amazonaws.iot#SetV2LoggingLevelRequest": { "type": "structure", "members": { "logTarget": { "target": "com.amazonaws.iot#LogTarget", "traits": { "smithy.api#documentation": "

The log target.

", "smithy.api#required": {} } }, "logLevel": { "target": "com.amazonaws.iot#LogLevel", "traits": { "smithy.api#documentation": "

The log level.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#SetV2LoggingOptions": { "type": "operation", "input": { "target": "com.amazonaws.iot#SetV2LoggingOptionsRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" } ], "traits": { "smithy.api#documentation": "

Sets the logging options for the V2 logging service.

", "smithy.api#http": { "method": "POST", "uri": "/v2LoggingOptions", "code": 200 } } }, "com.amazonaws.iot#SetV2LoggingOptionsRequest": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the role that allows IoT to write to Cloudwatch logs.

" } }, "defaultLogLevel": { "target": "com.amazonaws.iot#LogLevel", "traits": { "smithy.api#documentation": "

The default logging level.

" } }, "disableAllLogs": { "target": "com.amazonaws.iot#DisableAllLogs", "traits": { "smithy.api#documentation": "

If true all logs are disabled. The default is false.

" } } } }, "com.amazonaws.iot#SigV4Authorization": { "type": "structure", "members": { "signingRegion": { "target": "com.amazonaws.iot#SigningRegion", "traits": { "smithy.api#documentation": "

The signing region.

", "smithy.api#required": {} } }, "serviceName": { "target": "com.amazonaws.iot#ServiceName", "traits": { "smithy.api#documentation": "

The service name to use while signing with Sig V4.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the signing role.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

For more information, see Signature Version 4 signing process.

" } }, "com.amazonaws.iot#Signature": { "type": "blob" }, "com.amazonaws.iot#SignatureAlgorithm": { "type": "string" }, "com.amazonaws.iot#SigningJobId": { "type": "string" }, "com.amazonaws.iot#SigningProfileName": { "type": "string" }, "com.amazonaws.iot#SigningProfileParameter": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

Certificate ARN.

" } }, "platform": { "target": "com.amazonaws.iot#Platform", "traits": { "smithy.api#documentation": "

The hardware platform of your device.

" } }, "certificatePathOnDevice": { "target": "com.amazonaws.iot#CertificatePathOnDevice", "traits": { "smithy.api#documentation": "

The location of the code-signing certificate on your device.

" } } }, "traits": { "smithy.api#documentation": "

Describes the code-signing profile.

" } }, "com.amazonaws.iot#SigningRegion": { "type": "string" }, "com.amazonaws.iot#SkippedFindingsCount": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#SkyfallMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 250 } } }, "com.amazonaws.iot#SnsAction": { "type": "structure", "members": { "targetArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the SNS topic.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants access.

", "smithy.api#required": {} } }, "messageFormat": { "target": "com.amazonaws.iot#MessageFormat", "traits": { "smithy.api#documentation": "

(Optional) The message format of the message to publish. Accepted values are \"JSON\"\n and \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine\n if the payload should be parsed and relevant platform-specific bits of the payload should\n be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

" } } }, "traits": { "smithy.api#documentation": "

Describes an action to publish to an Amazon SNS topic.

" } }, "com.amazonaws.iot#SnsTopicArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 350 } } }, "com.amazonaws.iot#SqlParseException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The Rule-SQL expression can't be parsed correctly.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#SqsAction": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that grants access.

", "smithy.api#required": {} } }, "queueUrl": { "target": "com.amazonaws.iot#QueueUrl", "traits": { "smithy.api#documentation": "

The URL of the Amazon SQS queue.

", "smithy.api#required": {} } }, "useBase64": { "target": "com.amazonaws.iot#UseBase64", "traits": { "smithy.api#documentation": "

Specifies whether to use Base64 encoding.

" } } }, "traits": { "smithy.api#documentation": "

Describes an action to publish data to an Amazon SQS queue.

" } }, "com.amazonaws.iot#StartAuditMitigationActionsTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#StartAuditMitigationActionsTaskRequest" }, "output": { "target": "com.amazonaws.iot#StartAuditMitigationActionsTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#TaskAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Starts a task that applies a set of mitigation actions to the specified target.

", "smithy.api#http": { "method": "POST", "uri": "/audit/mitigationactions/tasks/{taskId}", "code": 200 } } }, "com.amazonaws.iot#StartAuditMitigationActionsTaskRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.iot#AuditMitigationActionsTaskTarget", "traits": { "smithy.api#documentation": "

Specifies the audit findings to which the mitigation actions are applied. You can apply\n them to a type of audit check, to all findings from an audit, or to a\n specific set of\n findings.

", "smithy.api#required": {} } }, "auditCheckToActionsMapping": { "target": "com.amazonaws.iot#AuditCheckToActionsMapping", "traits": { "smithy.api#documentation": "

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.

", "smithy.api#required": {} } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { "smithy.api#documentation": "

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#StartAuditMitigationActionsTaskResponse": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

" } } } }, "com.amazonaws.iot#StartDetectMitigationActionsTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#StartDetectMitigationActionsTaskRequest" }, "output": { "target": "com.amazonaws.iot#StartDetectMitigationActionsTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#TaskAlreadyExistsException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Starts a Device Defender ML Detect mitigation actions task.\n

", "smithy.api#http": { "method": "PUT", "uri": "/detect/mitigationactions/tasks/{taskId}", "code": 200 } } }, "com.amazonaws.iot#StartDetectMitigationActionsTaskRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

\n The unique identifier of the task.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.iot#DetectMitigationActionsTaskTarget", "traits": { "smithy.api#documentation": "

\n Specifies the ML Detect findings to which the mitigation actions are applied.\n

", "smithy.api#required": {} } }, "actions": { "target": "com.amazonaws.iot#DetectMitigationActionsToExecuteList", "traits": { "smithy.api#documentation": "

\n The actions to be performed when a device has unexpected behavior.\n

", "smithy.api#required": {} } }, "violationEventOccurrenceRange": { "target": "com.amazonaws.iot#ViolationEventOccurrenceRange", "traits": { "smithy.api#documentation": "

\n Specifies the time period of which violation events occurred between.\n

" } }, "includeOnlyActiveViolations": { "target": "com.amazonaws.iot#NullableBoolean", "traits": { "smithy.api#documentation": "

\n Specifies to list only active violations.\n

" } }, "includeSuppressedAlerts": { "target": "com.amazonaws.iot#NullableBoolean", "traits": { "smithy.api#documentation": "

\n Specifies to include suppressed alerts.\n

" } }, "clientRequestToken": { "target": "com.amazonaws.iot#ClientRequestToken", "traits": { "smithy.api#documentation": "

\n Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.\n

", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#StartDetectMitigationActionsTaskResponse": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#MitigationActionsTaskId", "traits": { "smithy.api#documentation": "

\n The unique identifier of the task.\n

" } } } }, "com.amazonaws.iot#StartOnDemandAuditTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#StartOnDemandAuditTaskRequest" }, "output": { "target": "com.amazonaws.iot#StartOnDemandAuditTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Starts an on-demand Device Defender audit.

", "smithy.api#http": { "method": "POST", "uri": "/audit/tasks", "code": 200 } } }, "com.amazonaws.iot#StartOnDemandAuditTaskRequest": { "type": "structure", "members": { "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { "smithy.api#documentation": "

Which checks are performed during the audit. The checks you specify must be enabled \n for your account or an exception occurs. Use DescribeAccountAuditConfiguration \n to see the list of all checks, including those that are enabled or \n UpdateAccountAuditConfiguration to select which checks are enabled.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#StartOnDemandAuditTaskResponse": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#AuditTaskId", "traits": { "smithy.api#documentation": "

The ID of the on-demand audit you started.

" } } } }, "com.amazonaws.iot#StartSigningJobParameter": { "type": "structure", "members": { "signingProfileParameter": { "target": "com.amazonaws.iot#SigningProfileParameter", "traits": { "smithy.api#documentation": "

Describes the code-signing profile.

" } }, "signingProfileName": { "target": "com.amazonaws.iot#SigningProfileName", "traits": { "smithy.api#documentation": "

The code-signing profile name.

" } }, "destination": { "target": "com.amazonaws.iot#Destination", "traits": { "smithy.api#documentation": "

The location to write the code-signed file.

" } } }, "traits": { "smithy.api#documentation": "

Information required to start a signing job.

" } }, "com.amazonaws.iot#StartThingRegistrationTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#StartThingRegistrationTaskRequest" }, "output": { "target": "com.amazonaws.iot#StartThingRegistrationTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Creates a bulk thing provisioning task.

", "smithy.api#http": { "method": "POST", "uri": "/thing-registration-tasks", "code": 200 } } }, "com.amazonaws.iot#StartThingRegistrationTaskRequest": { "type": "structure", "members": { "templateBody": { "target": "com.amazonaws.iot#TemplateBody", "traits": { "smithy.api#documentation": "

The provisioning template.

", "smithy.api#required": {} } }, "inputFileBucket": { "target": "com.amazonaws.iot#RegistryS3BucketName", "traits": { "smithy.api#documentation": "

The S3 bucket that contains the input file.

", "smithy.api#required": {} } }, "inputFileKey": { "target": "com.amazonaws.iot#RegistryS3KeyName", "traits": { "smithy.api#documentation": "

The name of input file within the S3 bucket. This file contains a newline delimited\n\t\t\tJSON file. Each line contains the parameter values to provision one device\n\t\t\t(thing).

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The IAM role ARN that grants permission the input file.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#StartThingRegistrationTaskResponse": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#TaskId", "traits": { "smithy.api#documentation": "

The bulk thing provisioning task ID.

" } } } }, "com.amazonaws.iot#StateMachineName": { "type": "string" }, "com.amazonaws.iot#StateReason": { "type": "string" }, "com.amazonaws.iot#StateValue": { "type": "string" }, "com.amazonaws.iot#StatisticalThreshold": { "type": "structure", "members": { "statistic": { "target": "com.amazonaws.iot#EvaluationStatistic", "traits": { "smithy.api#documentation": "

The percentile that\n resolves to a threshold value by which compliance with a behavior is determined. Metrics are\n collected over the specified period (durationSeconds) from all reporting devices\n in your account and statistical ranks are calculated. Then, the measurements from a device are\n collected over the same period. If the accumulated measurements from the device fall above or\n below (comparisonOperator) the value associated with the percentile specified,\n then the device is considered to be in compliance with the behavior, otherwise a violation\n occurs.

" } } }, "traits": { "smithy.api#documentation": "

A statistical ranking (percentile) that\n indicates a threshold value by which a behavior is determined to be in compliance or in\n violation of the behavior.

" } }, "com.amazonaws.iot#Statistics": { "type": "structure", "members": { "count": { "target": "com.amazonaws.iot#Count", "traits": { "smithy.api#documentation": "

The count of things that match the query.

" } }, "average": { "target": "com.amazonaws.iot#Average", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The average of the aggregated field values.

" } }, "sum": { "target": "com.amazonaws.iot#Sum", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The sum of the aggregated field values.

" } }, "minimum": { "target": "com.amazonaws.iot#Minimum", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The minimum aggregated field value.

" } }, "maximum": { "target": "com.amazonaws.iot#Maximum", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The maximum aggregated field value.

" } }, "sumOfSquares": { "target": "com.amazonaws.iot#SumOfSquares", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The sum of the squares of the aggregated field values.

" } }, "variance": { "target": "com.amazonaws.iot#Variance", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The variance of the aggregated field values.

" } }, "stdDeviation": { "target": "com.amazonaws.iot#StdDeviation", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The standard deviation of the aggregated field values.

" } } }, "traits": { "smithy.api#documentation": "

A map of key-value pairs for all supported statistics. Currently, only count is\n supported.

" } }, "com.amazonaws.iot#Status": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "InProgress", "name": "InProgress" }, { "value": "Completed", "name": "Completed" }, { "value": "Failed", "name": "Failed" }, { "value": "Cancelled", "name": "Cancelled" }, { "value": "Cancelling", "name": "Cancelling" } ] } }, "com.amazonaws.iot#StdDeviation": { "type": "double" }, "com.amazonaws.iot#StepFunctionsAction": { "type": "structure", "members": { "executionNamePrefix": { "target": "com.amazonaws.iot#ExecutionNamePrefix", "traits": { "smithy.api#documentation": "

(Optional) A name will be given to the state machine execution consisting of this\n prefix followed by a UUID. Step Functions automatically creates a unique name for each state\n machine execution if one is not provided.

" } }, "stateMachineName": { "target": "com.amazonaws.iot#StateMachineName", "traits": { "smithy.api#documentation": "

The name of the Step Functions state machine whose execution will be started.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the role that grants IoT permission to start execution of a state machine\n (\"Action\":\"states:StartExecution\").

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Starts execution of a Step Functions state machine.

" } }, "com.amazonaws.iot#StopThingRegistrationTask": { "type": "operation", "input": { "target": "com.amazonaws.iot#StopThingRegistrationTaskRequest" }, "output": { "target": "com.amazonaws.iot#StopThingRegistrationTaskResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Cancels a bulk thing provisioning task.

", "smithy.api#http": { "method": "PUT", "uri": "/thing-registration-tasks/{taskId}/cancel", "code": 200 } } }, "com.amazonaws.iot#StopThingRegistrationTaskRequest": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.iot#TaskId", "traits": { "smithy.api#documentation": "

The bulk thing provisioning task ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#StopThingRegistrationTaskResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#Stream": { "type": "structure", "members": { "streamId": { "target": "com.amazonaws.iot#StreamId", "traits": { "smithy.api#documentation": "

The stream ID.

" } }, "fileId": { "target": "com.amazonaws.iot#FileId", "traits": { "smithy.api#documentation": "

The ID of a file associated with a stream.

" } } }, "traits": { "smithy.api#documentation": "

Describes a group of files that can be streamed.

" } }, "com.amazonaws.iot#StreamArn": { "type": "string" }, "com.amazonaws.iot#StreamDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2028 }, "smithy.api#pattern": "[^\\p{C}]+" } }, "com.amazonaws.iot#StreamFile": { "type": "structure", "members": { "fileId": { "target": "com.amazonaws.iot#FileId", "traits": { "smithy.api#documentation": "

The file ID.

" } }, "s3Location": { "target": "com.amazonaws.iot#S3Location", "traits": { "smithy.api#documentation": "

The location of the file in S3.

" } } }, "traits": { "smithy.api#documentation": "

Represents a file to stream.

" } }, "com.amazonaws.iot#StreamFiles": { "type": "list", "member": { "target": "com.amazonaws.iot#StreamFile" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.iot#StreamId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.iot#StreamInfo": { "type": "structure", "members": { "streamId": { "target": "com.amazonaws.iot#StreamId", "traits": { "smithy.api#documentation": "

The stream ID.

" } }, "streamArn": { "target": "com.amazonaws.iot#StreamArn", "traits": { "smithy.api#documentation": "

The stream ARN.

" } }, "streamVersion": { "target": "com.amazonaws.iot#StreamVersion", "traits": { "smithy.api#documentation": "

The stream version.

" } }, "description": { "target": "com.amazonaws.iot#StreamDescription", "traits": { "smithy.api#documentation": "

The description of the stream.

" } }, "files": { "target": "com.amazonaws.iot#StreamFiles", "traits": { "smithy.api#documentation": "

The files to stream.

" } }, "createdAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the stream was created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date when the stream was last updated.

" } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

An IAM role AWS IoT assumes to access your S3 files.

" } } }, "traits": { "smithy.api#documentation": "

Information about a stream.

" } }, "com.amazonaws.iot#StreamName": { "type": "string" }, "com.amazonaws.iot#StreamSummary": { "type": "structure", "members": { "streamId": { "target": "com.amazonaws.iot#StreamId", "traits": { "smithy.api#documentation": "

The stream ID.

" } }, "streamArn": { "target": "com.amazonaws.iot#StreamArn", "traits": { "smithy.api#documentation": "

The stream ARN.

" } }, "streamVersion": { "target": "com.amazonaws.iot#StreamVersion", "traits": { "smithy.api#documentation": "

The stream version.

" } }, "description": { "target": "com.amazonaws.iot#StreamDescription", "traits": { "smithy.api#documentation": "

A description of the stream.

" } } }, "traits": { "smithy.api#documentation": "

A summary of a stream.

" } }, "com.amazonaws.iot#StreamVersion": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0, "max": 65535 } } }, "com.amazonaws.iot#StreamsSummary": { "type": "list", "member": { "target": "com.amazonaws.iot#StreamSummary" } }, "com.amazonaws.iot#String": { "type": "string" }, "com.amazonaws.iot#StringList": { "type": "list", "member": { "target": "com.amazonaws.iot#stringValue" } }, "com.amazonaws.iot#StringMap": { "type": "map", "key": { "target": "com.amazonaws.iot#String" }, "value": { "target": "com.amazonaws.iot#String" } }, "com.amazonaws.iot#SubnetId": { "type": "string" }, "com.amazonaws.iot#SubnetIdList": { "type": "list", "member": { "target": "com.amazonaws.iot#SubnetId" } }, "com.amazonaws.iot#SucceededFindingsCount": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#SucceededThings": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#Sum": { "type": "double" }, "com.amazonaws.iot#SumOfSquares": { "type": "double" }, "com.amazonaws.iot#SuppressAlerts": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#SuppressIndefinitely": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#SuppressedNonCompliantResourcesCount": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#TableName": { "type": "string" }, "com.amazonaws.iot#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.iot#TagKey", "traits": { "smithy.api#documentation": "

The tag's key.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.iot#TagValue", "traits": { "smithy.api#documentation": "

The tag's value.

" } } }, "traits": { "smithy.api#documentation": "

A set of key/value pairs that are used to manage the resource.

" } }, "com.amazonaws.iot#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.iot#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.iot#TagKey" } }, "com.amazonaws.iot#TagList": { "type": "list", "member": { "target": "com.amazonaws.iot#Tag" } }, "com.amazonaws.iot#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.iot#TagResourceRequest" }, "output": { "target": "com.amazonaws.iot#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Adds to or modifies the tags of the given resource. Tags are metadata which can be\n\t\t\tused to manage a resource.

", "smithy.api#http": { "method": "POST", "uri": "/tags", "code": 200 } } }, "com.amazonaws.iot#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.iot#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iot#TagList", "traits": { "smithy.api#documentation": "

The new or modified tags for the resource.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.iot#Target": { "type": "string" }, "com.amazonaws.iot#TargetArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.iot#TargetAuditCheckNames": { "type": "list", "member": { "target": "com.amazonaws.iot#AuditCheckName" } }, "com.amazonaws.iot#TargetSelection": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CONTINUOUS", "name": "CONTINUOUS" }, { "value": "SNAPSHOT", "name": "SNAPSHOT" } ] } }, "com.amazonaws.iot#TargetViolationIdsForDetectMitigationActions": { "type": "list", "member": { "target": "com.amazonaws.iot#ViolationId" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.iot#Targets": { "type": "list", "member": { "target": "com.amazonaws.iot#Target" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.iot#TaskAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2" } }, "traits": { "smithy.api#documentation": "

\n This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.\n

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#TaskId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 40 } } }, "com.amazonaws.iot#TaskIdList": { "type": "list", "member": { "target": "com.amazonaws.iot#TaskId" } }, "com.amazonaws.iot#TaskStatistics": { "type": "structure", "members": { "totalChecks": { "target": "com.amazonaws.iot#TotalChecksCount", "traits": { "smithy.api#documentation": "

The number of checks in this audit.

" } }, "inProgressChecks": { "target": "com.amazonaws.iot#InProgressChecksCount", "traits": { "smithy.api#documentation": "

The number of checks in progress.

" } }, "waitingForDataCollectionChecks": { "target": "com.amazonaws.iot#WaitingForDataCollectionChecksCount", "traits": { "smithy.api#documentation": "

The number of checks waiting for data collection.

" } }, "compliantChecks": { "target": "com.amazonaws.iot#CompliantChecksCount", "traits": { "smithy.api#documentation": "

The number of checks that found compliant resources.

" } }, "nonCompliantChecks": { "target": "com.amazonaws.iot#NonCompliantChecksCount", "traits": { "smithy.api#documentation": "

The number of checks that found noncompliant resources.

" } }, "failedChecks": { "target": "com.amazonaws.iot#FailedChecksCount", "traits": { "smithy.api#documentation": "

The number of checks.

" } }, "canceledChecks": { "target": "com.amazonaws.iot#CanceledChecksCount", "traits": { "smithy.api#documentation": "

The number of checks that did not run because the audit was canceled.

" } } }, "traits": { "smithy.api#documentation": "

Statistics for the checks performed during the audit.

" } }, "com.amazonaws.iot#TaskStatisticsForAuditCheck": { "type": "structure", "members": { "totalFindingsCount": { "target": "com.amazonaws.iot#TotalFindingsCount", "traits": { "smithy.api#documentation": "

The total number of findings to which a task is being applied.

" } }, "failedFindingsCount": { "target": "com.amazonaws.iot#FailedFindingsCount", "traits": { "smithy.api#documentation": "

The number of findings for which at least one of the actions failed when applied.

" } }, "succeededFindingsCount": { "target": "com.amazonaws.iot#SucceededFindingsCount", "traits": { "smithy.api#documentation": "

The number of findings for which all mitigation actions succeeded when applied.

" } }, "skippedFindingsCount": { "target": "com.amazonaws.iot#SkippedFindingsCount", "traits": { "smithy.api#documentation": "

The number of findings skipped because of filter conditions provided in the parameters to the command.

" } }, "canceledFindingsCount": { "target": "com.amazonaws.iot#CanceledFindingsCount", "traits": { "smithy.api#documentation": "

The number of findings to which the mitigation action task was canceled when applied.

" } } }, "traits": { "smithy.api#documentation": "

Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.

" } }, "com.amazonaws.iot#TemplateArn": { "type": "string" }, "com.amazonaws.iot#TemplateBody": { "type": "string" }, "com.amazonaws.iot#TemplateDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 }, "smithy.api#pattern": "[^\\p{C}]*" } }, "com.amazonaws.iot#TemplateName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 36 }, "smithy.api#pattern": "^[0-9A-Za-z_-]+$" } }, "com.amazonaws.iot#TemplateVersionId": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#TestAuthorization": { "type": "operation", "input": { "target": "com.amazonaws.iot#TestAuthorizationRequest" }, "output": { "target": "com.amazonaws.iot#TestAuthorizationResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Tests if a specified principal is authorized to perform an AWS IoT action on a\n specified resource. Use this to test and debug the authorization behavior of devices that\n connect to the AWS IoT device gateway.

", "smithy.api#http": { "method": "POST", "uri": "/test-authorization", "code": 200 } } }, "com.amazonaws.iot#TestAuthorizationRequest": { "type": "structure", "members": { "principal": { "target": "com.amazonaws.iot#Principal", "traits": { "smithy.api#documentation": "

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

" } }, "cognitoIdentityPoolId": { "target": "com.amazonaws.iot#CognitoIdentityPoolId", "traits": { "smithy.api#documentation": "

The Cognito identity pool ID.

" } }, "authInfos": { "target": "com.amazonaws.iot#AuthInfos", "traits": { "smithy.api#documentation": "

A list of authorization info objects. Simulating authorization will create a response\n for each authInfo object in the list.

", "smithy.api#required": {} } }, "clientId": { "target": "com.amazonaws.iot#ClientId", "traits": { "smithy.api#documentation": "

The MQTT client ID.

", "smithy.api#httpQuery": "clientId" } }, "policyNamesToAdd": { "target": "com.amazonaws.iot#PolicyNames", "traits": { "smithy.api#documentation": "

When testing custom authorization, the policies specified here are treated as if they\n are attached to the principal being authorized.

" } }, "policyNamesToSkip": { "target": "com.amazonaws.iot#PolicyNames", "traits": { "smithy.api#documentation": "

When testing custom authorization, the policies specified here are treated as if they\n are not attached to the principal being authorized.

" } } } }, "com.amazonaws.iot#TestAuthorizationResponse": { "type": "structure", "members": { "authResults": { "target": "com.amazonaws.iot#AuthResults", "traits": { "smithy.api#documentation": "

The authentication results.

" } } } }, "com.amazonaws.iot#TestInvokeAuthorizer": { "type": "operation", "input": { "target": "com.amazonaws.iot#TestInvokeAuthorizerRequest" }, "output": { "target": "com.amazonaws.iot#TestInvokeAuthorizerResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#InvalidResponseException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Tests a custom authorization behavior by invoking a specified custom authorizer. Use\n this to test and debug the custom authorization behavior of devices that connect to the AWS\n IoT device gateway.

", "smithy.api#http": { "method": "POST", "uri": "/authorizer/{authorizerName}/test", "code": 200 } } }, "com.amazonaws.iot#TestInvokeAuthorizerRequest": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The custom authorizer name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "token": { "target": "com.amazonaws.iot#Token", "traits": { "smithy.api#documentation": "

The token returned by your custom authentication service.

" } }, "tokenSignature": { "target": "com.amazonaws.iot#TokenSignature", "traits": { "smithy.api#documentation": "

The signature made with the token and your custom authentication service's private\n key. This value must be Base-64-encoded.

" } }, "httpContext": { "target": "com.amazonaws.iot#HttpContext", "traits": { "smithy.api#documentation": "

Specifies a test HTTP authorization request.

" } }, "mqttContext": { "target": "com.amazonaws.iot#MqttContext", "traits": { "smithy.api#documentation": "

Specifies a test MQTT authorization request.

" } }, "tlsContext": { "target": "com.amazonaws.iot#TlsContext", "traits": { "smithy.api#documentation": "

Specifies a test TLS authorization request.

" } } } }, "com.amazonaws.iot#TestInvokeAuthorizerResponse": { "type": "structure", "members": { "isAuthenticated": { "target": "com.amazonaws.iot#IsAuthenticated", "traits": { "smithy.api#documentation": "

True if the token is authenticated, otherwise false.

" } }, "principalId": { "target": "com.amazonaws.iot#PrincipalId", "traits": { "smithy.api#documentation": "

The principal ID.

" } }, "policyDocuments": { "target": "com.amazonaws.iot#PolicyDocuments", "traits": { "smithy.api#documentation": "

IAM policy documents.

" } }, "refreshAfterInSeconds": { "target": "com.amazonaws.iot#Seconds", "traits": { "smithy.api#documentation": "

The number of seconds after which the temporary credentials are refreshed.

" } }, "disconnectAfterInSeconds": { "target": "com.amazonaws.iot#Seconds", "traits": { "smithy.api#documentation": "

The number of seconds after which the connection is terminated.

" } } } }, "com.amazonaws.iot#ThingArn": { "type": "string" }, "com.amazonaws.iot#ThingAttribute": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing.

" } }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type, if the thing has been associated with a type.

" } }, "thingArn": { "target": "com.amazonaws.iot#ThingArn", "traits": { "smithy.api#documentation": "

The thing ARN.

" } }, "attributes": { "target": "com.amazonaws.iot#Attributes", "traits": { "smithy.api#documentation": "

A list of thing attributes which are name-value pairs.

" } }, "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#documentation": "

The version of the thing record in the registry.

" } } }, "traits": { "smithy.api#documentation": "

The properties of the thing, including thing name, thing type name, and a list of thing\n\t\t\tattributes.

" } }, "com.amazonaws.iot#ThingAttributeList": { "type": "list", "member": { "target": "com.amazonaws.iot#ThingAttribute" } }, "com.amazonaws.iot#ThingConnectivity": { "type": "structure", "members": { "connected": { "target": "com.amazonaws.iot#Boolean", "traits": { "smithy.api#documentation": "

True if the thing is connected to the AWS IoT service; false if it is not\n connected.

" } }, "timestamp": { "target": "com.amazonaws.iot#ConnectivityTimestamp", "traits": { "smithy.api#documentation": "

The epoch time (in milliseconds) when the thing last connected or disconnected. If the\n thing has been disconnected for more than a few weeks, the time value might be missing.

" } } }, "traits": { "smithy.api#documentation": "

The connectivity status of the thing.

" } }, "com.amazonaws.iot#ThingConnectivityIndexingMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "OFF", "name": "OFF" }, { "value": "STATUS", "name": "STATUS" } ] } }, "com.amazonaws.iot#ThingDocument": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The thing name.

" } }, "thingId": { "target": "com.amazonaws.iot#ThingId", "traits": { "smithy.api#documentation": "

The thing ID.

" } }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The thing type name.

" } }, "thingGroupNames": { "target": "com.amazonaws.iot#ThingGroupNameList", "traits": { "smithy.api#documentation": "

Thing group names.

" } }, "attributes": { "target": "com.amazonaws.iot#Attributes", "traits": { "smithy.api#documentation": "

The attributes.

" } }, "shadow": { "target": "com.amazonaws.iot#JsonDocument", "traits": { "smithy.api#documentation": "

The shadow.

" } }, "connectivity": { "target": "com.amazonaws.iot#ThingConnectivity", "traits": { "smithy.api#documentation": "

Indicates whether the thing is connected to the AWS IoT service.

" } } }, "traits": { "smithy.api#documentation": "

The thing search index document.

" } }, "com.amazonaws.iot#ThingDocumentList": { "type": "list", "member": { "target": "com.amazonaws.iot#ThingDocument" } }, "com.amazonaws.iot#ThingGroupArn": { "type": "string" }, "com.amazonaws.iot#ThingGroupDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2028 }, "smithy.api#pattern": "[\\p{Graph}\\x20]*" } }, "com.amazonaws.iot#ThingGroupDocument": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The thing group name.

" } }, "thingGroupId": { "target": "com.amazonaws.iot#ThingGroupId", "traits": { "smithy.api#documentation": "

The thing group ID.

" } }, "thingGroupDescription": { "target": "com.amazonaws.iot#ThingGroupDescription", "traits": { "smithy.api#documentation": "

The thing group description.

" } }, "attributes": { "target": "com.amazonaws.iot#Attributes", "traits": { "smithy.api#documentation": "

The thing group attributes.

" } }, "parentGroupNames": { "target": "com.amazonaws.iot#ThingGroupNameList", "traits": { "smithy.api#documentation": "

Parent group names.

" } } }, "traits": { "smithy.api#documentation": "

The thing group search index document.

" } }, "com.amazonaws.iot#ThingGroupDocumentList": { "type": "list", "member": { "target": "com.amazonaws.iot#ThingGroupDocument" } }, "com.amazonaws.iot#ThingGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9\\-]+" } }, "com.amazonaws.iot#ThingGroupIndexingConfiguration": { "type": "structure", "members": { "thingGroupIndexingMode": { "target": "com.amazonaws.iot#ThingGroupIndexingMode", "traits": { "smithy.api#documentation": "

Thing group indexing mode.

", "smithy.api#required": {} } }, "managedFields": { "target": "com.amazonaws.iot#Fields", "traits": { "smithy.api#documentation": "

Contains fields that are indexed and whose types are already known by the Fleet Indexing\n service.

" } }, "customFields": { "target": "com.amazonaws.iot#Fields", "traits": { "smithy.api#documentation": "

A list of thing group fields to index. This list cannot contain any managed fields. Use\n the GetIndexingConfiguration API to get a list of managed fields.

\n

Contains custom field names and their data type.

" } } }, "traits": { "smithy.api#documentation": "

Thing group indexing configuration.

" } }, "com.amazonaws.iot#ThingGroupIndexingMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "OFF", "name": "OFF" }, { "value": "ON", "name": "ON" } ] } }, "com.amazonaws.iot#ThingGroupList": { "type": "list", "member": { "target": "com.amazonaws.iot#ThingGroupName" } }, "com.amazonaws.iot#ThingGroupMetadata": { "type": "structure", "members": { "parentGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The parent thing group name.

" } }, "rootToParentThingGroups": { "target": "com.amazonaws.iot#ThingGroupNameAndArnList", "traits": { "smithy.api#documentation": "

The root parent thing group.

" } }, "creationDate": { "target": "com.amazonaws.iot#CreationDate", "traits": { "smithy.api#documentation": "

The UNIX timestamp of when the thing group was created.

" } } }, "traits": { "smithy.api#documentation": "

Thing group metadata.

" } }, "com.amazonaws.iot#ThingGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#ThingGroupNameAndArnList": { "type": "list", "member": { "target": "com.amazonaws.iot#GroupNameAndArn" } }, "com.amazonaws.iot#ThingGroupNameList": { "type": "list", "member": { "target": "com.amazonaws.iot#ThingGroupName" } }, "com.amazonaws.iot#ThingGroupNames": { "type": "list", "member": { "target": "com.amazonaws.iot#ThingGroupName" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.iot#ThingGroupProperties": { "type": "structure", "members": { "thingGroupDescription": { "target": "com.amazonaws.iot#ThingGroupDescription", "traits": { "smithy.api#documentation": "

The thing group description.

" } }, "attributePayload": { "target": "com.amazonaws.iot#AttributePayload", "traits": { "smithy.api#documentation": "

The thing group attributes in JSON format.

" } } }, "traits": { "smithy.api#documentation": "

Thing group properties.

" } }, "com.amazonaws.iot#ThingId": { "type": "string" }, "com.amazonaws.iot#ThingIndexingConfiguration": { "type": "structure", "members": { "thingIndexingMode": { "target": "com.amazonaws.iot#ThingIndexingMode", "traits": { "smithy.api#documentation": "

Thing indexing mode. Valid values are:

\n ", "smithy.api#required": {} } }, "thingConnectivityIndexingMode": { "target": "com.amazonaws.iot#ThingConnectivityIndexingMode", "traits": { "smithy.api#documentation": "

Thing connectivity indexing mode. Valid values are:

\n " } }, "managedFields": { "target": "com.amazonaws.iot#Fields", "traits": { "smithy.api#documentation": "

Contains fields that are indexed and whose types are already known by the Fleet Indexing\n service.

" } }, "customFields": { "target": "com.amazonaws.iot#Fields", "traits": { "smithy.api#documentation": "

Contains custom field names and their data type.

" } } }, "traits": { "smithy.api#documentation": "

The thing indexing configuration. For more information, see Managing\n Thing Indexing.

" } }, "com.amazonaws.iot#ThingIndexingMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "OFF", "name": "OFF" }, { "value": "REGISTRY", "name": "REGISTRY" }, { "value": "REGISTRY_AND_SHADOW", "name": "REGISTRY_AND_SHADOW" } ] } }, "com.amazonaws.iot#ThingName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#ThingNameList": { "type": "list", "member": { "target": "com.amazonaws.iot#ThingName" } }, "com.amazonaws.iot#ThingTypeArn": { "type": "string" }, "com.amazonaws.iot#ThingTypeDefinition": { "type": "structure", "members": { "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type.

" } }, "thingTypeArn": { "target": "com.amazonaws.iot#ThingTypeArn", "traits": { "smithy.api#documentation": "

The thing type ARN.

" } }, "thingTypeProperties": { "target": "com.amazonaws.iot#ThingTypeProperties", "traits": { "smithy.api#documentation": "

The ThingTypeProperties for the thing type.

" } }, "thingTypeMetadata": { "target": "com.amazonaws.iot#ThingTypeMetadata", "traits": { "smithy.api#documentation": "

The ThingTypeMetadata contains additional information about the thing type including: creation date and\n\t\t\ttime, a value indicating whether the thing type is deprecated, and a date and time when it was\n\t\t\tdeprecated.

" } } }, "traits": { "smithy.api#documentation": "

The definition of the thing type, including thing type name and description.

" } }, "com.amazonaws.iot#ThingTypeDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2028 }, "smithy.api#pattern": "[\\p{Graph}\\x20]*" } }, "com.amazonaws.iot#ThingTypeId": { "type": "string" }, "com.amazonaws.iot#ThingTypeList": { "type": "list", "member": { "target": "com.amazonaws.iot#ThingTypeDefinition" } }, "com.amazonaws.iot#ThingTypeMetadata": { "type": "structure", "members": { "deprecated": { "target": "com.amazonaws.iot#Boolean", "traits": { "smithy.api#documentation": "

Whether the thing type is deprecated. If true, no new things could be\n\t\t\tassociated with this type.

" } }, "deprecationDate": { "target": "com.amazonaws.iot#DeprecationDate", "traits": { "smithy.api#documentation": "

The date and time when the thing type was deprecated.

" } }, "creationDate": { "target": "com.amazonaws.iot#CreationDate", "traits": { "smithy.api#documentation": "

The date and time when the thing type was created.

" } } }, "traits": { "smithy.api#documentation": "

The ThingTypeMetadata contains additional information about the thing type including: creation date and\n\t\t\ttime, a value indicating whether the thing type is deprecated, and a date and time when time was\n\t\t\tdeprecated.

" } }, "com.amazonaws.iot#ThingTypeName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9:_-]+" } }, "com.amazonaws.iot#ThingTypeProperties": { "type": "structure", "members": { "thingTypeDescription": { "target": "com.amazonaws.iot#ThingTypeDescription", "traits": { "smithy.api#documentation": "

The description of the thing type.

" } }, "searchableAttributes": { "target": "com.amazonaws.iot#SearchableAttributes", "traits": { "smithy.api#documentation": "

A list of searchable thing attribute names.

" } } }, "traits": { "smithy.api#documentation": "

The ThingTypeProperties contains information about the thing type including: a thing type description,\n\t\t\tand a list of searchable thing attribute names.

" } }, "com.amazonaws.iot#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The rate exceeds the limit.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iot#TimedOutThings": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#TimeoutConfig": { "type": "structure", "members": { "inProgressTimeoutInMinutes": { "target": "com.amazonaws.iot#InProgressTimeoutInMinutes", "traits": { "smithy.api#documentation": "

Specifies the amount of time, in minutes, this device has to finish execution of this job. \n The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The \n in progress timer can't be updated and will apply to all job executions for the job. Whenever a job \n execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail \n and switch to the terminal TIMED_OUT status.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. A timer \n is started when the job execution status is set to IN_PROGRESS. If the job \n execution status is not set to another terminal state before the timer expires, it will\n be automatically set to TIMED_OUT.

" } }, "com.amazonaws.iot#Timestamp": { "type": "timestamp" }, "com.amazonaws.iot#TimestreamAction": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the role that grants permission to write to the\n Amazon Timestream database table.

", "smithy.api#required": {} } }, "databaseName": { "target": "com.amazonaws.iot#TimestreamDatabaseName", "traits": { "smithy.api#documentation": "

The name of an Amazon Timestream database.

", "smithy.api#required": {} } }, "tableName": { "target": "com.amazonaws.iot#TimestreamTableName", "traits": { "smithy.api#documentation": "

The name of the database table into which to write the measure records.

", "smithy.api#required": {} } }, "dimensions": { "target": "com.amazonaws.iot#TimestreamDimensionList", "traits": { "smithy.api#documentation": "

Metadata attributes of the time series that are written in each measure record.

", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.iot#TimestreamTimestamp", "traits": { "smithy.api#documentation": "

Specifies an application-defined value to replace the default value assigned to the\n Timestream record's timestamp in the time column.

\n

You can use this property to specify the value and the precision of the Timestream\n record's timestamp. You can specify a value from the message payload or a value computed by\n a substitution template.

\n

If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it\n processed the rule.

" } } }, "traits": { "smithy.api#documentation": "

The Timestream rule action writes attributes (measures) from an MQTT message\n into an Amazon Timestream table. For more information, see the Timestream\n topic rule action documentation.

" } }, "com.amazonaws.iot#TimestreamDatabaseName": { "type": "string" }, "com.amazonaws.iot#TimestreamDimension": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#TimestreamDimensionName", "traits": { "smithy.api#documentation": "

The metadata dimension name. This is the name of the column in the\n Amazon Timestream database table record.

\n

Dimensions cannot be named: measure_name,\n measure_value, or time.\n These names are reserved. Dimension names cannot start\n with ts_ or measure_value and\n they cannot contain the colon (:)\n character.

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.iot#TimestreamDimensionValue", "traits": { "smithy.api#documentation": "

The value to write in this column of the database record.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Metadata attributes of the time series that are written in each measure record.

" } }, "com.amazonaws.iot#TimestreamDimensionList": { "type": "list", "member": { "target": "com.amazonaws.iot#TimestreamDimension" }, "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.iot#TimestreamDimensionName": { "type": "string" }, "com.amazonaws.iot#TimestreamDimensionValue": { "type": "string" }, "com.amazonaws.iot#TimestreamTableName": { "type": "string" }, "com.amazonaws.iot#TimestreamTimestamp": { "type": "structure", "members": { "value": { "target": "com.amazonaws.iot#TimestreamTimestampValue", "traits": { "smithy.api#documentation": "

An expression that returns a long epoch time value.

", "smithy.api#required": {} } }, "unit": { "target": "com.amazonaws.iot#TimestreamTimestampUnit", "traits": { "smithy.api#documentation": "

The precision of the timestamp value that results from the expression\n described in value.

\n

Valid values: SECONDS | MILLISECONDS |\n MICROSECONDS | NANOSECONDS. The default is\n MILLISECONDS.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Describes how to interpret an application-defined timestamp value from an MQTT message\n payload and the precision of that value.

" } }, "com.amazonaws.iot#TimestreamTimestampUnit": { "type": "string" }, "com.amazonaws.iot#TimestreamTimestampValue": { "type": "string" }, "com.amazonaws.iot#TinyMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10 } } }, "com.amazonaws.iot#TlsContext": { "type": "structure", "members": { "serverName": { "target": "com.amazonaws.iot#ServerName", "traits": { "smithy.api#documentation": "

The value of the serverName key in a TLS authorization request.

" } } }, "traits": { "smithy.api#documentation": "

Specifies the TLS context to use for the test authorizer request.

" } }, "com.amazonaws.iot#Token": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 6144 } } }, "com.amazonaws.iot#TokenKeyName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9_-]+" } }, "com.amazonaws.iot#TokenSignature": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2560 }, "smithy.api#pattern": "[A-Za-z0-9+/]+={0,2}" } }, "com.amazonaws.iot#Topic": { "type": "string" }, "com.amazonaws.iot#TopicPattern": { "type": "string" }, "com.amazonaws.iot#TopicRule": { "type": "structure", "members": { "ruleName": { "target": "com.amazonaws.iot#RuleName", "traits": { "smithy.api#documentation": "

The name of the rule.

" } }, "sql": { "target": "com.amazonaws.iot#SQL", "traits": { "smithy.api#documentation": "

The SQL statement used to query the topic. When using a SQL query with multiple\n lines, be sure to escape the newline characters.

" } }, "description": { "target": "com.amazonaws.iot#Description", "traits": { "smithy.api#documentation": "

The description of the rule.

" } }, "createdAt": { "target": "com.amazonaws.iot#CreatedAtDate", "traits": { "smithy.api#documentation": "

The date and time the rule was created.

" } }, "actions": { "target": "com.amazonaws.iot#ActionList", "traits": { "smithy.api#documentation": "

The actions associated with the rule.

" } }, "ruleDisabled": { "target": "com.amazonaws.iot#IsDisabled", "traits": { "smithy.api#documentation": "

Specifies whether the rule is disabled.

" } }, "awsIotSqlVersion": { "target": "com.amazonaws.iot#AwsIotSqlVersion", "traits": { "smithy.api#documentation": "

The version of the SQL rules engine to use when evaluating the rule.

" } }, "errorAction": { "target": "com.amazonaws.iot#Action", "traits": { "smithy.api#documentation": "

The action to perform when an error occurs.

" } } }, "traits": { "smithy.api#documentation": "

Describes a rule.

" } }, "com.amazonaws.iot#TopicRuleDestination": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The topic rule destination URL.

" } }, "status": { "target": "com.amazonaws.iot#TopicRuleDestinationStatus", "traits": { "smithy.api#documentation": "

The status of the topic rule destination. Valid values are:

\n
\n
IN_PROGRESS
\n
\n

A topic rule destination was created but has not been confirmed. You can set\n status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
ENABLED
\n
\n

Confirmation was completed, and traffic to this destination is allowed. You can\n set status to DISABLED by calling\n UpdateTopicRuleDestination.

\n
\n
DISABLED
\n
\n

Confirmation was completed, and traffic to this destination is not allowed. You\n can set status to ENABLED by calling\n UpdateTopicRuleDestination.

\n
\n
ERROR
\n
\n

Confirmation could not be completed, for example if the confirmation timed out.\n You can call GetTopicRuleDestination for details about the error. You\n can set status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
" } }, "createdAt": { "target": "com.amazonaws.iot#CreatedAtDate", "traits": { "smithy.api#documentation": "

The date and time when the topic rule destination was created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.iot#LastUpdatedAtDate", "traits": { "smithy.api#documentation": "

The date and time when the topic rule destination was last updated.

" } }, "statusReason": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

Additional details or reason why the topic rule destination is in the current\n status.

" } }, "httpUrlProperties": { "target": "com.amazonaws.iot#HttpUrlDestinationProperties", "traits": { "smithy.api#documentation": "

Properties of the HTTP URL.

" } }, "vpcProperties": { "target": "com.amazonaws.iot#VpcDestinationProperties", "traits": { "smithy.api#documentation": "

Properties of the virtual private cloud (VPC) connection.

" } } }, "traits": { "smithy.api#documentation": "

A topic rule destination.

" } }, "com.amazonaws.iot#TopicRuleDestinationConfiguration": { "type": "structure", "members": { "httpUrlConfiguration": { "target": "com.amazonaws.iot#HttpUrlDestinationConfiguration", "traits": { "smithy.api#documentation": "

Configuration of the HTTP URL.

" } }, "vpcConfiguration": { "target": "com.amazonaws.iot#VpcDestinationConfiguration", "traits": { "smithy.api#documentation": "

Configuration of the virtual private cloud (VPC) connection.

" } } }, "traits": { "smithy.api#documentation": "

Configuration of the topic rule destination.

" } }, "com.amazonaws.iot#TopicRuleDestinationMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.iot#TopicRuleDestinationStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENABLED", "name": "ENABLED" }, { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "DISABLED", "name": "DISABLED" }, { "value": "ERROR", "name": "ERROR" }, { "value": "DELETING", "name": "DELETING" } ] } }, "com.amazonaws.iot#TopicRuleDestinationSummaries": { "type": "list", "member": { "target": "com.amazonaws.iot#TopicRuleDestinationSummary" } }, "com.amazonaws.iot#TopicRuleDestinationSummary": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The topic rule destination ARN.

" } }, "status": { "target": "com.amazonaws.iot#TopicRuleDestinationStatus", "traits": { "smithy.api#documentation": "

The status of the topic rule destination. Valid values are:

\n
\n
IN_PROGRESS
\n
\n

A topic rule destination was created but has not been confirmed. You can set\n status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
ENABLED
\n
\n

Confirmation was completed, and traffic to this destination is allowed. You can\n set status to DISABLED by calling\n UpdateTopicRuleDestination.

\n
\n
DISABLED
\n
\n

Confirmation was completed, and traffic to this destination is not allowed. You\n can set status to ENABLED by calling\n UpdateTopicRuleDestination.

\n
\n
ERROR
\n
\n

Confirmation could not be completed, for example if the confirmation timed out.\n You can call GetTopicRuleDestination for details about the error. You\n can set status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
" } }, "createdAt": { "target": "com.amazonaws.iot#CreatedAtDate", "traits": { "smithy.api#documentation": "

The date and time when the topic rule destination was created.

" } }, "lastUpdatedAt": { "target": "com.amazonaws.iot#LastUpdatedAtDate", "traits": { "smithy.api#documentation": "

The date and time when the topic rule destination was last updated.

" } }, "statusReason": { "target": "com.amazonaws.iot#String", "traits": { "smithy.api#documentation": "

The reason the topic rule destination is in the current status.

" } }, "httpUrlSummary": { "target": "com.amazonaws.iot#HttpUrlDestinationSummary", "traits": { "smithy.api#documentation": "

Information about the HTTP URL.

" } }, "vpcDestinationSummary": { "target": "com.amazonaws.iot#VpcDestinationSummary", "traits": { "smithy.api#documentation": "

Information about the virtual private cloud (VPC) connection.

" } } }, "traits": { "smithy.api#documentation": "

Information about the topic rule destination.

" } }, "com.amazonaws.iot#TopicRuleList": { "type": "list", "member": { "target": "com.amazonaws.iot#TopicRuleListItem" } }, "com.amazonaws.iot#TopicRuleListItem": { "type": "structure", "members": { "ruleArn": { "target": "com.amazonaws.iot#RuleArn", "traits": { "smithy.api#documentation": "

The rule ARN.

" } }, "ruleName": { "target": "com.amazonaws.iot#RuleName", "traits": { "smithy.api#documentation": "

The name of the rule.

" } }, "topicPattern": { "target": "com.amazonaws.iot#TopicPattern", "traits": { "smithy.api#documentation": "

The pattern for the topic names that apply.

" } }, "createdAt": { "target": "com.amazonaws.iot#CreatedAtDate", "traits": { "smithy.api#documentation": "

The date and time the rule was created.

" } }, "ruleDisabled": { "target": "com.amazonaws.iot#IsDisabled", "traits": { "smithy.api#documentation": "

Specifies whether the rule is disabled.

" } } }, "traits": { "smithy.api#documentation": "

Describes a rule.

" } }, "com.amazonaws.iot#TopicRuleMaxResults": { "type": "integer", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1, "max": 10000 } } }, "com.amazonaws.iot#TopicRulePayload": { "type": "structure", "members": { "sql": { "target": "com.amazonaws.iot#SQL", "traits": { "smithy.api#documentation": "

The SQL statement used to query the topic. For more information, see AWS IoT SQL\n Reference in the AWS IoT Developer Guide.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.iot#Description", "traits": { "smithy.api#documentation": "

The description of the rule.

" } }, "actions": { "target": "com.amazonaws.iot#ActionList", "traits": { "smithy.api#documentation": "

The actions associated with the rule.

", "smithy.api#required": {} } }, "ruleDisabled": { "target": "com.amazonaws.iot#IsDisabled", "traits": { "smithy.api#documentation": "

Specifies whether the rule is disabled.

" } }, "awsIotSqlVersion": { "target": "com.amazonaws.iot#AwsIotSqlVersion", "traits": { "smithy.api#documentation": "

The version of the SQL rules engine to use when evaluating the rule.

" } }, "errorAction": { "target": "com.amazonaws.iot#Action", "traits": { "smithy.api#documentation": "

The action to take when an error occurs.

" } } }, "traits": { "smithy.api#documentation": "

Describes a rule.

" } }, "com.amazonaws.iot#TotalChecksCount": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#TotalFindingsCount": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#TotalResourcesCount": { "type": "long", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#TransferAlreadyCompletedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

You can't revert the certificate transfer because the transfer is already\n complete.

", "smithy.api#error": "client", "smithy.api#httpError": 410 } }, "com.amazonaws.iot#TransferCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iot#TransferCertificateRequest" }, "output": { "target": "com.amazonaws.iot#TransferCertificateResponse" }, "errors": [ { "target": "com.amazonaws.iot#CertificateStateException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#TransferConflictException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Transfers the specified certificate to the specified AWS account.

\n

You can cancel the transfer until it is acknowledged by the recipient.

\n

No notification is sent to the transfer destination's account. It is up to the caller\n to notify the transfer target.

\n

The certificate being transferred must not be in the ACTIVE state. You can use the\n UpdateCertificate API to deactivate it.

\n

The certificate must not have any policies attached to it. You can use the\n DetachPrincipalPolicy API to detach them.

", "smithy.api#http": { "method": "PATCH", "uri": "/transfer-certificate/{certificateId}", "code": 200 } } }, "com.amazonaws.iot#TransferCertificateRequest": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "targetAwsAccount": { "target": "com.amazonaws.iot#AwsAccountId", "traits": { "smithy.api#documentation": "

The AWS account.

", "smithy.api#httpQuery": "targetAwsAccount", "smithy.api#required": {} } }, "transferMessage": { "target": "com.amazonaws.iot#Message", "traits": { "smithy.api#documentation": "

The transfer message.

" } } }, "traits": { "smithy.api#documentation": "

The input for the TransferCertificate operation.

" } }, "com.amazonaws.iot#TransferCertificateResponse": { "type": "structure", "members": { "transferredCertificateArn": { "target": "com.amazonaws.iot#CertificateArn", "traits": { "smithy.api#documentation": "

The ARN of the certificate.

" } } }, "traits": { "smithy.api#documentation": "

The output from the TransferCertificate operation.

" } }, "com.amazonaws.iot#TransferConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

You can't transfer the certificate because authorization policies are still\n attached.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iot#TransferData": { "type": "structure", "members": { "transferMessage": { "target": "com.amazonaws.iot#Message", "traits": { "smithy.api#documentation": "

The transfer message.

" } }, "rejectReason": { "target": "com.amazonaws.iot#Message", "traits": { "smithy.api#documentation": "

The reason why the transfer was rejected.

" } }, "transferDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the transfer took place.

" } }, "acceptDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the transfer was accepted.

" } }, "rejectDate": { "target": "com.amazonaws.iot#DateType", "traits": { "smithy.api#documentation": "

The date the transfer was rejected.

" } } }, "traits": { "smithy.api#documentation": "

Data used to transfer a certificate to an AWS account.

" } }, "com.amazonaws.iot#UnauthorizedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

You are not authorized to perform this operation.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } }, "com.amazonaws.iot#UndoDeprecate": { "type": "boolean" }, "com.amazonaws.iot#UnsignedLong": { "type": "long", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0 } } }, "com.amazonaws.iot#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.iot#UntagResourceRequest" }, "output": { "target": "com.amazonaws.iot#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Removes the given tags (metadata) from the resource.

", "smithy.api#http": { "method": "POST", "uri": "/untag", "code": 200 } } }, "com.amazonaws.iot#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.iot#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN of the resource.

", "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.iot#TagKeyList", "traits": { "smithy.api#documentation": "

A list of the keys of the tags to be removed from the resource.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#UpdateAccountAuditConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateAccountAuditConfigurationRequest" }, "output": { "target": "com.amazonaws.iot#UpdateAccountAuditConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Configures or reconfigures the Device Defender audit settings for this account.\n Settings include how audit notifications are sent and which audit checks are\n enabled or disabled.

", "smithy.api#http": { "method": "PATCH", "uri": "/audit/configuration", "code": 200 } } }, "com.amazonaws.iot#UpdateAccountAuditConfigurationRequest": { "type": "structure", "members": { "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The Amazon\n Resource Name\n (ARN)\n of the role that grants permission\n to\n AWS IoT to access information about your devices, policies,\n certificates,\n and other items as required when performing an audit.

" } }, "auditNotificationTargetConfigurations": { "target": "com.amazonaws.iot#AuditNotificationTargetConfigurations", "traits": { "smithy.api#documentation": "

Information about the targets to which audit notifications are sent.

" } }, "auditCheckConfigurations": { "target": "com.amazonaws.iot#AuditCheckConfigurations", "traits": { "smithy.api#documentation": "

Specifies which audit checks are enabled and disabled for this account. Use \n DescribeAccountAuditConfiguration to see the list of all checks, including those \n that are currently enabled.

\n

Some data collection might start immediately when certain checks are enabled. \n When a check is disabled, any data collected so far in relation to the check is deleted.

\n

You\n cannot\n disable a check if\n it's\n used by any scheduled audit. You must first delete the check from the scheduled audit or\n delete the scheduled audit itself.

\n

On the first call to UpdateAccountAuditConfiguration,\n this parameter is required and must specify at least one enabled check.

" } } } }, "com.amazonaws.iot#UpdateAccountAuditConfigurationResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#UpdateAuditSuppression": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateAuditSuppressionRequest" }, "output": { "target": "com.amazonaws.iot#UpdateAuditSuppressionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n Updates a Device Defender audit suppression.\n

", "smithy.api#http": { "method": "PATCH", "uri": "/audit/suppressions/update", "code": 200 } } }, "com.amazonaws.iot#UpdateAuditSuppressionRequest": { "type": "structure", "members": { "checkName": { "target": "com.amazonaws.iot#AuditCheckName", "traits": { "smithy.api#required": {} } }, "resourceIdentifier": { "target": "com.amazonaws.iot#ResourceIdentifier", "traits": { "smithy.api#required": {} } }, "expirationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.\n

" } }, "suppressIndefinitely": { "target": "com.amazonaws.iot#SuppressIndefinitely", "traits": { "smithy.api#documentation": "

\n Indicates whether a suppression should exist indefinitely or not.\n

" } }, "description": { "target": "com.amazonaws.iot#AuditDescription", "traits": { "smithy.api#documentation": "

\n The description of the audit suppression.\n

" } } } }, "com.amazonaws.iot#UpdateAuditSuppressionResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#UpdateAuthorizer": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateAuthorizerRequest" }, "output": { "target": "com.amazonaws.iot#UpdateAuthorizerResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#LimitExceededException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates an authorizer.

", "smithy.api#http": { "method": "PUT", "uri": "/authorizer/{authorizerName}", "code": 200 } } }, "com.amazonaws.iot#UpdateAuthorizerRequest": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The authorizer name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "authorizerFunctionArn": { "target": "com.amazonaws.iot#AuthorizerFunctionArn", "traits": { "smithy.api#documentation": "

The ARN of the authorizer's Lambda function.

" } }, "tokenKeyName": { "target": "com.amazonaws.iot#TokenKeyName", "traits": { "smithy.api#documentation": "

The key used to extract the token from the HTTP headers.

" } }, "tokenSigningPublicKeys": { "target": "com.amazonaws.iot#PublicKeyMap", "traits": { "smithy.api#documentation": "

The public keys used to verify the token signature.

" } }, "status": { "target": "com.amazonaws.iot#AuthorizerStatus", "traits": { "smithy.api#documentation": "

The status of the update authorizer request.

" } } } }, "com.amazonaws.iot#UpdateAuthorizerResponse": { "type": "structure", "members": { "authorizerName": { "target": "com.amazonaws.iot#AuthorizerName", "traits": { "smithy.api#documentation": "

The authorizer name.

" } }, "authorizerArn": { "target": "com.amazonaws.iot#AuthorizerArn", "traits": { "smithy.api#documentation": "

The authorizer ARN.

" } } } }, "com.amazonaws.iot#UpdateBillingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateBillingGroupRequest" }, "output": { "target": "com.amazonaws.iot#UpdateBillingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Updates information about the billing group.

", "smithy.api#http": { "method": "PATCH", "uri": "/billing-groups/{billingGroupName}", "code": 200 } } }, "com.amazonaws.iot#UpdateBillingGroupRequest": { "type": "structure", "members": { "billingGroupName": { "target": "com.amazonaws.iot#BillingGroupName", "traits": { "smithy.api#documentation": "

The name of the billing group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "billingGroupProperties": { "target": "com.amazonaws.iot#BillingGroupProperties", "traits": { "smithy.api#documentation": "

The properties of the billing group.

", "smithy.api#required": {} } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the billing group. If the version of the billing group does\n\t\t\tnot match the expected version specified in the request, the\n\t\t\t\tUpdateBillingGroup request is rejected with a\n\t\t\t\tVersionConflictException.

" } } } }, "com.amazonaws.iot#UpdateBillingGroupResponse": { "type": "structure", "members": { "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#documentation": "

The latest version of the billing group.

" } } } }, "com.amazonaws.iot#UpdateCACertificate": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateCACertificateRequest" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates a registered CA certificate.

", "smithy.api#http": { "method": "PUT", "uri": "/cacertificate/{certificateId}", "code": 200 } } }, "com.amazonaws.iot#UpdateCACertificateParams": { "type": "structure", "members": { "action": { "target": "com.amazonaws.iot#CACertificateUpdateAction", "traits": { "smithy.api#documentation": "

The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

" } }, "com.amazonaws.iot#UpdateCACertificateRequest": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The CA certificate identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "newStatus": { "target": "com.amazonaws.iot#CACertificateStatus", "traits": { "smithy.api#documentation": "

The updated status of the CA certificate.

\n

\n Note: The status value REGISTER_INACTIVE is deprecated and\n should not be used.

", "smithy.api#httpQuery": "newStatus" } }, "newAutoRegistrationStatus": { "target": "com.amazonaws.iot#AutoRegistrationStatus", "traits": { "smithy.api#documentation": "

The new value for the auto registration status. Valid values are: \"ENABLE\" or\n \"DISABLE\".

", "smithy.api#httpQuery": "newAutoRegistrationStatus" } }, "registrationConfig": { "target": "com.amazonaws.iot#RegistrationConfig", "traits": { "smithy.api#documentation": "

Information about the registration configuration.

" } }, "removeAutoRegistration": { "target": "com.amazonaws.iot#RemoveAutoRegistration", "traits": { "smithy.api#documentation": "

If true, removes auto registration.

" } } }, "traits": { "smithy.api#documentation": "

The input to the UpdateCACertificate operation.

" } }, "com.amazonaws.iot#UpdateCertificate": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateCertificateRequest" }, "errors": [ { "target": "com.amazonaws.iot#CertificateStateException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates the status of the specified certificate. This operation is\n idempotent.

\n

Certificates must be in the ACTIVE state to authenticate devices that use\n a certificate to connect to AWS IoT.

\n

Within a few minutes of updating a certificate from the ACTIVE state to any other\n state, AWS IoT disconnects all devices that used that certificate to connect. Devices cannot\n use a certificate that is not in the ACTIVE state to reconnect.

", "smithy.api#http": { "method": "PUT", "uri": "/certificates/{certificateId}", "code": 200 } } }, "com.amazonaws.iot#UpdateCertificateRequest": { "type": "structure", "members": { "certificateId": { "target": "com.amazonaws.iot#CertificateId", "traits": { "smithy.api#documentation": "

The ID of the certificate. (The last part of the certificate ARN contains the\n certificate ID.)

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "newStatus": { "target": "com.amazonaws.iot#CertificateStatus", "traits": { "smithy.api#documentation": "

The new status.

\n

\n Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result\n in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by AWS IoT. They \n are not intended for developer use.

\n

\n Note: The status value REGISTER_INACTIVE is deprecated and\n should not be used.

", "smithy.api#httpQuery": "newStatus", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The input for the UpdateCertificate operation.

" } }, "com.amazonaws.iot#UpdateCustomMetric": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateCustomMetricRequest" }, "output": { "target": "com.amazonaws.iot#UpdateCustomMetricResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Updates a\n Device Defender detect custom metric.

", "smithy.api#http": { "method": "PATCH", "uri": "/custom-metric/{metricName}", "code": 200 } } }, "com.amazonaws.iot#UpdateCustomMetricRequest": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { "smithy.api#documentation": "

The name of the custom metric.\n Cannot be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { "smithy.api#documentation": "

\n Field\n represents a friendly name in the console for the custom metric,\n it\n doesn't have to be unique. Don't use this name as the metric identifier in\n the device metric report.\n Can\n be updated.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#UpdateCustomMetricResponse": { "type": "structure", "members": { "metricName": { "target": "com.amazonaws.iot#MetricName", "traits": { "smithy.api#documentation": "

\n The name of the custom metric.\n

" } }, "metricArn": { "target": "com.amazonaws.iot#CustomMetricArn", "traits": { "smithy.api#documentation": "

\n The Amazon Resource Number (ARN) of the custom metric.\n

" } }, "metricType": { "target": "com.amazonaws.iot#CustomMetricType", "traits": { "smithy.api#documentation": "

\n The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.\n

" } }, "displayName": { "target": "com.amazonaws.iot#CustomMetricDisplayName", "traits": { "smithy.api#documentation": "

\n A friendly name in the console for the custom metric\n

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The creation date of the custom metric in milliseconds since epoch.\n

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The time the custom metric was last modified in milliseconds since epoch.\n

" } } } }, "com.amazonaws.iot#UpdateDeviceCertificateParams": { "type": "structure", "members": { "action": { "target": "com.amazonaws.iot#DeviceCertificateUpdateAction", "traits": { "smithy.api#documentation": "

The action that you want to apply to the device certificate. The only supported value is DEACTIVATE.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

" } }, "com.amazonaws.iot#UpdateDimension": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateDimensionRequest" }, "output": { "target": "com.amazonaws.iot#UpdateDimensionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Updates the definition for a dimension. You\n cannot\n change the type of a dimension after\n it is created (you can delete it and\n recreate\n it).

", "smithy.api#http": { "method": "PATCH", "uri": "/dimensions/{name}", "code": 200 } } }, "com.amazonaws.iot#UpdateDimensionRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { "smithy.api#documentation": "

A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { "smithy.api#documentation": "

Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, \"admin/#\").

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#UpdateDimensionResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.iot#DimensionName", "traits": { "smithy.api#documentation": "

A unique identifier for the dimension.

" } }, "arn": { "target": "com.amazonaws.iot#DimensionArn", "traits": { "smithy.api#documentation": "

The Amazon Resource\n Name (ARN)of\n the created dimension.

" } }, "type": { "target": "com.amazonaws.iot#DimensionType", "traits": { "smithy.api#documentation": "

The type of the dimension.

" } }, "stringValues": { "target": "com.amazonaws.iot#DimensionStringValues", "traits": { "smithy.api#documentation": "

The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was initially created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The date and time, in milliseconds since epoch, when the dimension was most recently updated.

" } } } }, "com.amazonaws.iot#UpdateDomainConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateDomainConfigurationRequest" }, "output": { "target": "com.amazonaws.iot#UpdateDomainConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.iot#CertificateValidationException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.

", "smithy.api#http": { "method": "PUT", "uri": "/domainConfigurations/{domainConfigurationName}", "code": 200 } } }, "com.amazonaws.iot#UpdateDomainConfigurationRequest": { "type": "structure", "members": { "domainConfigurationName": { "target": "com.amazonaws.iot#ReservedDomainConfigurationName", "traits": { "smithy.api#documentation": "

The name of the domain configuration to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "authorizerConfig": { "target": "com.amazonaws.iot#AuthorizerConfig", "traits": { "smithy.api#documentation": "

An object that specifies the authorization service for a domain.

" } }, "domainConfigurationStatus": { "target": "com.amazonaws.iot#DomainConfigurationStatus", "traits": { "smithy.api#documentation": "

The status to which the domain configuration should be updated.

" } }, "removeAuthorizerConfig": { "target": "com.amazonaws.iot#RemoveAuthorizerConfig", "traits": { "smithy.api#documentation": "

Removes the authorization configuration from a domain.

" } } } }, "com.amazonaws.iot#UpdateDomainConfigurationResponse": { "type": "structure", "members": { "domainConfigurationName": { "target": "com.amazonaws.iot#ReservedDomainConfigurationName", "traits": { "smithy.api#documentation": "

The name of the domain configuration that was updated.

" } }, "domainConfigurationArn": { "target": "com.amazonaws.iot#DomainConfigurationArn", "traits": { "smithy.api#documentation": "

The ARN of the domain configuration that was updated.

" } } } }, "com.amazonaws.iot#UpdateDynamicThingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateDynamicThingGroupRequest" }, "output": { "target": "com.amazonaws.iot#UpdateDynamicThingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidQueryException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Updates a dynamic thing group.

", "smithy.api#http": { "method": "PATCH", "uri": "/dynamic-thing-groups/{thingGroupName}", "code": 200 } } }, "com.amazonaws.iot#UpdateDynamicThingGroupRequest": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The name of the dynamic thing group to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "thingGroupProperties": { "target": "com.amazonaws.iot#ThingGroupProperties", "traits": { "smithy.api#documentation": "

The dynamic thing group properties to update.

", "smithy.api#required": {} } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the dynamic thing group to update.

" } }, "indexName": { "target": "com.amazonaws.iot#IndexName", "traits": { "smithy.api#documentation": "

The dynamic thing group index to update.

\n\t\t \n\t\t\t

Currently one index is supported: 'AWS_Things'.

\n\t\t
" } }, "queryString": { "target": "com.amazonaws.iot#QueryString", "traits": { "smithy.api#documentation": "

The dynamic thing group search query string to update.

" } }, "queryVersion": { "target": "com.amazonaws.iot#QueryVersion", "traits": { "smithy.api#documentation": "

The dynamic thing group query version to update.

\n\t\t \n\t\t\t

Currently one query version is supported: \"2017-09-30\". If not specified, the\n\t\t\t\tquery version defaults to this value.

\n\t\t
" } } } }, "com.amazonaws.iot#UpdateDynamicThingGroupResponse": { "type": "structure", "members": { "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#documentation": "

The dynamic thing group version.

" } } } }, "com.amazonaws.iot#UpdateEventConfigurations": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateEventConfigurationsRequest" }, "output": { "target": "com.amazonaws.iot#UpdateEventConfigurationsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Updates the event configurations.

", "smithy.api#http": { "method": "PATCH", "uri": "/event-configurations", "code": 200 } } }, "com.amazonaws.iot#UpdateEventConfigurationsRequest": { "type": "structure", "members": { "eventConfigurations": { "target": "com.amazonaws.iot#EventConfigurations", "traits": { "smithy.api#documentation": "

The new event configuration values.

" } } } }, "com.amazonaws.iot#UpdateEventConfigurationsResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#UpdateIndexingConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateIndexingConfigurationRequest" }, "output": { "target": "com.amazonaws.iot#UpdateIndexingConfigurationResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates the search configuration.

", "smithy.api#http": { "method": "POST", "uri": "/indexing/config", "code": 200 } } }, "com.amazonaws.iot#UpdateIndexingConfigurationRequest": { "type": "structure", "members": { "thingIndexingConfiguration": { "target": "com.amazonaws.iot#ThingIndexingConfiguration", "traits": { "smithy.api#documentation": "

Thing indexing configuration.

" } }, "thingGroupIndexingConfiguration": { "target": "com.amazonaws.iot#ThingGroupIndexingConfiguration", "traits": { "smithy.api#documentation": "

Thing group indexing configuration.

" } } } }, "com.amazonaws.iot#UpdateIndexingConfigurationResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#UpdateJob": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateJobRequest" }, "errors": [ { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Updates supported fields of the specified job.

", "smithy.api#http": { "method": "PATCH", "uri": "/jobs/{jobId}", "code": 200 } } }, "com.amazonaws.iot#UpdateJobRequest": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.iot#JobId", "traits": { "smithy.api#documentation": "

The ID of the job to be updated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.iot#JobDescription", "traits": { "smithy.api#documentation": "

A short text description of the job.

" } }, "presignedUrlConfig": { "target": "com.amazonaws.iot#PresignedUrlConfig", "traits": { "smithy.api#documentation": "

Configuration information for pre-signed S3 URLs.

" } }, "jobExecutionsRolloutConfig": { "target": "com.amazonaws.iot#JobExecutionsRolloutConfig", "traits": { "smithy.api#documentation": "

Allows you to create a staged rollout of the job.

" } }, "abortConfig": { "target": "com.amazonaws.iot#AbortConfig", "traits": { "smithy.api#documentation": "

Allows you to create criteria to abort a job.

" } }, "timeoutConfig": { "target": "com.amazonaws.iot#TimeoutConfig", "traits": { "smithy.api#documentation": "

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. \n If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

" } }, "namespaceId": { "target": "com.amazonaws.iot#NamespaceId", "traits": { "smithy.api#documentation": "

The namespace used to indicate that a job is a customer-managed job.

\n

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that \n contain the value in the following format.

\n

\n $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/\n

\n \n

The namespaceId feature is in public preview.

\n
", "smithy.api#httpQuery": "namespaceId" } } } }, "com.amazonaws.iot#UpdateMitigationAction": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateMitigationActionRequest" }, "output": { "target": "com.amazonaws.iot#UpdateMitigationActionResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Updates the definition for the specified mitigation action.

", "smithy.api#http": { "method": "PATCH", "uri": "/mitigationactions/actions/{actionName}", "code": 200 } } }, "com.amazonaws.iot#UpdateMitigationActionRequest": { "type": "structure", "members": { "actionName": { "target": "com.amazonaws.iot#MitigationActionName", "traits": { "smithy.api#documentation": "

The friendly name for the mitigation action. You cannot change the name by using\n UpdateMitigationAction. Instead, you must delete and\n recreate the\n mitigation action with the new name.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that is used to apply the mitigation action.

" } }, "actionParams": { "target": "com.amazonaws.iot#MitigationActionParams", "traits": { "smithy.api#documentation": "

Defines the type of action and the parameters for that action.

" } } } }, "com.amazonaws.iot#UpdateMitigationActionResponse": { "type": "structure", "members": { "actionArn": { "target": "com.amazonaws.iot#MitigationActionArn", "traits": { "smithy.api#documentation": "

The ARN for the new mitigation action.

" } }, "actionId": { "target": "com.amazonaws.iot#MitigationActionId", "traits": { "smithy.api#documentation": "

A unique identifier for the mitigation action.

" } } } }, "com.amazonaws.iot#UpdateProvisioningTemplate": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateProvisioningTemplateRequest" }, "output": { "target": "com.amazonaws.iot#UpdateProvisioningTemplateResponse" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates a fleet provisioning template.

", "smithy.api#http": { "method": "PATCH", "uri": "/provisioning-templates/{templateName}", "code": 200 } } }, "com.amazonaws.iot#UpdateProvisioningTemplateRequest": { "type": "structure", "members": { "templateName": { "target": "com.amazonaws.iot#TemplateName", "traits": { "smithy.api#documentation": "

The name of the fleet provisioning template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.iot#TemplateDescription", "traits": { "smithy.api#documentation": "

The description of the fleet provisioning template.

" } }, "enabled": { "target": "com.amazonaws.iot#Enabled", "traits": { "smithy.api#documentation": "

True to enable the fleet provisioning template, otherwise false.

" } }, "defaultVersionId": { "target": "com.amazonaws.iot#TemplateVersionId", "traits": { "smithy.api#documentation": "

The ID of the default provisioning template version.

" } }, "provisioningRoleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the role associated with the provisioning template. This IoT role grants\n permission to provision a device.

" } }, "preProvisioningHook": { "target": "com.amazonaws.iot#ProvisioningHook", "traits": { "smithy.api#documentation": "

Updates the pre-provisioning hook template.

" } }, "removePreProvisioningHook": { "target": "com.amazonaws.iot#RemoveHook", "traits": { "smithy.api#documentation": "

Removes pre-provisioning hook template.

" } } } }, "com.amazonaws.iot#UpdateProvisioningTemplateResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#UpdateRoleAlias": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateRoleAliasRequest" }, "output": { "target": "com.amazonaws.iot#UpdateRoleAliasResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates a role alias.

", "smithy.api#http": { "method": "PUT", "uri": "/role-aliases/{roleAlias}", "code": 200 } } }, "com.amazonaws.iot#UpdateRoleAliasRequest": { "type": "structure", "members": { "roleAlias": { "target": "com.amazonaws.iot#RoleAlias", "traits": { "smithy.api#documentation": "

The role alias to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

The role ARN.

" } }, "credentialDurationSeconds": { "target": "com.amazonaws.iot#CredentialDurationSeconds", "traits": { "smithy.api#documentation": "

The number of seconds the credential will be valid.

" } } } }, "com.amazonaws.iot#UpdateRoleAliasResponse": { "type": "structure", "members": { "roleAlias": { "target": "com.amazonaws.iot#RoleAlias", "traits": { "smithy.api#documentation": "

The role alias.

" } }, "roleAliasArn": { "target": "com.amazonaws.iot#RoleAliasArn", "traits": { "smithy.api#documentation": "

The role alias ARN.

" } } } }, "com.amazonaws.iot#UpdateScheduledAudit": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateScheduledAuditRequest" }, "output": { "target": "com.amazonaws.iot#UpdateScheduledAuditResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Updates a scheduled audit, including which checks are performed and\n how often the audit takes place.

", "smithy.api#http": { "method": "PATCH", "uri": "/audit/scheduledaudits/{scheduledAuditName}", "code": 200 } } }, "com.amazonaws.iot#UpdateScheduledAuditRequest": { "type": "structure", "members": { "frequency": { "target": "com.amazonaws.iot#AuditFrequency", "traits": { "smithy.api#documentation": "

How often the scheduled audit takes\n place,\n either DAILY,\n WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the\n system.

" } }, "dayOfMonth": { "target": "com.amazonaws.iot#DayOfMonth", "traits": { "smithy.api#documentation": "

The day of the month on which the scheduled audit takes place.\n This\n can\n be 1 through 31 or LAST. This field is required if the frequency parameter is set to\n MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit\n takes place on the \"LAST\" day of the month.

" } }, "dayOfWeek": { "target": "com.amazonaws.iot#DayOfWeek", "traits": { "smithy.api#documentation": "

The day of the week on which the scheduled audit takes place.\n This\n can\n be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the\n \"frequency\" parameter is set to WEEKLY or BIWEEKLY.

" } }, "targetCheckNames": { "target": "com.amazonaws.iot#TargetAuditCheckNames", "traits": { "smithy.api#documentation": "

Which checks are performed during the scheduled audit. Checks must be enabled \n for your account. (Use DescribeAccountAuditConfiguration to see the list\n of all checks, including those that are enabled or use UpdateAccountAuditConfiguration \n to select which checks are enabled.)

" } }, "scheduledAuditName": { "target": "com.amazonaws.iot#ScheduledAuditName", "traits": { "smithy.api#documentation": "

The name of the scheduled audit. (Max. 128 chars)

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.iot#UpdateScheduledAuditResponse": { "type": "structure", "members": { "scheduledAuditArn": { "target": "com.amazonaws.iot#ScheduledAuditArn", "traits": { "smithy.api#documentation": "

The ARN of the scheduled audit.

" } } } }, "com.amazonaws.iot#UpdateSecurityProfile": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateSecurityProfileRequest" }, "output": { "target": "com.amazonaws.iot#UpdateSecurityProfileResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Updates a Device Defender security profile.

", "smithy.api#http": { "method": "PATCH", "uri": "/security-profiles/{securityProfileName}", "code": 200 } } }, "com.amazonaws.iot#UpdateSecurityProfileRequest": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name of the security profile you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "securityProfileDescription": { "target": "com.amazonaws.iot#SecurityProfileDescription", "traits": { "smithy.api#documentation": "

A description of the security profile.

" } }, "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, "alertTargets": { "target": "com.amazonaws.iot#AlertTargets", "traits": { "smithy.api#documentation": "

Where the alerts are sent. (Alerts are always sent to the console.)

" } }, "additionalMetricsToRetain": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainList", "traits": { "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, "smithy.api#documentation": "

\n Please use\n UpdateSecurityProfileRequest$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the profile's behaviors, but\n it is\n also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" } }, "deleteBehaviors": { "target": "com.amazonaws.iot#DeleteBehaviors", "traits": { "smithy.api#documentation": "

If true, delete all behaviors defined for this security profile. \n If any behaviors are defined in the current invocation, an exception occurs.

" } }, "deleteAlertTargets": { "target": "com.amazonaws.iot#DeleteAlertTargets", "traits": { "smithy.api#documentation": "

If true, delete all alertTargets defined for this security profile. \n If any alertTargets are defined in the current invocation, an exception occurs.

" } }, "deleteAdditionalMetricsToRetain": { "target": "com.amazonaws.iot#DeleteAdditionalMetricsToRetain", "traits": { "smithy.api#documentation": "

If true, delete all additionalMetricsToRetain defined for this \n security profile. If any additionalMetricsToRetain are defined in the current \n invocation, an exception occurs.

" } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the security profile. A new version is generated whenever\n the security profile is updated. If you specify a value that is different from the actual\n version, a VersionConflictException is thrown.

", "smithy.api#httpQuery": "expectedVersion" } } } }, "com.amazonaws.iot#UpdateSecurityProfileResponse": { "type": "structure", "members": { "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name of the security profile that was updated.

" } }, "securityProfileArn": { "target": "com.amazonaws.iot#SecurityProfileArn", "traits": { "smithy.api#documentation": "

The ARN of the security profile that was updated.

" } }, "securityProfileDescription": { "target": "com.amazonaws.iot#SecurityProfileDescription", "traits": { "smithy.api#documentation": "

The description of the security profile.

" } }, "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" } }, "alertTargets": { "target": "com.amazonaws.iot#AlertTargets", "traits": { "smithy.api#documentation": "

Where the alerts are sent. (Alerts are always sent to the console.)

" } }, "additionalMetricsToRetain": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainList", "traits": { "smithy.api#deprecated": { "message": "Use additionalMetricsToRetainV2." }, "smithy.api#documentation": "

\n Please use\n UpdateSecurityProfileResponse$additionalMetricsToRetainV2\n instead.\n

\n

A list of metrics\n whose data is retained (stored). By default, data is retained for any metric\n used in the security profile's behaviors, but\n it is\n also retained for any metric specified here.

" } }, "additionalMetricsToRetainV2": { "target": "com.amazonaws.iot#AdditionalMetricsToRetainV2List", "traits": { "smithy.api#documentation": "

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

" } }, "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#documentation": "

The updated version of the security profile.

" } }, "creationDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time the security profile was created.

" } }, "lastModifiedDate": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time the security profile was last modified.

" } } } }, "com.amazonaws.iot#UpdateStream": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateStreamRequest" }, "output": { "target": "com.amazonaws.iot#UpdateStreamResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates an existing stream. The stream version will be incremented by one.

", "smithy.api#http": { "method": "PUT", "uri": "/streams/{streamId}", "code": 200 } } }, "com.amazonaws.iot#UpdateStreamRequest": { "type": "structure", "members": { "streamId": { "target": "com.amazonaws.iot#StreamId", "traits": { "smithy.api#documentation": "

The stream ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.iot#StreamDescription", "traits": { "smithy.api#documentation": "

The description of the stream.

" } }, "files": { "target": "com.amazonaws.iot#StreamFiles", "traits": { "smithy.api#documentation": "

The files associated with the stream.

" } }, "roleArn": { "target": "com.amazonaws.iot#RoleArn", "traits": { "smithy.api#documentation": "

An IAM role that allows the IoT service principal assumes to access your S3 files.

" } } } }, "com.amazonaws.iot#UpdateStreamResponse": { "type": "structure", "members": { "streamId": { "target": "com.amazonaws.iot#StreamId", "traits": { "smithy.api#documentation": "

The stream ID.

" } }, "streamArn": { "target": "com.amazonaws.iot#StreamArn", "traits": { "smithy.api#documentation": "

The stream ARN.

" } }, "description": { "target": "com.amazonaws.iot#StreamDescription", "traits": { "smithy.api#documentation": "

A description of the stream.

" } }, "streamVersion": { "target": "com.amazonaws.iot#StreamVersion", "traits": { "smithy.api#documentation": "

The stream version.

" } } } }, "com.amazonaws.iot#UpdateThing": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateThingRequest" }, "output": { "target": "com.amazonaws.iot#UpdateThingResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#UnauthorizedException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Updates the data for a thing.

", "smithy.api#http": { "method": "PATCH", "uri": "/things/{thingName}", "code": 200 } } }, "com.amazonaws.iot#UpdateThingGroup": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateThingGroupRequest" }, "output": { "target": "com.amazonaws.iot#UpdateThingGroupResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { "target": "com.amazonaws.iot#VersionConflictException" } ], "traits": { "smithy.api#documentation": "

Update a thing group.

", "smithy.api#http": { "method": "PATCH", "uri": "/thing-groups/{thingGroupName}", "code": 200 } } }, "com.amazonaws.iot#UpdateThingGroupRequest": { "type": "structure", "members": { "thingGroupName": { "target": "com.amazonaws.iot#ThingGroupName", "traits": { "smithy.api#documentation": "

The thing group to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "thingGroupProperties": { "target": "com.amazonaws.iot#ThingGroupProperties", "traits": { "smithy.api#documentation": "

The thing group properties.

", "smithy.api#required": {} } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the thing group. If this does not match the version of the\n\t\t\tthing group being updated, the update will fail.

" } } } }, "com.amazonaws.iot#UpdateThingGroupResponse": { "type": "structure", "members": { "version": { "target": "com.amazonaws.iot#Version", "traits": { "smithy.api#documentation": "

The version of the updated thing group.

" } } } }, "com.amazonaws.iot#UpdateThingGroupsForThing": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateThingGroupsForThingRequest" }, "output": { "target": "com.amazonaws.iot#UpdateThingGroupsForThingResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Updates the groups to which the thing belongs.

", "smithy.api#http": { "method": "PUT", "uri": "/thing-groups/updateThingGroupsForThing", "code": 200 } } }, "com.amazonaws.iot#UpdateThingGroupsForThingRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The thing whose group memberships will be updated.

" } }, "thingGroupsToAdd": { "target": "com.amazonaws.iot#ThingGroupList", "traits": { "smithy.api#documentation": "

The groups to which the thing will be added.

" } }, "thingGroupsToRemove": { "target": "com.amazonaws.iot#ThingGroupList", "traits": { "smithy.api#documentation": "

The groups from which the thing will be removed.

" } }, "overrideDynamicGroups": { "target": "com.amazonaws.iot#OverrideDynamicGroups", "traits": { "smithy.api#documentation": "

Override dynamic thing groups with static thing groups when 10-group limit is\n\t\t\treached. If a thing belongs to 10 thing groups, and one or more of those groups are\n\t\t\tdynamic thing groups, adding a thing to a static group removes the thing from the last\n\t\t\tdynamic group.

" } } } }, "com.amazonaws.iot#UpdateThingGroupsForThingResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#UpdateThingRequest": { "type": "structure", "members": { "thingName": { "target": "com.amazonaws.iot#ThingName", "traits": { "smithy.api#documentation": "

The name of the thing to update.

\n\t\t

You can't change a thing's name. To change a thing's name, you must create a\n\t\t\tnew thing, give it the new name, and then delete the old thing.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "thingTypeName": { "target": "com.amazonaws.iot#ThingTypeName", "traits": { "smithy.api#documentation": "

The name of the thing type.

" } }, "attributePayload": { "target": "com.amazonaws.iot#AttributePayload", "traits": { "smithy.api#documentation": "

A list of thing attributes, a JSON string containing name-value pairs. For\n\t\t\texample:

\n\t\t

\n\t\t\t {\\\"attributes\\\":{\\\"name1\\\":\\\"value2\\\"}}\n\t\t

\n\t\t

This data is used to add new attributes or update existing attributes.

" } }, "expectedVersion": { "target": "com.amazonaws.iot#OptionalVersion", "traits": { "smithy.api#documentation": "

The expected version of the thing record in the registry. If the version of the\n\t\t\trecord in the registry does not match the expected version specified in the request, the\n\t\t\t\tUpdateThing request is rejected with a\n\t\t\t\tVersionConflictException.

" } }, "removeThingType": { "target": "com.amazonaws.iot#RemoveThingType", "traits": { "smithy.api#documentation": "

Remove a thing type association. If true, the\n\t\t\tassociation is removed.

" } } }, "traits": { "smithy.api#documentation": "

The input for the UpdateThing operation.

" } }, "com.amazonaws.iot#UpdateThingResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "

The output from the UpdateThing operation.

" } }, "com.amazonaws.iot#UpdateTopicRuleDestination": { "type": "operation", "input": { "target": "com.amazonaws.iot#UpdateTopicRuleDestinationRequest" }, "output": { "target": "com.amazonaws.iot#UpdateTopicRuleDestinationResponse" }, "errors": [ { "target": "com.amazonaws.iot#ConflictingResourceUpdateException" }, { "target": "com.amazonaws.iot#InternalException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ServiceUnavailableException" }, { "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { "smithy.api#documentation": "

Updates a topic rule destination. You use this to change the status, endpoint URL, or\n confirmation URL of the destination.

", "smithy.api#http": { "method": "PATCH", "uri": "/destinations", "code": 200 } } }, "com.amazonaws.iot#UpdateTopicRuleDestinationRequest": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of the topic rule destination.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.iot#TopicRuleDestinationStatus", "traits": { "smithy.api#documentation": "

The status of the topic rule destination. Valid values are:

\n
\n
IN_PROGRESS
\n
\n

A topic rule destination was created but has not been confirmed. You can set\n status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
ENABLED
\n
\n

Confirmation was completed, and traffic to this destination is allowed. You can\n set status to DISABLED by calling\n UpdateTopicRuleDestination.

\n
\n
DISABLED
\n
\n

Confirmation was completed, and traffic to this destination is not allowed. You\n can set status to ENABLED by calling\n UpdateTopicRuleDestination.

\n
\n
ERROR
\n
\n

Confirmation could not be completed, for example if the confirmation timed out.\n You can call GetTopicRuleDestination for details about the error. You\n can set status to IN_PROGRESS by calling\n UpdateTopicRuleDestination. Calling\n UpdateTopicRuleDestination causes a new confirmation challenge to\n be sent to your confirmation endpoint.

\n
\n
", "smithy.api#required": {} } } } }, "com.amazonaws.iot#UpdateTopicRuleDestinationResponse": { "type": "structure", "members": {} }, "com.amazonaws.iot#Url": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2000 } } }, "com.amazonaws.iot#UseBase64": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#Valid": { "type": "boolean" }, "com.amazonaws.iot#ValidateSecurityProfileBehaviors": { "type": "operation", "input": { "target": "com.amazonaws.iot#ValidateSecurityProfileBehaviorsRequest" }, "output": { "target": "com.amazonaws.iot#ValidateSecurityProfileBehaviorsResponse" }, "errors": [ { "target": "com.amazonaws.iot#InternalFailureException" }, { "target": "com.amazonaws.iot#InvalidRequestException" }, { "target": "com.amazonaws.iot#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Validates a Device Defender security profile behaviors specification.

", "smithy.api#http": { "method": "POST", "uri": "/security-profile-behaviors/validate", "code": 200 } } }, "com.amazonaws.iot#ValidateSecurityProfileBehaviorsRequest": { "type": "structure", "members": { "behaviors": { "target": "com.amazonaws.iot#Behaviors", "traits": { "smithy.api#documentation": "

Specifies the behaviors that, when violated by a device (thing), cause an alert.

", "smithy.api#required": {} } } } }, "com.amazonaws.iot#ValidateSecurityProfileBehaviorsResponse": { "type": "structure", "members": { "valid": { "target": "com.amazonaws.iot#Valid", "traits": { "smithy.api#documentation": "

True if the behaviors were valid.

" } }, "validationErrors": { "target": "com.amazonaws.iot#ValidationErrors", "traits": { "smithy.api#documentation": "

The list of any errors found in the behaviors.

" } } } }, "com.amazonaws.iot#ValidationError": { "type": "structure", "members": { "errorMessage": { "target": "com.amazonaws.iot#ErrorMessage", "traits": { "smithy.api#documentation": "

The description of an error found in the behaviors.

" } } }, "traits": { "smithy.api#documentation": "

Information about an error found in a behavior specification.

" } }, "com.amazonaws.iot#ValidationErrors": { "type": "list", "member": { "target": "com.amazonaws.iot#ValidationError" } }, "com.amazonaws.iot#Value": { "type": "string" }, "com.amazonaws.iot#Variance": { "type": "double" }, "com.amazonaws.iot#Version": { "type": "long" }, "com.amazonaws.iot#VersionConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

An exception thrown when the version of an entity specified with the\n expectedVersion parameter does not match the latest version in the\n system.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iot#VersionNumber": { "type": "long" }, "com.amazonaws.iot#VersionsLimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2", "traits": { "smithy.api#documentation": "

The message for the exception.

" } } }, "traits": { "smithy.api#documentation": "

The number of policy versions exceeds the limit.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.iot#ViolationEvent": { "type": "structure", "members": { "violationId": { "target": "com.amazonaws.iot#ViolationId", "traits": { "smithy.api#documentation": "

The ID of the violation event.

" } }, "thingName": { "target": "com.amazonaws.iot#DeviceDefenderThingName", "traits": { "smithy.api#documentation": "

The name of the thing responsible for the violation event.

" } }, "securityProfileName": { "target": "com.amazonaws.iot#SecurityProfileName", "traits": { "smithy.api#documentation": "

The name of the security profile whose behavior was violated.

" } }, "behavior": { "target": "com.amazonaws.iot#Behavior", "traits": { "smithy.api#documentation": "

The behavior that was violated.

" } }, "metricValue": { "target": "com.amazonaws.iot#MetricValue", "traits": { "smithy.api#documentation": "

The value of the metric (the measurement).

" } }, "violationEventAdditionalInfo": { "target": "com.amazonaws.iot#ViolationEventAdditionalInfo", "traits": { "smithy.api#documentation": "

\n The details of a violation event.\n

" } }, "violationEventType": { "target": "com.amazonaws.iot#ViolationEventType", "traits": { "smithy.api#documentation": "

The type of violation event.

" } }, "violationEventTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

The time the violation event occurred.

" } } }, "traits": { "smithy.api#documentation": "

Information about a Device Defender security profile behavior violation.

" } }, "com.amazonaws.iot#ViolationEventAdditionalInfo": { "type": "structure", "members": { "confidenceLevel": { "target": "com.amazonaws.iot#ConfidenceLevel", "traits": { "smithy.api#documentation": "

\n The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.\n

" } } }, "traits": { "smithy.api#documentation": "

\n The details of a violation event.\n

" } }, "com.amazonaws.iot#ViolationEventOccurrenceRange": { "type": "structure", "members": { "startTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The start date and time of a time period in which violation events occurred.\n

", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.iot#Timestamp", "traits": { "smithy.api#documentation": "

\n The end date and time of a time period in which violation events occurred.\n

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

\n Specifies the time period of which violation events occurred between.\n

" } }, "com.amazonaws.iot#ViolationEventType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "in-alarm", "name": "IN_ALARM" }, { "value": "alarm-cleared", "name": "ALARM_CLEARED" }, { "value": "alarm-invalidated", "name": "ALARM_INVALIDATED" } ] } }, "com.amazonaws.iot#ViolationEvents": { "type": "list", "member": { "target": "com.amazonaws.iot#ViolationEvent" } }, "com.amazonaws.iot#ViolationId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "[a-zA-Z0-9\\-]+" } }, "com.amazonaws.iot#VpcDestinationConfiguration": { "type": "structure", "members": { "subnetIds": { "target": "com.amazonaws.iot#SubnetIdList", "traits": { "smithy.api#documentation": "

The subnet IDs of the VPC destination.

", "smithy.api#required": {} } }, "securityGroups": { "target": "com.amazonaws.iot#SecurityGroupList", "traits": { "smithy.api#documentation": "

The security groups of the VPC destination.

" } }, "vpcId": { "target": "com.amazonaws.iot#VpcId", "traits": { "smithy.api#documentation": "

The ID of the VPC.

", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The configuration information for a virtual private cloud (VPC) destination.

" } }, "com.amazonaws.iot#VpcDestinationProperties": { "type": "structure", "members": { "subnetIds": { "target": "com.amazonaws.iot#SubnetIdList", "traits": { "smithy.api#documentation": "

The subnet IDs of the VPC destination.

" } }, "securityGroups": { "target": "com.amazonaws.iot#SecurityGroupList", "traits": { "smithy.api#documentation": "

The security groups of the VPC destination.

" } }, "vpcId": { "target": "com.amazonaws.iot#VpcId", "traits": { "smithy.api#documentation": "

The ID of the VPC.

" } }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

" } } }, "traits": { "smithy.api#documentation": "

The properties of a virtual private cloud (VPC) destination.

" } }, "com.amazonaws.iot#VpcDestinationSummary": { "type": "structure", "members": { "subnetIds": { "target": "com.amazonaws.iot#SubnetIdList", "traits": { "smithy.api#documentation": "

The subnet IDs of the VPC destination.

" } }, "securityGroups": { "target": "com.amazonaws.iot#SecurityGroupList", "traits": { "smithy.api#documentation": "

The security groups of the VPC destination.

" } }, "vpcId": { "target": "com.amazonaws.iot#VpcId", "traits": { "smithy.api#documentation": "

The ID of the VPC.

" } }, "roleArn": { "target": "com.amazonaws.iot#AwsArn", "traits": { "smithy.api#documentation": "

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

" } } }, "traits": { "smithy.api#documentation": "

The summary of a virtual private cloud (VPC) destination.

" } }, "com.amazonaws.iot#VpcId": { "type": "string" }, "com.amazonaws.iot#WaitingForDataCollectionChecksCount": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.iot#resourceId": { "type": "string" }, "com.amazonaws.iot#stringValue": { "type": "string" }, "com.amazonaws.iot#usePrefixAttributeValue": { "type": "boolean" } } }