@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSIot extends Object implements AWSIot
AWSIot. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic void setEndpoint(String endpoint)
AWSIot
Callers can pass in just the endpoint (ex: "iot.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://iot.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AWSIotendpoint - The endpoint (ex: "iot.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://iot.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSIotAWSIot.setEndpoint(String), sets the regional endpoint for this client's service calls.
Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AWSIotregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AcceptCertificateTransferResult acceptCertificateTransfer(AcceptCertificateTransferRequest request)
AWSIotAccepts a pending certificate transfer. The default state of the certificate is INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
Requires permission to access the AcceptCertificateTransfer action.
acceptCertificateTransfer in interface AWSIotrequest - The input for the AcceptCertificateTransfer operation.public AddThingToBillingGroupResult addThingToBillingGroup(AddThingToBillingGroupRequest request)
AWSIotAdds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
addThingToBillingGroup in interface AWSIotpublic AddThingToThingGroupResult addThingToThingGroup(AddThingToThingGroupRequest request)
AWSIotAdds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
addThingToThingGroup in interface AWSIotpublic AssociateTargetsWithJobResult associateTargetsWithJob(AssociateTargetsWithJobRequest request)
AWSIotAssociates a group with a continuous job. The following criteria must be met:
The job must have been created with the targetSelection field set to "CONTINUOUS".
The job status must currently be "IN_PROGRESS".
The total number of targets associated with a job must not exceed 100.
Requires permission to access the AssociateTargetsWithJob action.
associateTargetsWithJob in interface AWSIotpublic AttachPolicyResult attachPolicy(AttachPolicyRequest request)
AWSIotAttaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
attachPolicy in interface AWSIot@Deprecated public AttachPrincipalPolicyResult attachPrincipalPolicy(AttachPrincipalPolicyRequest request)
AWSIotAttaches the specified policy to the specified principal (certificate or other credential).
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.
Requires permission to access the AttachPrincipalPolicy action.
attachPrincipalPolicy in interface AWSIotrequest - The input for the AttachPrincipalPolicy operation.public AttachSecurityProfileResult attachSecurityProfile(AttachSecurityProfileRequest request)
AWSIotAssociates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
Requires permission to access the AttachSecurityProfile action.
attachSecurityProfile in interface AWSIotpublic AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest request)
AWSIotAttaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities.
Requires permission to access the AttachThingPrincipal action.
attachThingPrincipal in interface AWSIotrequest - The input for the AttachThingPrincipal operation.public CancelAuditMitigationActionsTaskResult cancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest request)
AWSIotCancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
Requires permission to access the CancelAuditMitigationActionsTask action.
cancelAuditMitigationActionsTask in interface AWSIotpublic CancelAuditTaskResult cancelAuditTask(CancelAuditTaskRequest request)
AWSIotCancels 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.
Requires permission to access the CancelAuditTask action.
cancelAuditTask in interface AWSIotpublic CancelCertificateTransferResult cancelCertificateTransfer(CancelCertificateTransferRequest request)
AWSIotCancels a pending transfer for the specified certificate.
Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
Requires permission to access the CancelCertificateTransfer action.
cancelCertificateTransfer in interface AWSIotrequest - The input for the CancelCertificateTransfer operation.public CancelDetectMitigationActionsTaskResult cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest request)
AWSIotCancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
cancelDetectMitigationActionsTask in interface AWSIotpublic CancelJobResult cancelJob(CancelJobRequest request)
AWSIotCancels a job.
Requires permission to access the CancelJob action.
public CancelJobExecutionResult cancelJobExecution(CancelJobExecutionRequest request)
AWSIotCancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
cancelJobExecution in interface AWSIotpublic ClearDefaultAuthorizerResult clearDefaultAuthorizer(ClearDefaultAuthorizerRequest request)
AWSIotClears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
clearDefaultAuthorizer in interface AWSIotpublic ConfirmTopicRuleDestinationResult confirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest request)
AWSIot
Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation
message to the endpoint or base address you specify. The message includes a token which you pass back when
calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.
Requires permission to access the ConfirmTopicRuleDestination action.
confirmTopicRuleDestination in interface AWSIotpublic CreateAuditSuppressionResult createAuditSuppression(CreateAuditSuppressionRequest request)
AWSIotCreates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
createAuditSuppression in interface AWSIotpublic CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)
AWSIotCreates an authorizer.
Requires permission to access the CreateAuthorizer action.
createAuthorizer in interface AWSIotpublic CreateBillingGroupResult createBillingGroup(CreateBillingGroupRequest request)
AWSIotCreates a billing group.
Requires permission to access the CreateBillingGroup action.
createBillingGroup in interface AWSIotpublic CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest request)
AWSIotCreates an X.509 certificate using the specified certificate signing request.
Requires permission to access the CreateCertificateFromCsr action.
The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr files
into that directory, and then specifying that directory on the command line. The following commands show how to
create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are
located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the
aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for the
corresponding CSR.
You can also run the aws iot create-certificate-from-csr part of the command in parallel to speed up
the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
createCertificateFromCsr in interface AWSIotrequest - The input for the CreateCertificateFromCsr operation.public CreateCertificateProviderResult createCertificateProvider(CreateCertificateProviderRequest request)
AWSIotCreates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.
Requires permission to access the CreateCertificateProvider action.
After you create a certificate provider, the behavior of
CreateCertificateFromCsr API for fleet provisioning will change and all API calls to
CreateCertificateFromCsr will invoke the certificate provider to create the certificates. It can
take up to a few minutes for this behavior to change after a certificate provider is created.
createCertificateProvider in interface AWSIotpublic CreateCustomMetricResult createCustomMetric(CreateCustomMetricRequest request)
AWSIotUse this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
createCustomMetric in interface AWSIotpublic CreateDimensionResult createDimension(CreateDimensionRequest request)
AWSIot
Create a dimension that you can use to limit the scope of a metric used in a security profile for 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.
Requires permission to access the CreateDimension action.
createDimension in interface AWSIotpublic CreateDomainConfigurationResult createDomainConfiguration(CreateDomainConfigurationRequest request)
AWSIotCreates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
createDomainConfiguration in interface AWSIotpublic CreateDynamicThingGroupResult createDynamicThingGroup(CreateDynamicThingGroupRequest request)
AWSIotCreates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
createDynamicThingGroup in interface AWSIotpublic CreateFleetMetricResult createFleetMetric(CreateFleetMetricRequest request)
AWSIotCreates a fleet metric.
Requires permission to access the CreateFleetMetric action.
createFleetMetric in interface AWSIotpublic CreateJobResult createJob(CreateJobRequest request)
AWSIotCreates a job.
Requires permission to access the CreateJob action.
public CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest request)
AWSIotCreates a job template.
Requires permission to access the CreateJobTemplate action.
createJobTemplate in interface AWSIotpublic CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest request)
AWSIot
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call
CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.
Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location.
Requires permission to access the CreateKeysAndCertificate action.
createKeysAndCertificate in interface AWSIotrequest - The input for the CreateKeysAndCertificate operation.
Requires permission to access the CreateKeysAndCertificateRequest action.
public CreateMitigationActionResult createMitigationAction(CreateMitigationActionRequest request)
AWSIotDefines 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.
Requires permission to access the CreateMitigationAction action.
createMitigationAction in interface AWSIotpublic CreateOTAUpdateResult createOTAUpdate(CreateOTAUpdateRequest request)
AWSIotCreates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
createOTAUpdate in interface AWSIotpublic CreatePackageResult createPackage(CreatePackageRequest request)
AWSIotCreates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
createPackage in interface AWSIotpublic CreatePackageVersionResult createPackageVersion(CreatePackageVersionRequest request)
AWSIotCreates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
createPackageVersion in interface AWSIotpublic CreatePolicyResult createPolicy(CreatePolicyRequest request)
AWSIotCreates an IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
Requires permission to access the CreatePolicy action.
createPolicy in interface AWSIotrequest - The input for the CreatePolicy operation.public CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest request)
AWSIotCreates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
Requires permission to access the CreatePolicyVersion action.
createPolicyVersion in interface AWSIotrequest - The input for the CreatePolicyVersion operation.public CreateProvisioningClaimResult createProvisioningClaim(CreateProvisioningClaimRequest request)
AWSIotCreates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
createProvisioningClaim in interface AWSIotpublic CreateProvisioningTemplateResult createProvisioningTemplate(CreateProvisioningTemplateRequest request)
AWSIotCreates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
createProvisioningTemplate in interface AWSIotpublic CreateProvisioningTemplateVersionResult createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest request)
AWSIotCreates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
createProvisioningTemplateVersion in interface AWSIotpublic CreateRoleAliasResult createRoleAlias(CreateRoleAliasRequest request)
AWSIotCreates a role alias.
Requires permission to access the CreateRoleAlias action.
createRoleAlias in interface AWSIotpublic CreateScheduledAuditResult createScheduledAudit(CreateScheduledAuditRequest request)
AWSIotCreates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
createScheduledAudit in interface AWSIotpublic CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest request)
AWSIotCreates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
createSecurityProfile in interface AWSIotpublic CreateStreamResult createStream(CreateStreamRequest request)
AWSIotCreates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.
Requires permission to access the CreateStream action.
createStream in interface AWSIotpublic CreateThingResult createThing(CreateThingRequest request)
AWSIot
Creates a thing record in the registry. If this call is made multiple times using the same thing name and
configuration, the call will succeed. If this call is made with the same thing name but different configuration a
ResourceAlreadyExistsException is thrown.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
Requires permission to access the CreateThing action.
createThing in interface AWSIotrequest - The input for the CreateThing operation.public CreateThingGroupResult createThingGroup(CreateThingGroupRequest request)
AWSIotCreate a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
If the ThingGroup that you create has the exact same attributes as an existing
ThingGroup, you will get a 200 success response.
Requires permission to access the CreateThingGroup action.
createThingGroup in interface AWSIotpublic CreateThingTypeResult createThingType(CreateThingTypeRequest request)
AWSIotCreates a new thing type.
Requires permission to access the CreateThingType action.
createThingType in interface AWSIotrequest - The input for the CreateThingType operation.public CreateTopicRuleResult createTopicRule(CreateTopicRuleRequest request)
AWSIotCreates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
Requires permission to access the CreateTopicRule action.
createTopicRule in interface AWSIotrequest - The input for the CreateTopicRule operation.public CreateTopicRuleDestinationResult createTopicRuleDestination(CreateTopicRuleDestinationRequest request)
AWSIotCreates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
createTopicRuleDestination in interface AWSIotpublic DeleteAccountAuditConfigurationResult deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest request)
AWSIotRestores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.
Requires permission to access the DeleteAccountAuditConfiguration action.
deleteAccountAuditConfiguration in interface AWSIotpublic DeleteAuditSuppressionResult deleteAuditSuppression(DeleteAuditSuppressionRequest request)
AWSIotDeletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
deleteAuditSuppression in interface AWSIotpublic DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
AWSIotDeletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
deleteAuthorizer in interface AWSIotpublic DeleteBillingGroupResult deleteBillingGroup(DeleteBillingGroupRequest request)
AWSIotDeletes the billing group.
Requires permission to access the DeleteBillingGroup action.
deleteBillingGroup in interface AWSIotpublic DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest request)
AWSIotDeletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
deleteCACertificate in interface AWSIotrequest - Input for the DeleteCACertificate operation.public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
AWSIotDeletes the specified certificate.
A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.
Requires permission to access the DeleteCertificate action.
deleteCertificate in interface AWSIotrequest - The input for the DeleteCertificate operation.public DeleteCertificateProviderResult deleteCertificateProvider(DeleteCertificateProviderRequest request)
AWSIotDeletes a certificate provider.
Requires permission to access the DeleteCertificateProvider action.
If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr will
resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).
deleteCertificateProvider in interface AWSIotpublic DeleteCustomMetricResult deleteCustomMetric(DeleteCustomMetricRequest request)
AWSIotDeletes a Device Defender detect custom metric.
Requires permission to access the DeleteCustomMetric action.
Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a
part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles
API with metricName set to your custom metric name.
deleteCustomMetric in interface AWSIotpublic DeleteDimensionResult deleteDimension(DeleteDimensionRequest request)
AWSIotRemoves the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
deleteDimension in interface AWSIotpublic DeleteDomainConfigurationResult deleteDomainConfiguration(DeleteDomainConfigurationRequest request)
AWSIotDeletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
deleteDomainConfiguration in interface AWSIotpublic DeleteDynamicThingGroupResult deleteDynamicThingGroup(DeleteDynamicThingGroupRequest request)
AWSIotDeletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
deleteDynamicThingGroup in interface AWSIotpublic DeleteFleetMetricResult deleteFleetMetric(DeleteFleetMetricRequest request)
AWSIotDeletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.
Requires permission to access the DeleteFleetMetric action.
deleteFleetMetric in interface AWSIotpublic DeleteJobResult deleteJob(DeleteJobRequest request)
AWSIotDeletes a job and its related job executions.
Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.
Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.
Requires permission to access the DeleteJob action.
public DeleteJobExecutionResult deleteJobExecution(DeleteJobExecutionRequest request)
AWSIotDeletes a job execution.
Requires permission to access the DeleteJobExecution action.
deleteJobExecution in interface AWSIotpublic DeleteJobTemplateResult deleteJobTemplate(DeleteJobTemplateRequest request)
AWSIotDeletes the specified job template.
deleteJobTemplate in interface AWSIotpublic DeleteMitigationActionResult deleteMitigationAction(DeleteMitigationActionRequest request)
AWSIotDeletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
deleteMitigationAction in interface AWSIotpublic DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest request)
AWSIotDelete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
deleteOTAUpdate in interface AWSIotpublic DeletePackageResult deletePackage(DeletePackageRequest request)
AWSIotDeletes a specific version from a software package.
Note: All package versions must be deleted before deleting the software package.
Requires permission to access the DeletePackageVersion action.
deletePackage in interface AWSIotpublic DeletePackageVersionResult deletePackageVersion(DeletePackageVersionRequest request)
AWSIotDeletes a specific version from a software package.
Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.
deletePackageVersion in interface AWSIotpublic DeletePolicyResult deletePolicy(DeletePolicyRequest request)
AWSIotDeletes the specified policy.
A policy cannot be deleted if it has non-default versions or it is attached to any certificate.
To delete a policy, use the DeletePolicyVersion action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.
Requires permission to access the DeletePolicy action.
deletePolicy in interface AWSIotrequest - The input for the DeletePolicy operation.public DeletePolicyVersionResult deletePolicyVersion(DeletePolicyVersionRequest request)
AWSIotDeletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
Requires permission to access the DeletePolicyVersion action.
deletePolicyVersion in interface AWSIotrequest - The input for the DeletePolicyVersion operation.public DeleteProvisioningTemplateResult deleteProvisioningTemplate(DeleteProvisioningTemplateRequest request)
AWSIotDeletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
deleteProvisioningTemplate in interface AWSIotpublic DeleteProvisioningTemplateVersionResult deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest request)
AWSIotDeletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
deleteProvisioningTemplateVersion in interface AWSIotpublic DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest request)
AWSIotDeletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
deleteRegistrationCode in interface AWSIotrequest - The input for the DeleteRegistrationCode operation.public DeleteRoleAliasResult deleteRoleAlias(DeleteRoleAliasRequest request)
AWSIotDeletes a role alias
Requires permission to access the DeleteRoleAlias action.
deleteRoleAlias in interface AWSIotpublic DeleteScheduledAuditResult deleteScheduledAudit(DeleteScheduledAuditRequest request)
AWSIotDeletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
deleteScheduledAudit in interface AWSIotpublic DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest request)
AWSIotDeletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
deleteSecurityProfile in interface AWSIotpublic DeleteStreamResult deleteStream(DeleteStreamRequest request)
AWSIotDeletes a stream.
Requires permission to access the DeleteStream action.
deleteStream in interface AWSIotpublic DeleteThingResult deleteThing(DeleteThingRequest request)
AWSIotDeletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
Requires permission to access the DeleteThing action.
deleteThing in interface AWSIotrequest - The input for the DeleteThing operation.public DeleteThingGroupResult deleteThingGroup(DeleteThingGroupRequest request)
AWSIotDeletes a thing group.
Requires permission to access the DeleteThingGroup action.
deleteThingGroup in interface AWSIotpublic DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest request)
AWSIotDeletes the specified thing type. You cannot delete a thing type if it has things associated 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 finally use DeleteThingType to delete the thing type.
Requires permission to access the DeleteThingType action.
deleteThingType in interface AWSIotrequest - The input for the DeleteThingType operation.public DeleteTopicRuleResult deleteTopicRule(DeleteTopicRuleRequest request)
AWSIotDeletes the rule.
Requires permission to access the DeleteTopicRule action.
deleteTopicRule in interface AWSIotrequest - The input for the DeleteTopicRule operation.public DeleteTopicRuleDestinationResult deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest request)
AWSIotDeletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
deleteTopicRuleDestination in interface AWSIotpublic DeleteV2LoggingLevelResult deleteV2LoggingLevel(DeleteV2LoggingLevelRequest request)
AWSIotDeletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
deleteV2LoggingLevel in interface AWSIotpublic DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest request)
AWSIotDeprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
deprecateThingType in interface AWSIotrequest - The input for the DeprecateThingType operation.public DescribeAccountAuditConfigurationResult describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest request)
AWSIotGets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the DescribeAccountAuditConfiguration action.
describeAccountAuditConfiguration in interface AWSIotpublic DescribeAuditFindingResult describeAuditFinding(DescribeAuditFindingRequest request)
AWSIotGets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
Requires permission to access the DescribeAuditFinding action.
describeAuditFinding in interface AWSIotpublic DescribeAuditMitigationActionsTaskResult describeAuditMitigationActionsTask(DescribeAuditMitigationActionsTaskRequest request)
AWSIotGets 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.
describeAuditMitigationActionsTask in interface AWSIotpublic DescribeAuditSuppressionResult describeAuditSuppression(DescribeAuditSuppressionRequest request)
AWSIotGets information about a Device Defender audit suppression.
describeAuditSuppression in interface AWSIotpublic DescribeAuditTaskResult describeAuditTask(DescribeAuditTaskRequest request)
AWSIotGets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
describeAuditTask in interface AWSIotpublic DescribeAuthorizerResult describeAuthorizer(DescribeAuthorizerRequest request)
AWSIotDescribes an authorizer.
Requires permission to access the DescribeAuthorizer action.
describeAuthorizer in interface AWSIotpublic DescribeBillingGroupResult describeBillingGroup(DescribeBillingGroupRequest request)
AWSIotReturns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
describeBillingGroup in interface AWSIotpublic DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest request)
AWSIotDescribes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
describeCACertificate in interface AWSIotrequest - The input for the DescribeCACertificate operation.public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
AWSIotGets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
describeCertificate in interface AWSIotrequest - The input for the DescribeCertificate operation.public DescribeCertificateProviderResult describeCertificateProvider(DescribeCertificateProviderRequest request)
AWSIotDescribes a certificate provider.
Requires permission to access the DescribeCertificateProvider action.
describeCertificateProvider in interface AWSIotpublic DescribeCustomMetricResult describeCustomMetric(DescribeCustomMetricRequest request)
AWSIotGets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
describeCustomMetric in interface AWSIotpublic DescribeDefaultAuthorizerResult describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest request)
AWSIotDescribes the default authorizer.
Requires permission to access the DescribeDefaultAuthorizer action.
describeDefaultAuthorizer in interface AWSIotpublic DescribeDetectMitigationActionsTaskResult describeDetectMitigationActionsTask(DescribeDetectMitigationActionsTaskRequest request)
AWSIotGets information about a Device Defender ML Detect mitigation action.
Requires permission to access the DescribeDetectMitigationActionsTask action.
describeDetectMitigationActionsTask in interface AWSIotpublic DescribeDimensionResult describeDimension(DescribeDimensionRequest request)
AWSIotProvides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
describeDimension in interface AWSIotpublic DescribeDomainConfigurationResult describeDomainConfiguration(DescribeDomainConfigurationRequest request)
AWSIotGets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
describeDomainConfiguration in interface AWSIotpublic DescribeEndpointResult describeEndpoint(DescribeEndpointRequest request)
AWSIotReturns or creates a unique endpoint specific to the Amazon Web Services account making the call.
The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to
DescribeEndpoint return the same endpoint.
Requires permission to access the DescribeEndpoint action.
describeEndpoint in interface AWSIotrequest - The input for the DescribeEndpoint operation.public DescribeEventConfigurationsResult describeEventConfigurations(DescribeEventConfigurationsRequest request)
AWSIotDescribes event configurations.
Requires permission to access the DescribeEventConfigurations action.
describeEventConfigurations in interface AWSIotpublic DescribeFleetMetricResult describeFleetMetric(DescribeFleetMetricRequest request)
AWSIotGets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
describeFleetMetric in interface AWSIotpublic DescribeIndexResult describeIndex(DescribeIndexRequest request)
AWSIotDescribes a search index.
Requires permission to access the DescribeIndex action.
describeIndex in interface AWSIotpublic DescribeJobResult describeJob(DescribeJobRequest request)
AWSIotDescribes a job.
Requires permission to access the DescribeJob action.
describeJob in interface AWSIotpublic DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest request)
AWSIotDescribes a job execution.
Requires permission to access the DescribeJobExecution action.
describeJobExecution in interface AWSIotpublic DescribeJobTemplateResult describeJobTemplate(DescribeJobTemplateRequest request)
AWSIotReturns information about a job template.
describeJobTemplate in interface AWSIotpublic DescribeManagedJobTemplateResult describeManagedJobTemplate(DescribeManagedJobTemplateRequest request)
AWSIotView details of a managed job template.
describeManagedJobTemplate in interface AWSIotpublic DescribeMitigationActionResult describeMitigationAction(DescribeMitigationActionRequest request)
AWSIotGets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
describeMitigationAction in interface AWSIotpublic DescribeProvisioningTemplateResult describeProvisioningTemplate(DescribeProvisioningTemplateRequest request)
AWSIotReturns information about a provisioning template.
Requires permission to access the DescribeProvisioningTemplate action.
describeProvisioningTemplate in interface AWSIotpublic DescribeProvisioningTemplateVersionResult describeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest request)
AWSIotReturns information about a provisioning template version.
Requires permission to access the DescribeProvisioningTemplateVersion action.
describeProvisioningTemplateVersion in interface AWSIotpublic DescribeRoleAliasResult describeRoleAlias(DescribeRoleAliasRequest request)
AWSIotDescribes a role alias.
Requires permission to access the DescribeRoleAlias action.
describeRoleAlias in interface AWSIotpublic DescribeScheduledAuditResult describeScheduledAudit(DescribeScheduledAuditRequest request)
AWSIotGets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
describeScheduledAudit in interface AWSIotpublic DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest request)
AWSIotGets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
describeSecurityProfile in interface AWSIotpublic DescribeStreamResult describeStream(DescribeStreamRequest request)
AWSIotGets information about a stream.
Requires permission to access the DescribeStream action.
describeStream in interface AWSIotpublic DescribeThingResult describeThing(DescribeThingRequest request)
AWSIotGets information about the specified thing.
Requires permission to access the DescribeThing action.
describeThing in interface AWSIotrequest - The input for the DescribeThing operation.public DescribeThingGroupResult describeThingGroup(DescribeThingGroupRequest request)
AWSIotDescribe a thing group.
Requires permission to access the DescribeThingGroup action.
describeThingGroup in interface AWSIotpublic DescribeThingRegistrationTaskResult describeThingRegistrationTask(DescribeThingRegistrationTaskRequest request)
AWSIotDescribes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
describeThingRegistrationTask in interface AWSIotpublic DescribeThingTypeResult describeThingType(DescribeThingTypeRequest request)
AWSIotGets information about the specified thing type.
Requires permission to access the DescribeThingType action.
describeThingType in interface AWSIotrequest - The input for the DescribeThingType operation.public DetachPolicyResult detachPolicy(DetachPolicyRequest request)
AWSIotDetaches a policy from the specified target.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.
Requires permission to access the DetachPolicy action.
detachPolicy in interface AWSIot@Deprecated public DetachPrincipalPolicyResult detachPrincipalPolicy(DetachPrincipalPolicyRequest request)
AWSIotRemoves the specified policy from the specified certificate.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.
Requires permission to access the DetachPrincipalPolicy action.
detachPrincipalPolicy in interface AWSIotrequest - The input for the DetachPrincipalPolicy operation.public DetachSecurityProfileResult detachSecurityProfile(DetachSecurityProfileRequest request)
AWSIotDisassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
detachSecurityProfile in interface AWSIotpublic DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest request)
AWSIotDetaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
This call is asynchronous. It might take several seconds for the detachment to propagate.
Requires permission to access the DetachThingPrincipal action.
detachThingPrincipal in interface AWSIotrequest - The input for the DetachThingPrincipal operation.public DisableTopicRuleResult disableTopicRule(DisableTopicRuleRequest request)
AWSIotDisables the rule.
Requires permission to access the DisableTopicRule action.
disableTopicRule in interface AWSIotrequest - The input for the DisableTopicRuleRequest operation.public EnableTopicRuleResult enableTopicRule(EnableTopicRuleRequest request)
AWSIotEnables the rule.
Requires permission to access the EnableTopicRule action.
enableTopicRule in interface AWSIotrequest - The input for the EnableTopicRuleRequest operation.public GetBehaviorModelTrainingSummariesResult getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest request)
AWSIotReturns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
getBehaviorModelTrainingSummaries in interface AWSIotpublic GetBucketsAggregationResult getBucketsAggregation(GetBucketsAggregationRequest request)
AWSIotAggregates on indexed data with search queries pertaining to particular fields.
Requires permission to access the GetBucketsAggregation action.
getBucketsAggregation in interface AWSIotpublic GetCardinalityResult getCardinality(GetCardinalityRequest request)
AWSIotReturns the approximate count of unique values that match the query.
Requires permission to access the GetCardinality action.
getCardinality in interface AWSIotpublic GetEffectivePoliciesResult getEffectivePolicies(GetEffectivePoliciesRequest request)
AWSIotGets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway.
Requires permission to access the GetEffectivePolicies action.
getEffectivePolicies in interface AWSIotpublic GetIndexingConfigurationResult getIndexingConfiguration(GetIndexingConfigurationRequest request)
AWSIotGets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
getIndexingConfiguration in interface AWSIotpublic GetJobDocumentResult getJobDocument(GetJobDocumentRequest request)
AWSIotGets a job document.
Requires permission to access the GetJobDocument action.
getJobDocument in interface AWSIotpublic GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest request)
AWSIotGets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
Requires permission to access the GetLoggingOptions action.
getLoggingOptions in interface AWSIotrequest - The input for the GetLoggingOptions operation.public GetOTAUpdateResult getOTAUpdate(GetOTAUpdateRequest request)
AWSIotGets an OTA update.
Requires permission to access the GetOTAUpdate action.
getOTAUpdate in interface AWSIotpublic GetPackageResult getPackage(GetPackageRequest request)
AWSIotGets information about the specified software package.
Requires permission to access the GetPackage action.
getPackage in interface AWSIotpublic GetPackageConfigurationResult getPackageConfiguration(GetPackageConfigurationRequest request)
AWSIotGets information about the specified software package's configuration.
Requires permission to access the GetPackageConfiguration action.
getPackageConfiguration in interface AWSIotpublic GetPackageVersionResult getPackageVersion(GetPackageVersionRequest request)
AWSIotGets information about the specified package version.
Requires permission to access the GetPackageVersion action.
getPackageVersion in interface AWSIotpublic GetPercentilesResult getPercentiles(GetPercentilesRequest request)
AWSIot
Groups the aggregated values that match the query into percentile groupings. The default percentile groupings
are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This
function returns a value for each percentile group specified (or the default percentile groupings). The
percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values
that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately
five percent of the values that match the query, and so on. The result is an approximation, the more values that
match the query, the more accurate the percentile values.
Requires permission to access the GetPercentiles action.
getPercentiles in interface AWSIotpublic GetPolicyResult getPolicy(GetPolicyRequest request)
AWSIotGets information about the specified policy with the policy document of the default version.
Requires permission to access the GetPolicy action.
public GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest request)
AWSIotGets information about the specified policy version.
Requires permission to access the GetPolicyVersion action.
getPolicyVersion in interface AWSIotrequest - The input for the GetPolicyVersion operation.public GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest request)
AWSIotGets a registration code used to register a CA certificate with IoT.
IoT will create a registration code as part of this API call if the registration code doesn't exist or has been deleted. If you already have a registration code, this API call will return the same registration code.
Requires permission to access the GetRegistrationCode action.
getRegistrationCode in interface AWSIotrequest - The input to the GetRegistrationCode operation.public GetStatisticsResult getStatistics(GetStatisticsRequest request)
AWSIot
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the
specified aggregated field. If the aggregation field is of type String, only the count statistic is
returned.
Requires permission to access the GetStatistics action.
getStatistics in interface AWSIotpublic GetTopicRuleResult getTopicRule(GetTopicRuleRequest request)
AWSIotGets information about the rule.
Requires permission to access the GetTopicRule action.
getTopicRule in interface AWSIotrequest - The input for the GetTopicRule operation.public GetTopicRuleDestinationResult getTopicRuleDestination(GetTopicRuleDestinationRequest request)
AWSIotGets information about a topic rule destination.
Requires permission to access the GetTopicRuleDestination action.
getTopicRuleDestination in interface AWSIotpublic GetV2LoggingOptionsResult getV2LoggingOptions(GetV2LoggingOptionsRequest request)
AWSIotGets the fine grained logging options.
Requires permission to access the GetV2LoggingOptions action.
getV2LoggingOptions in interface AWSIotpublic ListActiveViolationsResult listActiveViolations(ListActiveViolationsRequest request)
AWSIotLists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
listActiveViolations in interface AWSIotpublic ListAttachedPoliciesResult listAttachedPolicies(ListAttachedPoliciesRequest request)
AWSIotLists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
listAttachedPolicies in interface AWSIotpublic ListAuditFindingsResult listAuditFindings(ListAuditFindingsRequest request)
AWSIotLists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)
Requires permission to access the ListAuditFindings action.
listAuditFindings in interface AWSIotpublic ListAuditMitigationActionsExecutionsResult listAuditMitigationActionsExecutions(ListAuditMitigationActionsExecutionsRequest request)
AWSIotGets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
listAuditMitigationActionsExecutions in interface AWSIotpublic ListAuditMitigationActionsTasksResult listAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest request)
AWSIotGets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
listAuditMitigationActionsTasks in interface AWSIotpublic ListAuditSuppressionsResult listAuditSuppressions(ListAuditSuppressionsRequest request)
AWSIotLists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
listAuditSuppressions in interface AWSIotpublic ListAuditTasksResult listAuditTasks(ListAuditTasksRequest request)
AWSIotLists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
listAuditTasks in interface AWSIotpublic ListAuthorizersResult listAuthorizers(ListAuthorizersRequest request)
AWSIotLists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
listAuthorizers in interface AWSIotpublic ListBillingGroupsResult listBillingGroups(ListBillingGroupsRequest request)
AWSIotLists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
listBillingGroups in interface AWSIotpublic ListCACertificatesResult listCACertificates(ListCACertificatesRequest request)
AWSIotLists the CA certificates registered for your Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCACertificates action.
listCACertificates in interface AWSIotrequest - Input for the ListCACertificates operation.public ListCertificateProvidersResult listCertificateProviders(ListCertificateProvidersRequest request)
AWSIotLists all your certificate providers in your Amazon Web Services account.
Requires permission to access the ListCertificateProviders action.
listCertificateProviders in interface AWSIotpublic ListCertificatesResult listCertificates(ListCertificatesRequest request)
AWSIotLists the certificates registered in your Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCertificates action.
listCertificates in interface AWSIotrequest - The input for the ListCertificates operation.public ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest request)
AWSIotList the device certificates signed by the specified CA certificate.
Requires permission to access the ListCertificatesByCA action.
listCertificatesByCA in interface AWSIotrequest - The input to the ListCertificatesByCA operation.public ListCustomMetricsResult listCustomMetrics(ListCustomMetricsRequest request)
AWSIotLists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
listCustomMetrics in interface AWSIotpublic ListDetectMitigationActionsExecutionsResult listDetectMitigationActionsExecutions(ListDetectMitigationActionsExecutionsRequest request)
AWSIotLists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
listDetectMitigationActionsExecutions in interface AWSIotpublic ListDetectMitigationActionsTasksResult listDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest request)
AWSIotList of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
listDetectMitigationActionsTasks in interface AWSIotpublic ListDimensionsResult listDimensions(ListDimensionsRequest request)
AWSIotList the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
listDimensions in interface AWSIotpublic ListDomainConfigurationsResult listDomainConfigurations(ListDomainConfigurationsRequest request)
AWSIotGets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.
Requires permission to access the ListDomainConfigurations action.
listDomainConfigurations in interface AWSIotpublic ListFleetMetricsResult listFleetMetrics(ListFleetMetricsRequest request)
AWSIotLists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
listFleetMetrics in interface AWSIotpublic ListIndicesResult listIndices(ListIndicesRequest request)
AWSIotLists the search indices.
Requires permission to access the ListIndices action.
listIndices in interface AWSIotpublic ListJobExecutionsForJobResult listJobExecutionsForJob(ListJobExecutionsForJobRequest request)
AWSIotLists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
listJobExecutionsForJob in interface AWSIotpublic ListJobExecutionsForThingResult listJobExecutionsForThing(ListJobExecutionsForThingRequest request)
AWSIotLists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
listJobExecutionsForThing in interface AWSIotpublic ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest request)
AWSIotReturns a list of job templates.
Requires permission to access the ListJobTemplates action.
listJobTemplates in interface AWSIotpublic ListJobsResult listJobs(ListJobsRequest request)
AWSIotLists jobs.
Requires permission to access the ListJobs action.
public ListManagedJobTemplatesResult listManagedJobTemplates(ListManagedJobTemplatesRequest request)
AWSIotReturns a list of managed job templates.
listManagedJobTemplates in interface AWSIotpublic ListMetricValuesResult listMetricValues(ListMetricValuesRequest request)
AWSIotLists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.
listMetricValues in interface AWSIotpublic ListMitigationActionsResult listMitigationActions(ListMitigationActionsRequest request)
AWSIotGets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
listMitigationActions in interface AWSIotpublic ListOTAUpdatesResult listOTAUpdates(ListOTAUpdatesRequest request)
AWSIotLists OTA updates.
Requires permission to access the ListOTAUpdates action.
listOTAUpdates in interface AWSIotpublic ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest request)
AWSIotLists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
listOutgoingCertificates in interface AWSIotrequest - The input to the ListOutgoingCertificates operation.public ListPackageVersionsResult listPackageVersions(ListPackageVersionsRequest request)
AWSIotLists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
listPackageVersions in interface AWSIotpublic ListPackagesResult listPackages(ListPackagesRequest request)
AWSIotLists the software packages associated to the account.
Requires permission to access the ListPackages action.
listPackages in interface AWSIotpublic ListPoliciesResult listPolicies(ListPoliciesRequest request)
AWSIotLists your policies.
Requires permission to access the ListPolicies action.
listPolicies in interface AWSIotrequest - The input for the ListPolicies operation.@Deprecated public ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest request)
AWSIotLists the principals associated with the specified policy.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.
Requires permission to access the ListPolicyPrincipals action.
listPolicyPrincipals in interface AWSIotrequest - The input for the ListPolicyPrincipals operation.public ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest request)
AWSIotLists the versions of the specified policy and identifies the default version.
Requires permission to access the ListPolicyVersions action.
listPolicyVersions in interface AWSIotrequest - The input for the ListPolicyVersions operation.@Deprecated public ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest request)
AWSIotLists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.
Requires permission to access the ListPrincipalPolicies action.
listPrincipalPolicies in interface AWSIotrequest - The input for the ListPrincipalPolicies operation.public ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest request)
AWSIotLists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the ListPrincipalThings action.
listPrincipalThings in interface AWSIotrequest - The input for the ListPrincipalThings operation.public ListProvisioningTemplateVersionsResult listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest request)
AWSIotA list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
listProvisioningTemplateVersions in interface AWSIotpublic ListProvisioningTemplatesResult listProvisioningTemplates(ListProvisioningTemplatesRequest request)
AWSIotLists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
listProvisioningTemplates in interface AWSIotpublic ListRelatedResourcesForAuditFindingResult listRelatedResourcesForAuditFinding(ListRelatedResourcesForAuditFindingRequest request)
AWSIotThe related resources of an Audit finding. The following resources can be returned from calling this API:
DEVICE_CERTIFICATE
CA_CERTIFICATE
IOT_POLICY
COGNITO_IDENTITY_POOL
CLIENT_ID
ACCOUNT_SETTINGS
ROLE_ALIAS
IAM_ROLE
ISSUER_CERTIFICATE
This API is similar to DescribeAuditFinding's RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.
listRelatedResourcesForAuditFinding in interface AWSIotpublic ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest request)
AWSIotLists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
listRoleAliases in interface AWSIotpublic ListScheduledAuditsResult listScheduledAudits(ListScheduledAuditsRequest request)
AWSIotLists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
listScheduledAudits in interface AWSIotpublic ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)
AWSIotLists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.
Requires permission to access the ListSecurityProfiles action.
dimensionName and metricName cannot be used in the same request.
listSecurityProfiles in interface AWSIotpublic ListSecurityProfilesForTargetResult listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest request)
AWSIotLists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
listSecurityProfilesForTarget in interface AWSIotpublic ListStreamsResult listStreams(ListStreamsRequest request)
AWSIotLists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
listStreams in interface AWSIotpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSIotLists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
listTagsForResource in interface AWSIotpublic ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest request)
AWSIotList targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
listTargetsForPolicy in interface AWSIotpublic ListTargetsForSecurityProfileResult listTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest request)
AWSIotLists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
listTargetsForSecurityProfile in interface AWSIotpublic ListThingGroupsResult listThingGroups(ListThingGroupsRequest request)
AWSIotList the thing groups in your account.
Requires permission to access the ListThingGroups action.
listThingGroups in interface AWSIotpublic ListThingGroupsForThingResult listThingGroupsForThing(ListThingGroupsForThingRequest request)
AWSIotList the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
listThingGroupsForThing in interface AWSIotpublic ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest request)
AWSIotLists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the ListThingPrincipals action.
listThingPrincipals in interface AWSIotrequest - The input for the ListThingPrincipal operation.public ListThingRegistrationTaskReportsResult listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest request)
AWSIotInformation about the thing registration tasks.
listThingRegistrationTaskReports in interface AWSIotpublic ListThingRegistrationTasksResult listThingRegistrationTasks(ListThingRegistrationTasksRequest request)
AWSIotList bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
listThingRegistrationTasks in interface AWSIotpublic ListThingTypesResult listThingTypes(ListThingTypesRequest request)
AWSIotLists the existing thing types.
Requires permission to access the ListThingTypes action.
listThingTypes in interface AWSIotrequest - The input for the ListThingTypes operation.public ListThingsResult listThings(ListThingsRequest request)
AWSIot
Lists your things. Use the attributeName and attributeValue parameters to filter your things. For
example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in
the registry that contain an attribute Color with the value Red. For more information, see List Things from
the Amazon Web Services IoT Core Developer Guide.
Requires permission to access the ListThings action.
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.
listThings in interface AWSIotrequest - The input for the ListThings operation.public ListThingsInBillingGroupResult listThingsInBillingGroup(ListThingsInBillingGroupRequest request)
AWSIotLists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
listThingsInBillingGroup in interface AWSIotpublic ListThingsInThingGroupResult listThingsInThingGroup(ListThingsInThingGroupRequest request)
AWSIotLists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
listThingsInThingGroup in interface AWSIotpublic ListTopicRuleDestinationsResult listTopicRuleDestinations(ListTopicRuleDestinationsRequest request)
AWSIotLists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
listTopicRuleDestinations in interface AWSIotpublic ListTopicRulesResult listTopicRules(ListTopicRulesRequest request)
AWSIotLists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
listTopicRules in interface AWSIotrequest - The input for the ListTopicRules operation.public ListV2LoggingLevelsResult listV2LoggingLevels(ListV2LoggingLevelsRequest request)
AWSIotLists logging levels.
Requires permission to access the ListV2LoggingLevels action.
listV2LoggingLevels in interface AWSIotpublic ListViolationEventsResult listViolationEvents(ListViolationEventsRequest request)
AWSIotLists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).
Requires permission to access the ListViolationEvents action.
listViolationEvents in interface AWSIotpublic PutVerificationStateOnViolationResult putVerificationStateOnViolation(PutVerificationStateOnViolationRequest request)
AWSIotSet a verification state and provide a description of that verification state on a violation (detect alarm).
putVerificationStateOnViolation in interface AWSIotpublic RegisterCACertificateResult registerCACertificate(RegisterCACertificateRequest request)
AWSIot
Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates
you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same
CA subject field per Amazon Web Services account.
Requires permission to access the RegisterCACertificate action.
registerCACertificate in interface AWSIotrequest - The input to the RegisterCACertificate operation.public RegisterCertificateResult registerCertificate(RegisterCertificateRequest request)
AWSIotRegisters a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
Requires permission to access the RegisterCertificate action.
registerCertificate in interface AWSIotrequest - The input to the RegisterCertificate operation.public RegisterCertificateWithoutCAResult registerCertificateWithoutCA(RegisterCertificateWithoutCARequest request)
AWSIotRegister a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.
registerCertificateWithoutCA in interface AWSIotpublic RegisterThingResult registerThing(RegisterThingRequest request)
AWSIotProvisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.
Requires permission to access the RegisterThing action.
registerThing in interface AWSIotpublic RejectCertificateTransferResult rejectCertificateTransfer(RejectCertificateTransferRequest request)
AWSIotRejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
Requires permission to access the RejectCertificateTransfer action.
rejectCertificateTransfer in interface AWSIotrequest - The input for the RejectCertificateTransfer operation.public RemoveThingFromBillingGroupResult removeThingFromBillingGroup(RemoveThingFromBillingGroupRequest request)
AWSIotRemoves the given thing from the billing group.
Requires permission to access the RemoveThingFromBillingGroup action.
This call is asynchronous. It might take several seconds for the detachment to propagate.
removeThingFromBillingGroup in interface AWSIotpublic RemoveThingFromThingGroupResult removeThingFromThingGroup(RemoveThingFromThingGroupRequest request)
AWSIotRemove the specified thing from the specified group.
You must specify either a thingGroupArn or a thingGroupName to identify the thing group
and either a thingArn or a thingName to identify the thing to remove from the thing
group.
Requires permission to access the RemoveThingFromThingGroup action.
removeThingFromThingGroup in interface AWSIotpublic ReplaceTopicRuleResult replaceTopicRule(ReplaceTopicRuleRequest request)
AWSIotReplaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
Requires permission to access the ReplaceTopicRule action.
replaceTopicRule in interface AWSIotrequest - The input for the ReplaceTopicRule operation.public SearchIndexResult searchIndex(SearchIndexRequest request)
AWSIotThe query search index.
Requires permission to access the SearchIndex action.
searchIndex in interface AWSIotpublic SetDefaultAuthorizerResult setDefaultAuthorizer(SetDefaultAuthorizerRequest request)
AWSIotSets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
Requires permission to access the SetDefaultAuthorizer action.
setDefaultAuthorizer in interface AWSIotpublic SetDefaultPolicyVersionResult setDefaultPolicyVersion(SetDefaultPolicyVersionRequest request)
AWSIotSets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action.
Requires permission to access the SetDefaultPolicyVersion action.
setDefaultPolicyVersion in interface AWSIotrequest - The input for the SetDefaultPolicyVersion operation.public SetLoggingOptionsResult setLoggingOptions(SetLoggingOptionsRequest request)
AWSIotSets the logging options.
NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
Requires permission to access the SetLoggingOptions action.
setLoggingOptions in interface AWSIotrequest - The input for the SetLoggingOptions operation.public SetV2LoggingLevelResult setV2LoggingLevel(SetV2LoggingLevelRequest request)
AWSIotSets the logging level.
Requires permission to access the SetV2LoggingLevel action.
setV2LoggingLevel in interface AWSIotpublic SetV2LoggingOptionsResult setV2LoggingOptions(SetV2LoggingOptionsRequest request)
AWSIotSets the logging options for the V2 logging service.
Requires permission to access the SetV2LoggingOptions action.
setV2LoggingOptions in interface AWSIotpublic StartAuditMitigationActionsTaskResult startAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest request)
AWSIotStarts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
startAuditMitigationActionsTask in interface AWSIotpublic StartDetectMitigationActionsTaskResult startDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest request)
AWSIotStarts a Device Defender ML Detect mitigation actions task.
Requires permission to access the StartDetectMitigationActionsTask action.
startDetectMitigationActionsTask in interface AWSIotpublic StartOnDemandAuditTaskResult startOnDemandAuditTask(StartOnDemandAuditTaskRequest request)
AWSIotStarts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
startOnDemandAuditTask in interface AWSIotpublic StartThingRegistrationTaskResult startThingRegistrationTask(StartThingRegistrationTaskRequest request)
AWSIotCreates a bulk thing provisioning task.
Requires permission to access the StartThingRegistrationTask action.
startThingRegistrationTask in interface AWSIotpublic StopThingRegistrationTaskResult stopThingRegistrationTask(StopThingRegistrationTaskRequest request)
AWSIotCancels a bulk thing provisioning task.
Requires permission to access the StopThingRegistrationTask action.
stopThingRegistrationTask in interface AWSIotpublic TagResourceResult tagResource(TagResourceRequest request)
AWSIotAdds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
Requires permission to access the TagResource action.
tagResource in interface AWSIotpublic TestAuthorizationResult testAuthorization(TestAuthorizationRequest request)
AWSIotTests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.
Requires permission to access the TestAuthorization action.
testAuthorization in interface AWSIotpublic TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
AWSIotTests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway.
Requires permission to access the TestInvokeAuthorizer action.
testInvokeAuthorizer in interface AWSIotpublic TransferCertificateResult transferCertificate(TransferCertificateRequest request)
AWSIotTransfers the specified certificate to the specified Amazon Web Services account.
Requires permission to access the TransferCertificate action.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.
transferCertificate in interface AWSIotrequest - The input for the TransferCertificate operation.public UntagResourceResult untagResource(UntagResourceRequest request)
AWSIotRemoves the given tags (metadata) from the resource.
Requires permission to access the UntagResource action.
untagResource in interface AWSIotpublic UpdateAccountAuditConfigurationResult updateAccountAuditConfiguration(UpdateAccountAuditConfigurationRequest request)
AWSIotConfigures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the UpdateAccountAuditConfiguration action.
updateAccountAuditConfiguration in interface AWSIotpublic UpdateAuditSuppressionResult updateAuditSuppression(UpdateAuditSuppressionRequest request)
AWSIotUpdates a Device Defender audit suppression.
updateAuditSuppression in interface AWSIotpublic UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
AWSIotUpdates an authorizer.
Requires permission to access the UpdateAuthorizer action.
updateAuthorizer in interface AWSIotpublic UpdateBillingGroupResult updateBillingGroup(UpdateBillingGroupRequest request)
AWSIotUpdates information about the billing group.
Requires permission to access the UpdateBillingGroup action.
updateBillingGroup in interface AWSIotpublic UpdateCACertificateResult updateCACertificate(UpdateCACertificateRequest request)
AWSIotUpdates a registered CA certificate.
Requires permission to access the UpdateCACertificate action.
updateCACertificate in interface AWSIotrequest - The input to the UpdateCACertificate operation.public UpdateCertificateResult updateCertificate(UpdateCertificateRequest request)
AWSIotUpdates the status of the specified certificate. This operation is idempotent.
Requires permission to access the UpdateCertificate action.
Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.
Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.
updateCertificate in interface AWSIotrequest - The input for the UpdateCertificate operation.public UpdateCertificateProviderResult updateCertificateProvider(UpdateCertificateProviderRequest request)
AWSIotUpdates a certificate provider.
Requires permission to access the UpdateCertificateProvider action.
updateCertificateProvider in interface AWSIotpublic UpdateCustomMetricResult updateCustomMetric(UpdateCustomMetricRequest request)
AWSIotUpdates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
updateCustomMetric in interface AWSIotpublic UpdateDimensionResult updateDimension(UpdateDimensionRequest request)
AWSIotUpdates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).
Requires permission to access the UpdateDimension action.
updateDimension in interface AWSIotpublic UpdateDomainConfigurationResult updateDomainConfiguration(UpdateDomainConfigurationRequest request)
AWSIotUpdates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
Requires permission to access the UpdateDomainConfiguration action.
updateDomainConfiguration in interface AWSIotpublic UpdateDynamicThingGroupResult updateDynamicThingGroup(UpdateDynamicThingGroupRequest request)
AWSIotUpdates a dynamic thing group.
Requires permission to access the UpdateDynamicThingGroup action.
updateDynamicThingGroup in interface AWSIotpublic UpdateEventConfigurationsResult updateEventConfigurations(UpdateEventConfigurationsRequest request)
AWSIotUpdates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
updateEventConfigurations in interface AWSIotpublic UpdateFleetMetricResult updateFleetMetric(UpdateFleetMetricRequest request)
AWSIotUpdates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
updateFleetMetric in interface AWSIotpublic UpdateIndexingConfigurationResult updateIndexingConfiguration(UpdateIndexingConfigurationRequest request)
AWSIotUpdates the search configuration.
Requires permission to access the UpdateIndexingConfiguration action.
updateIndexingConfiguration in interface AWSIotpublic UpdateJobResult updateJob(UpdateJobRequest request)
AWSIotUpdates supported fields of the specified job.
Requires permission to access the UpdateJob action.
public UpdateMitigationActionResult updateMitigationAction(UpdateMitigationActionRequest request)
AWSIotUpdates the definition for the specified mitigation action.
Requires permission to access the UpdateMitigationAction action.
updateMitigationAction in interface AWSIotpublic UpdatePackageResult updatePackage(UpdatePackageRequest request)
AWSIotUpdates the supported fields for a specific software package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
updatePackage in interface AWSIotpublic UpdatePackageConfigurationResult updatePackageConfiguration(UpdatePackageConfigurationRequest request)
AWSIotUpdates the software package configuration.
Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
updatePackageConfiguration in interface AWSIotpublic UpdatePackageVersionResult updatePackageVersion(UpdatePackageVersionRequest request)
AWSIotUpdates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
updatePackageVersion in interface AWSIotpublic UpdateProvisioningTemplateResult updateProvisioningTemplate(UpdateProvisioningTemplateRequest request)
AWSIotUpdates a provisioning template.
Requires permission to access the UpdateProvisioningTemplate action.
updateProvisioningTemplate in interface AWSIotpublic UpdateRoleAliasResult updateRoleAlias(UpdateRoleAliasRequest request)
AWSIotUpdates a role alias.
Requires permission to access the UpdateRoleAlias action.
updateRoleAlias in interface AWSIotpublic UpdateScheduledAuditResult updateScheduledAudit(UpdateScheduledAuditRequest request)
AWSIotUpdates a scheduled audit, including which checks are performed and how often the audit takes place.
Requires permission to access the UpdateScheduledAudit action.
updateScheduledAudit in interface AWSIotpublic UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest request)
AWSIotUpdates a Device Defender security profile.
Requires permission to access the UpdateSecurityProfile action.
updateSecurityProfile in interface AWSIotpublic UpdateStreamResult updateStream(UpdateStreamRequest request)
AWSIotUpdates an existing stream. The stream version will be incremented by one.
Requires permission to access the UpdateStream action.
updateStream in interface AWSIotpublic UpdateThingResult updateThing(UpdateThingRequest request)
AWSIotUpdates the data for a thing.
Requires permission to access the UpdateThing action.
updateThing in interface AWSIotrequest - The input for the UpdateThing operation.public UpdateThingGroupResult updateThingGroup(UpdateThingGroupRequest request)
AWSIotUpdate a thing group.
Requires permission to access the UpdateThingGroup action.
updateThingGroup in interface AWSIotpublic UpdateThingGroupsForThingResult updateThingGroupsForThing(UpdateThingGroupsForThingRequest request)
AWSIotUpdates the groups to which the thing belongs.
Requires permission to access the UpdateThingGroupsForThing action.
updateThingGroupsForThing in interface AWSIotpublic UpdateTopicRuleDestinationResult updateTopicRuleDestination(UpdateTopicRuleDestinationRequest request)
AWSIotUpdates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
Requires permission to access the UpdateTopicRuleDestination action.
updateTopicRuleDestination in interface AWSIotpublic ValidateSecurityProfileBehaviorsResult validateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest request)
AWSIotValidates a Device Defender security profile behaviors specification.
Requires permission to access the ValidateSecurityProfileBehaviors action.
validateSecurityProfileBehaviors in interface AWSIotpublic void shutdown()
AWSIotpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSIotResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AWSIotrequest - The originally executed request.