@aws-sdk/client-iot 3.325.0 → 3.326.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/AcceptCertificateTransferCommand.d.ts +4 -0
- package/dist-types/commands/AddThingToBillingGroupCommand.d.ts +4 -0
- package/dist-types/commands/AddThingToThingGroupCommand.d.ts +4 -0
- package/dist-types/commands/AssociateTargetsWithJobCommand.d.ts +8 -0
- package/dist-types/commands/AttachPolicyCommand.d.ts +4 -0
- package/dist-types/commands/AttachPrincipalPolicyCommand.d.ts +4 -0
- package/dist-types/commands/AttachSecurityProfileCommand.d.ts +4 -0
- package/dist-types/commands/AttachThingPrincipalCommand.d.ts +4 -0
- package/dist-types/commands/CancelAuditMitigationActionsTaskCommand.d.ts +4 -0
- package/dist-types/commands/CancelAuditTaskCommand.d.ts +4 -0
- package/dist-types/commands/CancelCertificateTransferCommand.d.ts +4 -0
- package/dist-types/commands/CancelDetectMitigationActionsTaskCommand.d.ts +4 -0
- package/dist-types/commands/CancelJobCommand.d.ts +8 -0
- package/dist-types/commands/CancelJobExecutionCommand.d.ts +4 -0
- package/dist-types/commands/ClearDefaultAuthorizerCommand.d.ts +4 -0
- package/dist-types/commands/ConfirmTopicRuleDestinationCommand.d.ts +4 -0
- package/dist-types/commands/CreateAuditSuppressionCommand.d.ts +4 -0
- package/dist-types/commands/CreateAuthorizerCommand.d.ts +7 -0
- package/dist-types/commands/CreateBillingGroupCommand.d.ts +8 -0
- package/dist-types/commands/CreateCertificateFromCsrCommand.d.ts +8 -0
- package/dist-types/commands/CreateCustomMetricCommand.d.ts +7 -0
- package/dist-types/commands/CreateDimensionCommand.d.ts +7 -0
- package/dist-types/commands/CreateDomainConfigurationCommand.d.ts +7 -0
- package/dist-types/commands/CreateDynamicThingGroupCommand.d.ts +11 -0
- package/dist-types/commands/CreateFleetMetricCommand.d.ts +7 -0
- package/dist-types/commands/CreateJobCommand.d.ts +8 -0
- package/dist-types/commands/CreateJobTemplateCommand.d.ts +7 -0
- package/dist-types/commands/CreateKeysAndCertificateCommand.d.ts +12 -0
- package/dist-types/commands/CreateMitigationActionCommand.d.ts +7 -0
- package/dist-types/commands/CreateOTAUpdateCommand.d.ts +10 -0
- package/dist-types/commands/CreatePolicyCommand.d.ts +9 -0
- package/dist-types/commands/CreatePolicyVersionCommand.d.ts +9 -0
- package/dist-types/commands/CreateProvisioningClaimCommand.d.ts +12 -0
- package/dist-types/commands/CreateProvisioningTemplateCommand.d.ts +8 -0
- package/dist-types/commands/CreateProvisioningTemplateVersionCommand.d.ts +9 -0
- package/dist-types/commands/CreateRoleAliasCommand.d.ts +7 -0
- package/dist-types/commands/CreateScheduledAuditCommand.d.ts +6 -0
- package/dist-types/commands/CreateSecurityProfileCommand.d.ts +7 -0
- package/dist-types/commands/CreateStreamCommand.d.ts +9 -0
- package/dist-types/commands/CreateThingCommand.d.ts +8 -0
- package/dist-types/commands/CreateThingGroupCommand.d.ts +8 -0
- package/dist-types/commands/CreateThingTypeCommand.d.ts +8 -0
- package/dist-types/commands/CreateTopicRuleCommand.d.ts +4 -0
- package/dist-types/commands/CreateTopicRuleDestinationCommand.d.ts +25 -0
- package/dist-types/commands/DeleteAccountAuditConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteAuditSuppressionCommand.d.ts +4 -0
- package/dist-types/commands/DeleteAuthorizerCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBillingGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteCACertificateCommand.d.ts +4 -0
- package/dist-types/commands/DeleteCertificateCommand.d.ts +4 -0
- package/dist-types/commands/DeleteCustomMetricCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDimensionCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDomainConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDynamicThingGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteFleetMetricCommand.d.ts +4 -0
- package/dist-types/commands/DeleteJobCommand.d.ts +4 -0
- package/dist-types/commands/DeleteJobExecutionCommand.d.ts +4 -0
- package/dist-types/commands/DeleteJobTemplateCommand.d.ts +4 -0
- package/dist-types/commands/DeleteMitigationActionCommand.d.ts +4 -0
- package/dist-types/commands/DeleteOTAUpdateCommand.d.ts +4 -0
- package/dist-types/commands/DeletePolicyCommand.d.ts +4 -0
- package/dist-types/commands/DeletePolicyVersionCommand.d.ts +4 -0
- package/dist-types/commands/DeleteProvisioningTemplateCommand.d.ts +4 -0
- package/dist-types/commands/DeleteProvisioningTemplateVersionCommand.d.ts +4 -0
- package/dist-types/commands/DeleteRegistrationCodeCommand.d.ts +4 -0
- package/dist-types/commands/DeleteRoleAliasCommand.d.ts +4 -0
- package/dist-types/commands/DeleteScheduledAuditCommand.d.ts +4 -0
- package/dist-types/commands/DeleteSecurityProfileCommand.d.ts +4 -0
- package/dist-types/commands/DeleteStreamCommand.d.ts +4 -0
- package/dist-types/commands/DeleteThingCommand.d.ts +4 -0
- package/dist-types/commands/DeleteThingGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteThingTypeCommand.d.ts +4 -0
- package/dist-types/commands/DeleteTopicRuleCommand.d.ts +4 -0
- package/dist-types/commands/DeleteTopicRuleDestinationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteV2LoggingLevelCommand.d.ts +4 -0
- package/dist-types/commands/DeprecateThingTypeCommand.d.ts +4 -0
- package/dist-types/commands/DescribeAccountAuditConfigurationCommand.d.ts +18 -0
- package/dist-types/commands/DescribeAuditFindingCommand.d.ts +68 -0
- package/dist-types/commands/DescribeAuditMitigationActionsTaskCommand.d.ts +64 -0
- package/dist-types/commands/DescribeAuditSuppressionCommand.d.ts +28 -0
- package/dist-types/commands/DescribeAuditTaskCommand.d.ts +29 -0
- package/dist-types/commands/DescribeAuthorizerCommand.d.ts +19 -0
- package/dist-types/commands/DescribeBillingGroupCommand.d.ts +15 -0
- package/dist-types/commands/DescribeCACertificateCommand.d.ts +27 -0
- package/dist-types/commands/DescribeCertificateCommand.d.ts +30 -0
- package/dist-types/commands/DescribeCustomMetricCommand.d.ts +11 -0
- package/dist-types/commands/DescribeDefaultAuthorizerCommand.d.ts +19 -0
- package/dist-types/commands/DescribeDetectMitigationActionsTaskCommand.d.ts +60 -0
- package/dist-types/commands/DescribeDimensionCommand.d.ts +13 -0
- package/dist-types/commands/DescribeDomainConfigurationCommand.d.ts +26 -0
- package/dist-types/commands/DescribeEndpointCommand.d.ts +6 -0
- package/dist-types/commands/DescribeEventConfigurationsCommand.d.ts +12 -0
- package/dist-types/commands/DescribeFleetMetricCommand.d.ts +23 -0
- package/dist-types/commands/DescribeIndexCommand.d.ts +8 -0
- package/dist-types/commands/DescribeJobCommand.d.ts +93 -0
- package/dist-types/commands/DescribeJobExecutionCommand.d.ts +22 -0
- package/dist-types/commands/DescribeJobTemplateCommand.d.ts +53 -0
- package/dist-types/commands/DescribeManagedJobTemplateCommand.d.ts +22 -0
- package/dist-types/commands/DescribeMitigationActionCommand.d.ts +36 -0
- package/dist-types/commands/DescribeProvisioningTemplateCommand.d.ts +19 -0
- package/dist-types/commands/DescribeProvisioningTemplateVersionCommand.d.ts +9 -0
- package/dist-types/commands/DescribeRoleAliasCommand.d.ts +14 -0
- package/dist-types/commands/DescribeScheduledAuditCommand.d.ts +13 -0
- package/dist-types/commands/DescribeSecurityProfileCommand.d.ts +68 -0
- package/dist-types/commands/DescribeStreamCommand.d.ts +24 -0
- package/dist-types/commands/DescribeThingCommand.d.ts +15 -0
- package/dist-types/commands/DescribeThingGroupCommand.d.ts +32 -0
- package/dist-types/commands/DescribeThingRegistrationTaskCommand.d.ts +17 -0
- package/dist-types/commands/DescribeThingTypeCommand.d.ts +19 -0
- package/dist-types/commands/DetachPolicyCommand.d.ts +4 -0
- package/dist-types/commands/DetachPrincipalPolicyCommand.d.ts +4 -0
- package/dist-types/commands/DetachSecurityProfileCommand.d.ts +4 -0
- package/dist-types/commands/DetachThingPrincipalCommand.d.ts +4 -0
- package/dist-types/commands/DisableTopicRuleCommand.d.ts +4 -0
- package/dist-types/commands/EnableTopicRuleCommand.d.ts +4 -0
- package/dist-types/commands/GetBehaviorModelTrainingSummariesCommand.d.ts +16 -0
- package/dist-types/commands/GetBucketsAggregationCommand.d.ts +12 -0
- package/dist-types/commands/GetCardinalityCommand.d.ts +6 -0
- package/dist-types/commands/GetEffectivePoliciesCommand.d.ts +12 -0
- package/dist-types/commands/GetIndexingConfigurationCommand.d.ts +43 -0
- package/dist-types/commands/GetJobDocumentCommand.d.ts +6 -0
- package/dist-types/commands/GetLoggingOptionsCommand.d.ts +7 -0
- package/dist-types/commands/GetOTAUpdateCommand.d.ts +92 -0
- package/dist-types/commands/GetPercentilesCommand.d.ts +11 -0
- package/dist-types/commands/GetPolicyCommand.d.ts +12 -0
- package/dist-types/commands/GetPolicyVersionCommand.d.ts +13 -0
- package/dist-types/commands/GetRegistrationCodeCommand.d.ts +6 -0
- package/dist-types/commands/GetStatisticsCommand.d.ts +15 -0
- package/dist-types/commands/GetTopicRuleCommand.d.ts +416 -0
- package/dist-types/commands/GetTopicRuleDestinationCommand.d.ts +25 -0
- package/dist-types/commands/GetV2LoggingOptionsCommand.d.ts +8 -0
- package/dist-types/commands/ListActiveViolationsCommand.d.ts +73 -0
- package/dist-types/commands/ListAttachedPoliciesCommand.d.ts +12 -0
- package/dist-types/commands/ListAuditFindingsCommand.d.ts +71 -0
- package/dist-types/commands/ListAuditMitigationActionsExecutionsCommand.d.ts +19 -0
- package/dist-types/commands/ListAuditMitigationActionsTasksCommand.d.ts +13 -0
- package/dist-types/commands/ListAuditSuppressionsCommand.d.ts +33 -0
- package/dist-types/commands/ListAuditTasksCommand.d.ts +13 -0
- package/dist-types/commands/ListAuthorizersCommand.d.ts +12 -0
- package/dist-types/commands/ListBillingGroupsCommand.d.ts +12 -0
- package/dist-types/commands/ListCACertificatesCommand.d.ts +14 -0
- package/dist-types/commands/ListCertificatesByCACommand.d.ts +15 -0
- package/dist-types/commands/ListCertificatesCommand.d.ts +15 -0
- package/dist-types/commands/ListCustomMetricsCommand.d.ts +9 -0
- package/dist-types/commands/ListDetectMitigationActionsExecutionsCommand.d.ts +19 -0
- package/dist-types/commands/ListDetectMitigationActionsTasksCommand.d.ts +63 -0
- package/dist-types/commands/ListDimensionsCommand.d.ts +9 -0
- package/dist-types/commands/ListDomainConfigurationsCommand.d.ts +13 -0
- package/dist-types/commands/ListFleetMetricsCommand.d.ts +12 -0
- package/dist-types/commands/ListIndicesCommand.d.ts +9 -0
- package/dist-types/commands/ListJobExecutionsForJobCommand.d.ts +19 -0
- package/dist-types/commands/ListJobExecutionsForThingCommand.d.ts +19 -0
- package/dist-types/commands/ListJobTemplatesCommand.d.ts +14 -0
- package/dist-types/commands/ListJobsCommand.d.ts +19 -0
- package/dist-types/commands/ListManagedJobTemplatesCommand.d.ts +17 -0
- package/dist-types/commands/ListMetricValuesCommand.d.ts +27 -0
- package/dist-types/commands/ListMitigationActionsCommand.d.ts +13 -0
- package/dist-types/commands/ListOTAUpdatesCommand.d.ts +13 -0
- package/dist-types/commands/ListOutgoingCertificatesCommand.d.ts +16 -0
- package/dist-types/commands/ListPoliciesCommand.d.ts +12 -0
- package/dist-types/commands/ListPolicyPrincipalsCommand.d.ts +9 -0
- package/dist-types/commands/ListPolicyVersionsCommand.d.ts +12 -0
- package/dist-types/commands/ListPrincipalPoliciesCommand.d.ts +12 -0
- package/dist-types/commands/ListPrincipalThingsCommand.d.ts +9 -0
- package/dist-types/commands/ListProvisioningTemplateVersionsCommand.d.ts +13 -0
- package/dist-types/commands/ListProvisioningTemplatesCommand.d.ts +17 -0
- package/dist-types/commands/ListRelatedResourcesForAuditFindingCommand.d.ts +33 -0
- package/dist-types/commands/ListRoleAliasesCommand.d.ts +9 -0
- package/dist-types/commands/ListScheduledAuditsCommand.d.ts +15 -0
- package/dist-types/commands/ListSecurityProfilesCommand.d.ts +12 -0
- package/dist-types/commands/ListSecurityProfilesForTargetCommand.d.ts +17 -0
- package/dist-types/commands/ListStreamsCommand.d.ts +14 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +12 -0
- package/dist-types/commands/ListTargetsForPolicyCommand.d.ts +9 -0
- package/dist-types/commands/ListTargetsForSecurityProfileCommand.d.ts +11 -0
- package/dist-types/commands/ListThingGroupsCommand.d.ts +12 -0
- package/dist-types/commands/ListThingGroupsForThingCommand.d.ts +12 -0
- package/dist-types/commands/ListThingPrincipalsCommand.d.ts +9 -0
- package/dist-types/commands/ListThingRegistrationTaskReportsCommand.d.ts +10 -0
- package/dist-types/commands/ListThingRegistrationTasksCommand.d.ts +9 -0
- package/dist-types/commands/ListThingTypesCommand.d.ts +23 -0
- package/dist-types/commands/ListThingsCommand.d.ts +17 -0
- package/dist-types/commands/ListThingsInBillingGroupCommand.d.ts +9 -0
- package/dist-types/commands/ListThingsInThingGroupCommand.d.ts +9 -0
- package/dist-types/commands/ListTopicRuleDestinationsCommand.d.ts +28 -0
- package/dist-types/commands/ListTopicRulesCommand.d.ts +15 -0
- package/dist-types/commands/ListV2LoggingLevelsCommand.d.ts +15 -0
- package/dist-types/commands/ListViolationEventsCommand.d.ts +73 -0
- package/dist-types/commands/PutVerificationStateOnViolationCommand.d.ts +4 -0
- package/dist-types/commands/RegisterCACertificateCommand.d.ts +7 -0
- package/dist-types/commands/RegisterCertificateCommand.d.ts +7 -0
- package/dist-types/commands/RegisterCertificateWithoutCACommand.d.ts +7 -0
- package/dist-types/commands/RegisterThingCommand.d.ts +9 -0
- package/dist-types/commands/RejectCertificateTransferCommand.d.ts +4 -0
- package/dist-types/commands/RemoveThingFromBillingGroupCommand.d.ts +4 -0
- package/dist-types/commands/RemoveThingFromThingGroupCommand.d.ts +4 -0
- package/dist-types/commands/ReplaceTopicRuleCommand.d.ts +4 -0
- package/dist-types/commands/SearchIndexCommand.d.ts +39 -0
- package/dist-types/commands/SetDefaultAuthorizerCommand.d.ts +7 -0
- package/dist-types/commands/SetDefaultPolicyVersionCommand.d.ts +4 -0
- package/dist-types/commands/SetLoggingOptionsCommand.d.ts +4 -0
- package/dist-types/commands/SetV2LoggingLevelCommand.d.ts +4 -0
- package/dist-types/commands/SetV2LoggingOptionsCommand.d.ts +4 -0
- package/dist-types/commands/StartAuditMitigationActionsTaskCommand.d.ts +6 -0
- package/dist-types/commands/StartDetectMitigationActionsTaskCommand.d.ts +6 -0
- package/dist-types/commands/StartOnDemandAuditTaskCommand.d.ts +6 -0
- package/dist-types/commands/StartThingRegistrationTaskCommand.d.ts +6 -0
- package/dist-types/commands/StopThingRegistrationTaskCommand.d.ts +4 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/TestAuthorizationCommand.d.ts +45 -0
- package/dist-types/commands/TestInvokeAuthorizerCommand.d.ts +12 -0
- package/dist-types/commands/TransferCertificateCommand.d.ts +6 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateAccountAuditConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/UpdateAuditSuppressionCommand.d.ts +4 -0
- package/dist-types/commands/UpdateAuthorizerCommand.d.ts +7 -0
- package/dist-types/commands/UpdateBillingGroupCommand.d.ts +6 -0
- package/dist-types/commands/UpdateCACertificateCommand.d.ts +4 -0
- package/dist-types/commands/UpdateCertificateCommand.d.ts +4 -0
- package/dist-types/commands/UpdateCustomMetricCommand.d.ts +11 -0
- package/dist-types/commands/UpdateDimensionCommand.d.ts +13 -0
- package/dist-types/commands/UpdateDomainConfigurationCommand.d.ts +7 -0
- package/dist-types/commands/UpdateDynamicThingGroupCommand.d.ts +6 -0
- package/dist-types/commands/UpdateEventConfigurationsCommand.d.ts +4 -0
- package/dist-types/commands/UpdateFleetMetricCommand.d.ts +4 -0
- package/dist-types/commands/UpdateIndexingConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/UpdateJobCommand.d.ts +4 -0
- package/dist-types/commands/UpdateMitigationActionCommand.d.ts +7 -0
- package/dist-types/commands/UpdateProvisioningTemplateCommand.d.ts +4 -0
- package/dist-types/commands/UpdateRoleAliasCommand.d.ts +7 -0
- package/dist-types/commands/UpdateScheduledAuditCommand.d.ts +6 -0
- package/dist-types/commands/UpdateSecurityProfileCommand.d.ts +68 -0
- package/dist-types/commands/UpdateStreamCommand.d.ts +9 -0
- package/dist-types/commands/UpdateThingCommand.d.ts +4 -0
- package/dist-types/commands/UpdateThingGroupCommand.d.ts +6 -0
- package/dist-types/commands/UpdateThingGroupsForThingCommand.d.ts +4 -0
- package/dist-types/commands/UpdateTopicRuleDestinationCommand.d.ts +4 -0
- package/dist-types/commands/ValidateSecurityProfileBehaviorsCommand.d.ts +11 -0
- package/package.json +3 -3
|
@@ -32,6 +32,34 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeCertificateCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeCertificateResponse
|
|
36
|
+
* // certificateDescription: { // CertificateDescription
|
|
37
|
+
* // certificateArn: "STRING_VALUE",
|
|
38
|
+
* // certificateId: "STRING_VALUE",
|
|
39
|
+
* // caCertificateId: "STRING_VALUE",
|
|
40
|
+
* // status: "ACTIVE" || "INACTIVE" || "REVOKED" || "PENDING_TRANSFER" || "REGISTER_INACTIVE" || "PENDING_ACTIVATION",
|
|
41
|
+
* // certificatePem: "STRING_VALUE",
|
|
42
|
+
* // ownedBy: "STRING_VALUE",
|
|
43
|
+
* // previousOwnedBy: "STRING_VALUE",
|
|
44
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
45
|
+
* // lastModifiedDate: new Date("TIMESTAMP"),
|
|
46
|
+
* // customerVersion: Number("int"),
|
|
47
|
+
* // transferData: { // TransferData
|
|
48
|
+
* // transferMessage: "STRING_VALUE",
|
|
49
|
+
* // rejectReason: "STRING_VALUE",
|
|
50
|
+
* // transferDate: new Date("TIMESTAMP"),
|
|
51
|
+
* // acceptDate: new Date("TIMESTAMP"),
|
|
52
|
+
* // rejectDate: new Date("TIMESTAMP"),
|
|
53
|
+
* // },
|
|
54
|
+
* // generationId: "STRING_VALUE",
|
|
55
|
+
* // validity: { // CertificateValidity
|
|
56
|
+
* // notBefore: new Date("TIMESTAMP"),
|
|
57
|
+
* // notAfter: new Date("TIMESTAMP"),
|
|
58
|
+
* // },
|
|
59
|
+
* // certificateMode: "DEFAULT" || "SNI_ONLY",
|
|
60
|
+
* // },
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
35
63
|
* ```
|
|
36
64
|
*
|
|
37
65
|
* @param DescribeCertificateCommandInput - {@link DescribeCertificateCommandInput}
|
|
@@ -58,6 +86,8 @@ export interface DescribeCertificateCommandOutput extends DescribeCertificateRes
|
|
|
58
86
|
* @throws {@link UnauthorizedException} (client fault)
|
|
59
87
|
* <p>You are not authorized to perform this operation.</p>
|
|
60
88
|
*
|
|
89
|
+
* @throws {@link IoTServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
61
91
|
*
|
|
62
92
|
*/
|
|
63
93
|
export declare class DescribeCertificateCommand extends $Command<DescribeCertificateCommandInput, DescribeCertificateCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -34,6 +34,15 @@ export interface DescribeCustomMetricCommandOutput extends DescribeCustomMetricR
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DescribeCustomMetricCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // DescribeCustomMetricResponse
|
|
38
|
+
* // metricName: "STRING_VALUE",
|
|
39
|
+
* // metricArn: "STRING_VALUE",
|
|
40
|
+
* // metricType: "string-list" || "ip-address-list" || "number-list" || "number",
|
|
41
|
+
* // displayName: "STRING_VALUE",
|
|
42
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
43
|
+
* // lastModifiedDate: new Date("TIMESTAMP"),
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
37
46
|
* ```
|
|
38
47
|
*
|
|
39
48
|
* @param DescribeCustomMetricCommandInput - {@link DescribeCustomMetricCommandInput}
|
|
@@ -54,6 +63,8 @@ export interface DescribeCustomMetricCommandOutput extends DescribeCustomMetricR
|
|
|
54
63
|
* @throws {@link ThrottlingException} (client fault)
|
|
55
64
|
* <p>The rate exceeds the limit.</p>
|
|
56
65
|
*
|
|
66
|
+
* @throws {@link IoTServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
57
68
|
*
|
|
58
69
|
*/
|
|
59
70
|
export declare class DescribeCustomMetricCommand extends $Command<DescribeCustomMetricCommandInput, DescribeCustomMetricCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -30,6 +30,23 @@ export interface DescribeDefaultAuthorizerCommandOutput extends DescribeDefaultA
|
|
|
30
30
|
* const input = {};
|
|
31
31
|
* const command = new DescribeDefaultAuthorizerCommand(input);
|
|
32
32
|
* const response = await client.send(command);
|
|
33
|
+
* // { // DescribeDefaultAuthorizerResponse
|
|
34
|
+
* // authorizerDescription: { // AuthorizerDescription
|
|
35
|
+
* // authorizerName: "STRING_VALUE",
|
|
36
|
+
* // authorizerArn: "STRING_VALUE",
|
|
37
|
+
* // authorizerFunctionArn: "STRING_VALUE",
|
|
38
|
+
* // tokenKeyName: "STRING_VALUE",
|
|
39
|
+
* // tokenSigningPublicKeys: { // PublicKeyMap
|
|
40
|
+
* // "<keys>": "STRING_VALUE",
|
|
41
|
+
* // },
|
|
42
|
+
* // status: "ACTIVE" || "INACTIVE",
|
|
43
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
44
|
+
* // lastModifiedDate: new Date("TIMESTAMP"),
|
|
45
|
+
* // signingDisabled: true || false,
|
|
46
|
+
* // enableCachingForHttp: true || false,
|
|
47
|
+
* // },
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
33
50
|
* ```
|
|
34
51
|
*
|
|
35
52
|
* @param DescribeDefaultAuthorizerCommandInput - {@link DescribeDefaultAuthorizerCommandInput}
|
|
@@ -56,6 +73,8 @@ export interface DescribeDefaultAuthorizerCommandOutput extends DescribeDefaultA
|
|
|
56
73
|
* @throws {@link UnauthorizedException} (client fault)
|
|
57
74
|
* <p>You are not authorized to perform this operation.</p>
|
|
58
75
|
*
|
|
76
|
+
* @throws {@link IoTServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
59
78
|
*
|
|
60
79
|
*/
|
|
61
80
|
export declare class DescribeDefaultAuthorizerCommand extends $Command<DescribeDefaultAuthorizerCommandInput, DescribeDefaultAuthorizerCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -34,6 +34,64 @@ export interface DescribeDetectMitigationActionsTaskCommandOutput extends Descri
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DescribeDetectMitigationActionsTaskCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // DescribeDetectMitigationActionsTaskResponse
|
|
38
|
+
* // taskSummary: { // DetectMitigationActionsTaskSummary
|
|
39
|
+
* // taskId: "STRING_VALUE",
|
|
40
|
+
* // taskStatus: "IN_PROGRESS" || "SUCCESSFUL" || "FAILED" || "CANCELED",
|
|
41
|
+
* // taskStartTime: new Date("TIMESTAMP"),
|
|
42
|
+
* // taskEndTime: new Date("TIMESTAMP"),
|
|
43
|
+
* // target: { // DetectMitigationActionsTaskTarget
|
|
44
|
+
* // violationIds: [ // TargetViolationIdsForDetectMitigationActions
|
|
45
|
+
* // "STRING_VALUE",
|
|
46
|
+
* // ],
|
|
47
|
+
* // securityProfileName: "STRING_VALUE",
|
|
48
|
+
* // behaviorName: "STRING_VALUE",
|
|
49
|
+
* // },
|
|
50
|
+
* // violationEventOccurrenceRange: { // ViolationEventOccurrenceRange
|
|
51
|
+
* // startTime: new Date("TIMESTAMP"), // required
|
|
52
|
+
* // endTime: new Date("TIMESTAMP"), // required
|
|
53
|
+
* // },
|
|
54
|
+
* // onlyActiveViolationsIncluded: true || false,
|
|
55
|
+
* // suppressedAlertsIncluded: true || false,
|
|
56
|
+
* // actionsDefinition: [ // MitigationActionList
|
|
57
|
+
* // { // MitigationAction
|
|
58
|
+
* // name: "STRING_VALUE",
|
|
59
|
+
* // id: "STRING_VALUE",
|
|
60
|
+
* // roleArn: "STRING_VALUE",
|
|
61
|
+
* // actionParams: { // MitigationActionParams
|
|
62
|
+
* // updateDeviceCertificateParams: { // UpdateDeviceCertificateParams
|
|
63
|
+
* // action: "DEACTIVATE", // required
|
|
64
|
+
* // },
|
|
65
|
+
* // updateCACertificateParams: { // UpdateCACertificateParams
|
|
66
|
+
* // action: "DEACTIVATE", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // addThingsToThingGroupParams: { // AddThingsToThingGroupParams
|
|
69
|
+
* // thingGroupNames: [ // ThingGroupNames // required
|
|
70
|
+
* // "STRING_VALUE",
|
|
71
|
+
* // ],
|
|
72
|
+
* // overrideDynamicGroups: true || false,
|
|
73
|
+
* // },
|
|
74
|
+
* // replaceDefaultPolicyVersionParams: { // ReplaceDefaultPolicyVersionParams
|
|
75
|
+
* // templateName: "BLANK_POLICY", // required
|
|
76
|
+
* // },
|
|
77
|
+
* // enableIoTLoggingParams: { // EnableIoTLoggingParams
|
|
78
|
+
* // roleArnForLogging: "STRING_VALUE", // required
|
|
79
|
+
* // logLevel: "DEBUG" || "INFO" || "ERROR" || "WARN" || "DISABLED", // required
|
|
80
|
+
* // },
|
|
81
|
+
* // publishFindingToSnsParams: { // PublishFindingToSnsParams
|
|
82
|
+
* // topicArn: "STRING_VALUE", // required
|
|
83
|
+
* // },
|
|
84
|
+
* // },
|
|
85
|
+
* // },
|
|
86
|
+
* // ],
|
|
87
|
+
* // taskStatistics: { // DetectMitigationActionsTaskStatistics
|
|
88
|
+
* // actionsExecuted: Number("long"),
|
|
89
|
+
* // actionsSkipped: Number("long"),
|
|
90
|
+
* // actionsFailed: Number("long"),
|
|
91
|
+
* // },
|
|
92
|
+
* // },
|
|
93
|
+
* // };
|
|
94
|
+
*
|
|
37
95
|
* ```
|
|
38
96
|
*
|
|
39
97
|
* @param DescribeDetectMitigationActionsTaskCommandInput - {@link DescribeDetectMitigationActionsTaskCommandInput}
|
|
@@ -54,6 +112,8 @@ export interface DescribeDetectMitigationActionsTaskCommandOutput extends Descri
|
|
|
54
112
|
* @throws {@link ThrottlingException} (client fault)
|
|
55
113
|
* <p>The rate exceeds the limit.</p>
|
|
56
114
|
*
|
|
115
|
+
* @throws {@link IoTServiceException}
|
|
116
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
57
117
|
*
|
|
58
118
|
*/
|
|
59
119
|
export declare class DescribeDetectMitigationActionsTaskCommand extends $Command<DescribeDetectMitigationActionsTaskCommandInput, DescribeDetectMitigationActionsTaskCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -32,6 +32,17 @@ export interface DescribeDimensionCommandOutput extends DescribeDimensionRespons
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeDimensionCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeDimensionResponse
|
|
36
|
+
* // name: "STRING_VALUE",
|
|
37
|
+
* // arn: "STRING_VALUE",
|
|
38
|
+
* // type: "TOPIC_FILTER",
|
|
39
|
+
* // stringValues: [ // DimensionStringValues
|
|
40
|
+
* // "STRING_VALUE",
|
|
41
|
+
* // ],
|
|
42
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
43
|
+
* // lastModifiedDate: new Date("TIMESTAMP"),
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
35
46
|
* ```
|
|
36
47
|
*
|
|
37
48
|
* @param DescribeDimensionCommandInput - {@link DescribeDimensionCommandInput}
|
|
@@ -52,6 +63,8 @@ export interface DescribeDimensionCommandOutput extends DescribeDimensionRespons
|
|
|
52
63
|
* @throws {@link ThrottlingException} (client fault)
|
|
53
64
|
* <p>The rate exceeds the limit.</p>
|
|
54
65
|
*
|
|
66
|
+
* @throws {@link IoTServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
55
68
|
*
|
|
56
69
|
*/
|
|
57
70
|
export declare class DescribeDimensionCommand extends $Command<DescribeDimensionCommandInput, DescribeDimensionCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -32,6 +32,30 @@ export interface DescribeDomainConfigurationCommandOutput extends DescribeDomain
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeDomainConfigurationCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeDomainConfigurationResponse
|
|
36
|
+
* // domainConfigurationName: "STRING_VALUE",
|
|
37
|
+
* // domainConfigurationArn: "STRING_VALUE",
|
|
38
|
+
* // domainName: "STRING_VALUE",
|
|
39
|
+
* // serverCertificates: [ // ServerCertificates
|
|
40
|
+
* // { // ServerCertificateSummary
|
|
41
|
+
* // serverCertificateArn: "STRING_VALUE",
|
|
42
|
+
* // serverCertificateStatus: "INVALID" || "VALID",
|
|
43
|
+
* // serverCertificateStatusDetail: "STRING_VALUE",
|
|
44
|
+
* // },
|
|
45
|
+
* // ],
|
|
46
|
+
* // authorizerConfig: { // AuthorizerConfig
|
|
47
|
+
* // defaultAuthorizerName: "STRING_VALUE",
|
|
48
|
+
* // allowAuthorizerOverride: true || false,
|
|
49
|
+
* // },
|
|
50
|
+
* // domainConfigurationStatus: "ENABLED" || "DISABLED",
|
|
51
|
+
* // serviceType: "DATA" || "CREDENTIAL_PROVIDER" || "JOBS",
|
|
52
|
+
* // domainType: "ENDPOINT" || "AWS_MANAGED" || "CUSTOMER_MANAGED",
|
|
53
|
+
* // lastStatusChangeDate: new Date("TIMESTAMP"),
|
|
54
|
+
* // tlsConfig: { // TlsConfig
|
|
55
|
+
* // securityPolicy: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
35
59
|
* ```
|
|
36
60
|
*
|
|
37
61
|
* @param DescribeDomainConfigurationCommandInput - {@link DescribeDomainConfigurationCommandInput}
|
|
@@ -58,6 +82,8 @@ export interface DescribeDomainConfigurationCommandOutput extends DescribeDomain
|
|
|
58
82
|
* @throws {@link UnauthorizedException} (client fault)
|
|
59
83
|
* <p>You are not authorized to perform this operation.</p>
|
|
60
84
|
*
|
|
85
|
+
* @throws {@link IoTServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
61
87
|
*
|
|
62
88
|
*/
|
|
63
89
|
export declare class DescribeDomainConfigurationCommand extends $Command<DescribeDomainConfigurationCommandInput, DescribeDomainConfigurationCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -32,6 +32,10 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse,
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeEndpointCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeEndpointResponse
|
|
36
|
+
* // endpointAddress: "STRING_VALUE",
|
|
37
|
+
* // };
|
|
38
|
+
*
|
|
35
39
|
* ```
|
|
36
40
|
*
|
|
37
41
|
* @param DescribeEndpointCommandInput - {@link DescribeEndpointCommandInput}
|
|
@@ -52,6 +56,8 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse,
|
|
|
52
56
|
* @throws {@link UnauthorizedException} (client fault)
|
|
53
57
|
* <p>You are not authorized to perform this operation.</p>
|
|
54
58
|
*
|
|
59
|
+
* @throws {@link IoTServiceException}
|
|
60
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
55
61
|
*
|
|
56
62
|
*/
|
|
57
63
|
export declare class DescribeEndpointCommand extends $Command<DescribeEndpointCommandInput, DescribeEndpointCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -30,6 +30,16 @@ export interface DescribeEventConfigurationsCommandOutput extends DescribeEventC
|
|
|
30
30
|
* const input = {};
|
|
31
31
|
* const command = new DescribeEventConfigurationsCommand(input);
|
|
32
32
|
* const response = await client.send(command);
|
|
33
|
+
* // { // DescribeEventConfigurationsResponse
|
|
34
|
+
* // eventConfigurations: { // EventConfigurations
|
|
35
|
+
* // "<keys>": { // Configuration
|
|
36
|
+
* // Enabled: true || false,
|
|
37
|
+
* // },
|
|
38
|
+
* // },
|
|
39
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
40
|
+
* // lastModifiedDate: new Date("TIMESTAMP"),
|
|
41
|
+
* // };
|
|
42
|
+
*
|
|
33
43
|
* ```
|
|
34
44
|
*
|
|
35
45
|
* @param DescribeEventConfigurationsCommandInput - {@link DescribeEventConfigurationsCommandInput}
|
|
@@ -44,6 +54,8 @@ export interface DescribeEventConfigurationsCommandOutput extends DescribeEventC
|
|
|
44
54
|
* @throws {@link ThrottlingException} (client fault)
|
|
45
55
|
* <p>The rate exceeds the limit.</p>
|
|
46
56
|
*
|
|
57
|
+
* @throws {@link IoTServiceException}
|
|
58
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
47
59
|
*
|
|
48
60
|
*/
|
|
49
61
|
export declare class DescribeEventConfigurationsCommand extends $Command<DescribeEventConfigurationsCommandInput, DescribeEventConfigurationsCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -32,6 +32,27 @@ export interface DescribeFleetMetricCommandOutput extends DescribeFleetMetricRes
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeFleetMetricCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeFleetMetricResponse
|
|
36
|
+
* // metricName: "STRING_VALUE",
|
|
37
|
+
* // queryString: "STRING_VALUE",
|
|
38
|
+
* // aggregationType: { // AggregationType
|
|
39
|
+
* // name: "Statistics" || "Percentiles" || "Cardinality", // required
|
|
40
|
+
* // values: [ // AggregationTypeValues
|
|
41
|
+
* // "STRING_VALUE",
|
|
42
|
+
* // ],
|
|
43
|
+
* // },
|
|
44
|
+
* // period: Number("int"),
|
|
45
|
+
* // aggregationField: "STRING_VALUE",
|
|
46
|
+
* // description: "STRING_VALUE",
|
|
47
|
+
* // queryVersion: "STRING_VALUE",
|
|
48
|
+
* // indexName: "STRING_VALUE",
|
|
49
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
50
|
+
* // lastModifiedDate: new Date("TIMESTAMP"),
|
|
51
|
+
* // unit: "Seconds" || "Microseconds" || "Milliseconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None",
|
|
52
|
+
* // version: Number("long"),
|
|
53
|
+
* // metricArn: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
35
56
|
* ```
|
|
36
57
|
*
|
|
37
58
|
* @param DescribeFleetMetricCommandInput - {@link DescribeFleetMetricCommandInput}
|
|
@@ -58,6 +79,8 @@ export interface DescribeFleetMetricCommandOutput extends DescribeFleetMetricRes
|
|
|
58
79
|
* @throws {@link UnauthorizedException} (client fault)
|
|
59
80
|
* <p>You are not authorized to perform this operation.</p>
|
|
60
81
|
*
|
|
82
|
+
* @throws {@link IoTServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
61
84
|
*
|
|
62
85
|
*/
|
|
63
86
|
export declare class DescribeFleetMetricCommand extends $Command<DescribeFleetMetricCommandInput, DescribeFleetMetricCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -32,6 +32,12 @@ export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __Met
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeIndexCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeIndexResponse
|
|
36
|
+
* // indexName: "STRING_VALUE",
|
|
37
|
+
* // indexStatus: "ACTIVE" || "BUILDING" || "REBUILDING",
|
|
38
|
+
* // schema: "STRING_VALUE",
|
|
39
|
+
* // };
|
|
40
|
+
*
|
|
35
41
|
* ```
|
|
36
42
|
*
|
|
37
43
|
* @param DescribeIndexCommandInput - {@link DescribeIndexCommandInput}
|
|
@@ -58,6 +64,8 @@ export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __Met
|
|
|
58
64
|
* @throws {@link UnauthorizedException} (client fault)
|
|
59
65
|
* <p>You are not authorized to perform this operation.</p>
|
|
60
66
|
*
|
|
67
|
+
* @throws {@link IoTServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
61
69
|
*
|
|
62
70
|
*/
|
|
63
71
|
export declare class DescribeIndexCommand extends $Command<DescribeIndexCommandInput, DescribeIndexCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -32,6 +32,97 @@ export interface DescribeJobCommandOutput extends DescribeJobResponse, __Metadat
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeJobCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeJobResponse
|
|
36
|
+
* // documentSource: "STRING_VALUE",
|
|
37
|
+
* // job: { // Job
|
|
38
|
+
* // jobArn: "STRING_VALUE",
|
|
39
|
+
* // jobId: "STRING_VALUE",
|
|
40
|
+
* // targetSelection: "CONTINUOUS" || "SNAPSHOT",
|
|
41
|
+
* // status: "IN_PROGRESS" || "CANCELED" || "COMPLETED" || "DELETION_IN_PROGRESS" || "SCHEDULED",
|
|
42
|
+
* // forceCanceled: true || false,
|
|
43
|
+
* // reasonCode: "STRING_VALUE",
|
|
44
|
+
* // comment: "STRING_VALUE",
|
|
45
|
+
* // targets: [ // JobTargets
|
|
46
|
+
* // "STRING_VALUE",
|
|
47
|
+
* // ],
|
|
48
|
+
* // description: "STRING_VALUE",
|
|
49
|
+
* // presignedUrlConfig: { // PresignedUrlConfig
|
|
50
|
+
* // roleArn: "STRING_VALUE",
|
|
51
|
+
* // expiresInSec: Number("long"),
|
|
52
|
+
* // },
|
|
53
|
+
* // jobExecutionsRolloutConfig: { // JobExecutionsRolloutConfig
|
|
54
|
+
* // maximumPerMinute: Number("int"),
|
|
55
|
+
* // exponentialRate: { // ExponentialRolloutRate
|
|
56
|
+
* // baseRatePerMinute: Number("int"), // required
|
|
57
|
+
* // incrementFactor: Number("double"), // required
|
|
58
|
+
* // rateIncreaseCriteria: { // RateIncreaseCriteria
|
|
59
|
+
* // numberOfNotifiedThings: Number("int"),
|
|
60
|
+
* // numberOfSucceededThings: Number("int"),
|
|
61
|
+
* // },
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // abortConfig: { // AbortConfig
|
|
65
|
+
* // criteriaList: [ // AbortCriteriaList // required
|
|
66
|
+
* // { // AbortCriteria
|
|
67
|
+
* // failureType: "FAILED" || "REJECTED" || "TIMED_OUT" || "ALL", // required
|
|
68
|
+
* // action: "CANCEL", // required
|
|
69
|
+
* // thresholdPercentage: Number("double"), // required
|
|
70
|
+
* // minNumberOfExecutedThings: Number("int"), // required
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // },
|
|
74
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
75
|
+
* // lastUpdatedAt: new Date("TIMESTAMP"),
|
|
76
|
+
* // completedAt: new Date("TIMESTAMP"),
|
|
77
|
+
* // jobProcessDetails: { // JobProcessDetails
|
|
78
|
+
* // processingTargets: [ // ProcessingTargetNameList
|
|
79
|
+
* // "STRING_VALUE",
|
|
80
|
+
* // ],
|
|
81
|
+
* // numberOfCanceledThings: Number("int"),
|
|
82
|
+
* // numberOfSucceededThings: Number("int"),
|
|
83
|
+
* // numberOfFailedThings: Number("int"),
|
|
84
|
+
* // numberOfRejectedThings: Number("int"),
|
|
85
|
+
* // numberOfQueuedThings: Number("int"),
|
|
86
|
+
* // numberOfInProgressThings: Number("int"),
|
|
87
|
+
* // numberOfRemovedThings: Number("int"),
|
|
88
|
+
* // numberOfTimedOutThings: Number("int"),
|
|
89
|
+
* // },
|
|
90
|
+
* // timeoutConfig: { // TimeoutConfig
|
|
91
|
+
* // inProgressTimeoutInMinutes: Number("long"),
|
|
92
|
+
* // },
|
|
93
|
+
* // namespaceId: "STRING_VALUE",
|
|
94
|
+
* // jobTemplateArn: "STRING_VALUE",
|
|
95
|
+
* // jobExecutionsRetryConfig: { // JobExecutionsRetryConfig
|
|
96
|
+
* // criteriaList: [ // RetryCriteriaList // required
|
|
97
|
+
* // { // RetryCriteria
|
|
98
|
+
* // failureType: "FAILED" || "TIMED_OUT" || "ALL", // required
|
|
99
|
+
* // numberOfRetries: Number("int"), // required
|
|
100
|
+
* // },
|
|
101
|
+
* // ],
|
|
102
|
+
* // },
|
|
103
|
+
* // documentParameters: { // ParameterMap
|
|
104
|
+
* // "<keys>": "STRING_VALUE",
|
|
105
|
+
* // },
|
|
106
|
+
* // isConcurrent: true || false,
|
|
107
|
+
* // schedulingConfig: { // SchedulingConfig
|
|
108
|
+
* // startTime: "STRING_VALUE",
|
|
109
|
+
* // endTime: "STRING_VALUE",
|
|
110
|
+
* // endBehavior: "STOP_ROLLOUT" || "CANCEL" || "FORCE_CANCEL",
|
|
111
|
+
* // maintenanceWindows: [ // MaintenanceWindows
|
|
112
|
+
* // { // MaintenanceWindow
|
|
113
|
+
* // startTime: "STRING_VALUE", // required
|
|
114
|
+
* // durationInMinutes: Number("int"), // required
|
|
115
|
+
* // },
|
|
116
|
+
* // ],
|
|
117
|
+
* // },
|
|
118
|
+
* // scheduledJobRollouts: [ // ScheduledJobRolloutList
|
|
119
|
+
* // { // ScheduledJobRollout
|
|
120
|
+
* // startTime: "STRING_VALUE",
|
|
121
|
+
* // },
|
|
122
|
+
* // ],
|
|
123
|
+
* // },
|
|
124
|
+
* // };
|
|
125
|
+
*
|
|
35
126
|
* ```
|
|
36
127
|
*
|
|
37
128
|
* @param DescribeJobCommandInput - {@link DescribeJobCommandInput}
|
|
@@ -52,6 +143,8 @@ export interface DescribeJobCommandOutput extends DescribeJobResponse, __Metadat
|
|
|
52
143
|
* @throws {@link ThrottlingException} (client fault)
|
|
53
144
|
* <p>The rate exceeds the limit.</p>
|
|
54
145
|
*
|
|
146
|
+
* @throws {@link IoTServiceException}
|
|
147
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
55
148
|
*
|
|
56
149
|
*/
|
|
57
150
|
export declare class DescribeJobCommand extends $Command<DescribeJobCommandInput, DescribeJobCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -34,6 +34,26 @@ export interface DescribeJobExecutionCommandOutput extends DescribeJobExecutionR
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DescribeJobExecutionCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // DescribeJobExecutionResponse
|
|
38
|
+
* // execution: { // JobExecution
|
|
39
|
+
* // jobId: "STRING_VALUE",
|
|
40
|
+
* // status: "QUEUED" || "IN_PROGRESS" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "REJECTED" || "REMOVED" || "CANCELED",
|
|
41
|
+
* // forceCanceled: true || false,
|
|
42
|
+
* // statusDetails: { // JobExecutionStatusDetails
|
|
43
|
+
* // detailsMap: { // DetailsMap
|
|
44
|
+
* // "<keys>": "STRING_VALUE",
|
|
45
|
+
* // },
|
|
46
|
+
* // },
|
|
47
|
+
* // thingArn: "STRING_VALUE",
|
|
48
|
+
* // queuedAt: new Date("TIMESTAMP"),
|
|
49
|
+
* // startedAt: new Date("TIMESTAMP"),
|
|
50
|
+
* // lastUpdatedAt: new Date("TIMESTAMP"),
|
|
51
|
+
* // executionNumber: Number("long"),
|
|
52
|
+
* // versionNumber: Number("long"),
|
|
53
|
+
* // approximateSecondsBeforeTimedOut: Number("long"),
|
|
54
|
+
* // },
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
37
57
|
* ```
|
|
38
58
|
*
|
|
39
59
|
* @param DescribeJobExecutionCommandInput - {@link DescribeJobExecutionCommandInput}
|
|
@@ -54,6 +74,8 @@ export interface DescribeJobExecutionCommandOutput extends DescribeJobExecutionR
|
|
|
54
74
|
* @throws {@link ThrottlingException} (client fault)
|
|
55
75
|
* <p>The rate exceeds the limit.</p>
|
|
56
76
|
*
|
|
77
|
+
* @throws {@link IoTServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
57
79
|
*
|
|
58
80
|
*/
|
|
59
81
|
export declare class DescribeJobExecutionCommand extends $Command<DescribeJobExecutionCommandInput, DescribeJobExecutionCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -31,6 +31,57 @@ export interface DescribeJobTemplateCommandOutput extends DescribeJobTemplateRes
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DescribeJobTemplateCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // DescribeJobTemplateResponse
|
|
35
|
+
* // jobTemplateArn: "STRING_VALUE",
|
|
36
|
+
* // jobTemplateId: "STRING_VALUE",
|
|
37
|
+
* // description: "STRING_VALUE",
|
|
38
|
+
* // documentSource: "STRING_VALUE",
|
|
39
|
+
* // document: "STRING_VALUE",
|
|
40
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
41
|
+
* // presignedUrlConfig: { // PresignedUrlConfig
|
|
42
|
+
* // roleArn: "STRING_VALUE",
|
|
43
|
+
* // expiresInSec: Number("long"),
|
|
44
|
+
* // },
|
|
45
|
+
* // jobExecutionsRolloutConfig: { // JobExecutionsRolloutConfig
|
|
46
|
+
* // maximumPerMinute: Number("int"),
|
|
47
|
+
* // exponentialRate: { // ExponentialRolloutRate
|
|
48
|
+
* // baseRatePerMinute: Number("int"), // required
|
|
49
|
+
* // incrementFactor: Number("double"), // required
|
|
50
|
+
* // rateIncreaseCriteria: { // RateIncreaseCriteria
|
|
51
|
+
* // numberOfNotifiedThings: Number("int"),
|
|
52
|
+
* // numberOfSucceededThings: Number("int"),
|
|
53
|
+
* // },
|
|
54
|
+
* // },
|
|
55
|
+
* // },
|
|
56
|
+
* // abortConfig: { // AbortConfig
|
|
57
|
+
* // criteriaList: [ // AbortCriteriaList // required
|
|
58
|
+
* // { // AbortCriteria
|
|
59
|
+
* // failureType: "FAILED" || "REJECTED" || "TIMED_OUT" || "ALL", // required
|
|
60
|
+
* // action: "CANCEL", // required
|
|
61
|
+
* // thresholdPercentage: Number("double"), // required
|
|
62
|
+
* // minNumberOfExecutedThings: Number("int"), // required
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // },
|
|
66
|
+
* // timeoutConfig: { // TimeoutConfig
|
|
67
|
+
* // inProgressTimeoutInMinutes: Number("long"),
|
|
68
|
+
* // },
|
|
69
|
+
* // jobExecutionsRetryConfig: { // JobExecutionsRetryConfig
|
|
70
|
+
* // criteriaList: [ // RetryCriteriaList // required
|
|
71
|
+
* // { // RetryCriteria
|
|
72
|
+
* // failureType: "FAILED" || "TIMED_OUT" || "ALL", // required
|
|
73
|
+
* // numberOfRetries: Number("int"), // required
|
|
74
|
+
* // },
|
|
75
|
+
* // ],
|
|
76
|
+
* // },
|
|
77
|
+
* // maintenanceWindows: [ // MaintenanceWindows
|
|
78
|
+
* // { // MaintenanceWindow
|
|
79
|
+
* // startTime: "STRING_VALUE", // required
|
|
80
|
+
* // durationInMinutes: Number("int"), // required
|
|
81
|
+
* // },
|
|
82
|
+
* // ],
|
|
83
|
+
* // };
|
|
84
|
+
*
|
|
34
85
|
* ```
|
|
35
86
|
*
|
|
36
87
|
* @param DescribeJobTemplateCommandInput - {@link DescribeJobTemplateCommandInput}
|
|
@@ -51,6 +102,8 @@ export interface DescribeJobTemplateCommandOutput extends DescribeJobTemplateRes
|
|
|
51
102
|
* @throws {@link ThrottlingException} (client fault)
|
|
52
103
|
* <p>The rate exceeds the limit.</p>
|
|
53
104
|
*
|
|
105
|
+
* @throws {@link IoTServiceException}
|
|
106
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
54
107
|
*
|
|
55
108
|
*/
|
|
56
109
|
export declare class DescribeJobTemplateCommand extends $Command<DescribeJobTemplateCommandInput, DescribeJobTemplateCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -32,6 +32,26 @@ export interface DescribeManagedJobTemplateCommandOutput extends DescribeManaged
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeManagedJobTemplateCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeManagedJobTemplateResponse
|
|
36
|
+
* // templateName: "STRING_VALUE",
|
|
37
|
+
* // templateArn: "STRING_VALUE",
|
|
38
|
+
* // description: "STRING_VALUE",
|
|
39
|
+
* // templateVersion: "STRING_VALUE",
|
|
40
|
+
* // environments: [ // Environments
|
|
41
|
+
* // "STRING_VALUE",
|
|
42
|
+
* // ],
|
|
43
|
+
* // documentParameters: [ // DocumentParameters
|
|
44
|
+
* // { // DocumentParameter
|
|
45
|
+
* // key: "STRING_VALUE",
|
|
46
|
+
* // description: "STRING_VALUE",
|
|
47
|
+
* // regex: "STRING_VALUE",
|
|
48
|
+
* // example: "STRING_VALUE",
|
|
49
|
+
* // optional: true || false,
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // document: "STRING_VALUE",
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
35
55
|
* ```
|
|
36
56
|
*
|
|
37
57
|
* @param DescribeManagedJobTemplateCommandInput - {@link DescribeManagedJobTemplateCommandInput}
|
|
@@ -53,6 +73,8 @@ export interface DescribeManagedJobTemplateCommandOutput extends DescribeManaged
|
|
|
53
73
|
* @throws {@link ThrottlingException} (client fault)
|
|
54
74
|
* <p>The rate exceeds the limit.</p>
|
|
55
75
|
*
|
|
76
|
+
* @throws {@link IoTServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
56
78
|
*
|
|
57
79
|
*/
|
|
58
80
|
export declare class DescribeManagedJobTemplateCommand extends $Command<DescribeManagedJobTemplateCommandInput, DescribeManagedJobTemplateCommandOutput, IoTClientResolvedConfig> {
|
|
@@ -32,6 +32,40 @@ export interface DescribeMitigationActionCommandOutput extends DescribeMitigatio
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new DescribeMitigationActionCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // DescribeMitigationActionResponse
|
|
36
|
+
* // actionName: "STRING_VALUE",
|
|
37
|
+
* // actionType: "UPDATE_DEVICE_CERTIFICATE" || "UPDATE_CA_CERTIFICATE" || "ADD_THINGS_TO_THING_GROUP" || "REPLACE_DEFAULT_POLICY_VERSION" || "ENABLE_IOT_LOGGING" || "PUBLISH_FINDING_TO_SNS",
|
|
38
|
+
* // actionArn: "STRING_VALUE",
|
|
39
|
+
* // actionId: "STRING_VALUE",
|
|
40
|
+
* // roleArn: "STRING_VALUE",
|
|
41
|
+
* // actionParams: { // MitigationActionParams
|
|
42
|
+
* // updateDeviceCertificateParams: { // UpdateDeviceCertificateParams
|
|
43
|
+
* // action: "DEACTIVATE", // required
|
|
44
|
+
* // },
|
|
45
|
+
* // updateCACertificateParams: { // UpdateCACertificateParams
|
|
46
|
+
* // action: "DEACTIVATE", // required
|
|
47
|
+
* // },
|
|
48
|
+
* // addThingsToThingGroupParams: { // AddThingsToThingGroupParams
|
|
49
|
+
* // thingGroupNames: [ // ThingGroupNames // required
|
|
50
|
+
* // "STRING_VALUE",
|
|
51
|
+
* // ],
|
|
52
|
+
* // overrideDynamicGroups: true || false,
|
|
53
|
+
* // },
|
|
54
|
+
* // replaceDefaultPolicyVersionParams: { // ReplaceDefaultPolicyVersionParams
|
|
55
|
+
* // templateName: "BLANK_POLICY", // required
|
|
56
|
+
* // },
|
|
57
|
+
* // enableIoTLoggingParams: { // EnableIoTLoggingParams
|
|
58
|
+
* // roleArnForLogging: "STRING_VALUE", // required
|
|
59
|
+
* // logLevel: "DEBUG" || "INFO" || "ERROR" || "WARN" || "DISABLED", // required
|
|
60
|
+
* // },
|
|
61
|
+
* // publishFindingToSnsParams: { // PublishFindingToSnsParams
|
|
62
|
+
* // topicArn: "STRING_VALUE", // required
|
|
63
|
+
* // },
|
|
64
|
+
* // },
|
|
65
|
+
* // creationDate: new Date("TIMESTAMP"),
|
|
66
|
+
* // lastModifiedDate: new Date("TIMESTAMP"),
|
|
67
|
+
* // };
|
|
68
|
+
*
|
|
35
69
|
* ```
|
|
36
70
|
*
|
|
37
71
|
* @param DescribeMitigationActionCommandInput - {@link DescribeMitigationActionCommandInput}
|
|
@@ -52,6 +86,8 @@ export interface DescribeMitigationActionCommandOutput extends DescribeMitigatio
|
|
|
52
86
|
* @throws {@link ThrottlingException} (client fault)
|
|
53
87
|
* <p>The rate exceeds the limit.</p>
|
|
54
88
|
*
|
|
89
|
+
* @throws {@link IoTServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from IoT service.</p>
|
|
55
91
|
*
|
|
56
92
|
*/
|
|
57
93
|
export declare class DescribeMitigationActionCommand extends $Command<DescribeMitigationActionCommandInput, DescribeMitigationActionCommandOutput, IoTClientResolvedConfig> {
|