@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_PREFIX
public 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 AWSIot
endpoint
- 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)
AWSIot
AWSIot.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 AWSIot
region
- 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)
AWSIot
Accepts 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 AWSIot
request
- The input for the AcceptCertificateTransfer operation.public AddThingToBillingGroupResult addThingToBillingGroup(AddThingToBillingGroupRequest request)
AWSIot
Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
addThingToBillingGroup
in interface AWSIot
public AddThingToThingGroupResult addThingToThingGroup(AddThingToThingGroupRequest request)
AWSIot
Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
addThingToThingGroup
in interface AWSIot
public AssociateTargetsWithJobResult associateTargetsWithJob(AssociateTargetsWithJobRequest request)
AWSIot
Associates 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 AWSIot
public AttachPolicyResult attachPolicy(AttachPolicyRequest request)
AWSIot
Attaches 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)
AWSIot
Attaches 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 AWSIot
request
- The input for the AttachPrincipalPolicy operation.public AttachSecurityProfileResult attachSecurityProfile(AttachSecurityProfileRequest request)
AWSIot
Associates 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 AWSIot
public AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest request)
AWSIot
Attaches 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 AWSIot
request
- The input for the AttachThingPrincipal operation.public CancelAuditMitigationActionsTaskResult cancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest request)
AWSIot
Cancels 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 AWSIot
public CancelAuditTaskResult cancelAuditTask(CancelAuditTaskRequest request)
AWSIot
Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.
Requires permission to access the CancelAuditTask action.
cancelAuditTask
in interface AWSIot
public CancelCertificateTransferResult cancelCertificateTransfer(CancelCertificateTransferRequest request)
AWSIot
Cancels 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 AWSIot
request
- The input for the CancelCertificateTransfer operation.public CancelDetectMitigationActionsTaskResult cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest request)
AWSIot
Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
cancelDetectMitigationActionsTask
in interface AWSIot
public CancelJobResult cancelJob(CancelJobRequest request)
AWSIot
Cancels a job.
Requires permission to access the CancelJob action.
public CancelJobExecutionResult cancelJobExecution(CancelJobExecutionRequest request)
AWSIot
Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
cancelJobExecution
in interface AWSIot
public ClearDefaultAuthorizerResult clearDefaultAuthorizer(ClearDefaultAuthorizerRequest request)
AWSIot
Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
clearDefaultAuthorizer
in interface AWSIot
public 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 AWSIot
public CreateAuditSuppressionResult createAuditSuppression(CreateAuditSuppressionRequest request)
AWSIot
Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
createAuditSuppression
in interface AWSIot
public CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest request)
AWSIot
Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
createAuthorizer
in interface AWSIot
public CreateBillingGroupResult createBillingGroup(CreateBillingGroupRequest request)
AWSIot
Creates a billing group.
Requires permission to access the CreateBillingGroup action.
createBillingGroup
in interface AWSIot
public CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest request)
AWSIot
Creates 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 AWSIot
request
- The input for the CreateCertificateFromCsr operation.public CreateCertificateProviderResult createCertificateProvider(CreateCertificateProviderRequest request)
AWSIot
Creates 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 AWSIot
public CreateCustomMetricResult createCustomMetric(CreateCustomMetricRequest request)
AWSIot
Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
createCustomMetric
in interface AWSIot
public 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 AWSIot
public CreateDomainConfigurationResult createDomainConfiguration(CreateDomainConfigurationRequest request)
AWSIot
Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
createDomainConfiguration
in interface AWSIot
public CreateDynamicThingGroupResult createDynamicThingGroup(CreateDynamicThingGroupRequest request)
AWSIot
Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
createDynamicThingGroup
in interface AWSIot
public CreateFleetMetricResult createFleetMetric(CreateFleetMetricRequest request)
AWSIot
Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
createFleetMetric
in interface AWSIot
public CreateJobResult createJob(CreateJobRequest request)
AWSIot
Creates a job.
Requires permission to access the CreateJob action.
public CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest request)
AWSIot
Creates a job template.
Requires permission to access the CreateJobTemplate action.
createJobTemplate
in interface AWSIot
public 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 AWSIot
request
- The input for the CreateKeysAndCertificate operation.
Requires permission to access the CreateKeysAndCertificateRequest action.
public CreateMitigationActionResult createMitigationAction(CreateMitigationActionRequest request)
AWSIot
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.
Requires permission to access the CreateMitigationAction action.
createMitigationAction
in interface AWSIot
public CreateOTAUpdateResult createOTAUpdate(CreateOTAUpdateRequest request)
AWSIot
Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
createOTAUpdate
in interface AWSIot
public CreatePackageResult createPackage(CreatePackageRequest request)
AWSIot
Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
createPackage
in interface AWSIot
public CreatePackageVersionResult createPackageVersion(CreatePackageVersionRequest request)
AWSIot
Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
createPackageVersion
in interface AWSIot
public CreatePolicyResult createPolicy(CreatePolicyRequest request)
AWSIot
Creates 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 AWSIot
request
- The input for the CreatePolicy operation.public CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest request)
AWSIot
Creates 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 AWSIot
request
- The input for the CreatePolicyVersion operation.public CreateProvisioningClaimResult createProvisioningClaim(CreateProvisioningClaimRequest request)
AWSIot
Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
createProvisioningClaim
in interface AWSIot
public CreateProvisioningTemplateResult createProvisioningTemplate(CreateProvisioningTemplateRequest request)
AWSIot
Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
createProvisioningTemplate
in interface AWSIot
public CreateProvisioningTemplateVersionResult createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest request)
AWSIot
Creates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
createProvisioningTemplateVersion
in interface AWSIot
public CreateRoleAliasResult createRoleAlias(CreateRoleAliasRequest request)
AWSIot
Creates a role alias.
Requires permission to access the CreateRoleAlias action.
createRoleAlias
in interface AWSIot
public CreateScheduledAuditResult createScheduledAudit(CreateScheduledAuditRequest request)
AWSIot
Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
createScheduledAudit
in interface AWSIot
public CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest request)
AWSIot
Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
createSecurityProfile
in interface AWSIot
public CreateStreamResult createStream(CreateStreamRequest request)
AWSIot
Creates 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 AWSIot
public 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 AWSIot
request
- The input for the CreateThing operation.public CreateThingGroupResult createThingGroup(CreateThingGroupRequest request)
AWSIot
Create 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 AWSIot
public CreateThingTypeResult createThingType(CreateThingTypeRequest request)
AWSIot
Creates a new thing type.
Requires permission to access the CreateThingType action.
createThingType
in interface AWSIot
request
- The input for the CreateThingType operation.public CreateTopicRuleResult createTopicRule(CreateTopicRuleRequest request)
AWSIot
Creates 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 AWSIot
request
- The input for the CreateTopicRule operation.public CreateTopicRuleDestinationResult createTopicRuleDestination(CreateTopicRuleDestinationRequest request)
AWSIot
Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
createTopicRuleDestination
in interface AWSIot
public DeleteAccountAuditConfigurationResult deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest request)
AWSIot
Restores 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 AWSIot
public DeleteAuditSuppressionResult deleteAuditSuppression(DeleteAuditSuppressionRequest request)
AWSIot
Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
deleteAuditSuppression
in interface AWSIot
public DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest request)
AWSIot
Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
deleteAuthorizer
in interface AWSIot
public DeleteBillingGroupResult deleteBillingGroup(DeleteBillingGroupRequest request)
AWSIot
Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
deleteBillingGroup
in interface AWSIot
public DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest request)
AWSIot
Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
deleteCACertificate
in interface AWSIot
request
- Input for the DeleteCACertificate operation.public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
AWSIot
Deletes 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 AWSIot
request
- The input for the DeleteCertificate operation.public DeleteCertificateProviderResult deleteCertificateProvider(DeleteCertificateProviderRequest request)
AWSIot
Deletes 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 AWSIot
public DeleteCustomMetricResult deleteCustomMetric(DeleteCustomMetricRequest request)
AWSIot
Deletes 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 AWSIot
public DeleteDimensionResult deleteDimension(DeleteDimensionRequest request)
AWSIot
Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
deleteDimension
in interface AWSIot
public DeleteDomainConfigurationResult deleteDomainConfiguration(DeleteDomainConfigurationRequest request)
AWSIot
Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
deleteDomainConfiguration
in interface AWSIot
public DeleteDynamicThingGroupResult deleteDynamicThingGroup(DeleteDynamicThingGroupRequest request)
AWSIot
Deletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
deleteDynamicThingGroup
in interface AWSIot
public DeleteFleetMetricResult deleteFleetMetric(DeleteFleetMetricRequest request)
AWSIot
Deletes 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 AWSIot
public DeleteJobResult deleteJob(DeleteJobRequest request)
AWSIot
Deletes 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)
AWSIot
Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
deleteJobExecution
in interface AWSIot
public DeleteJobTemplateResult deleteJobTemplate(DeleteJobTemplateRequest request)
AWSIot
Deletes the specified job template.
deleteJobTemplate
in interface AWSIot
public DeleteMitigationActionResult deleteMitigationAction(DeleteMitigationActionRequest request)
AWSIot
Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
deleteMitigationAction
in interface AWSIot
public DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest request)
AWSIot
Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
deleteOTAUpdate
in interface AWSIot
public DeletePackageResult deletePackage(DeletePackageRequest request)
AWSIot
Deletes 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 AWSIot
public DeletePackageVersionResult deletePackageVersion(DeletePackageVersionRequest request)
AWSIot
Deletes 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 AWSIot
public DeletePolicyResult deletePolicy(DeletePolicyRequest request)
AWSIot
Deletes 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 AWSIot
request
- The input for the DeletePolicy operation.public DeletePolicyVersionResult deletePolicyVersion(DeletePolicyVersionRequest request)
AWSIot
Deletes 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 AWSIot
request
- The input for the DeletePolicyVersion operation.public DeleteProvisioningTemplateResult deleteProvisioningTemplate(DeleteProvisioningTemplateRequest request)
AWSIot
Deletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
deleteProvisioningTemplate
in interface AWSIot
public DeleteProvisioningTemplateVersionResult deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest request)
AWSIot
Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
deleteProvisioningTemplateVersion
in interface AWSIot
public DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest request)
AWSIot
Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
deleteRegistrationCode
in interface AWSIot
request
- The input for the DeleteRegistrationCode operation.public DeleteRoleAliasResult deleteRoleAlias(DeleteRoleAliasRequest request)
AWSIot
Deletes a role alias
Requires permission to access the DeleteRoleAlias action.
deleteRoleAlias
in interface AWSIot
public DeleteScheduledAuditResult deleteScheduledAudit(DeleteScheduledAuditRequest request)
AWSIot
Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
deleteScheduledAudit
in interface AWSIot
public DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest request)
AWSIot
Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
deleteSecurityProfile
in interface AWSIot
public DeleteStreamResult deleteStream(DeleteStreamRequest request)
AWSIot
Deletes a stream.
Requires permission to access the DeleteStream action.
deleteStream
in interface AWSIot
public DeleteThingResult deleteThing(DeleteThingRequest request)
AWSIot
Deletes 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 AWSIot
request
- The input for the DeleteThing operation.public DeleteThingGroupResult deleteThingGroup(DeleteThingGroupRequest request)
AWSIot
Deletes a thing group.
Requires permission to access the DeleteThingGroup action.
deleteThingGroup
in interface AWSIot
public DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest request)
AWSIot
Deletes 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 AWSIot
request
- The input for the DeleteThingType operation.public DeleteTopicRuleResult deleteTopicRule(DeleteTopicRuleRequest request)
AWSIot
Deletes the rule.
Requires permission to access the DeleteTopicRule action.
deleteTopicRule
in interface AWSIot
request
- The input for the DeleteTopicRule operation.public DeleteTopicRuleDestinationResult deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest request)
AWSIot
Deletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
deleteTopicRuleDestination
in interface AWSIot
public DeleteV2LoggingLevelResult deleteV2LoggingLevel(DeleteV2LoggingLevelRequest request)
AWSIot
Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
deleteV2LoggingLevel
in interface AWSIot
public DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest request)
AWSIot
Deprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
deprecateThingType
in interface AWSIot
request
- The input for the DeprecateThingType operation.public DescribeAccountAuditConfigurationResult describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest request)
AWSIot
Gets 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 AWSIot
public DescribeAuditFindingResult describeAuditFinding(DescribeAuditFindingRequest request)
AWSIot
Gets 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 AWSIot
public DescribeAuditMitigationActionsTaskResult describeAuditMitigationActionsTask(DescribeAuditMitigationActionsTaskRequest request)
AWSIot
Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.
describeAuditMitigationActionsTask
in interface AWSIot
public DescribeAuditSuppressionResult describeAuditSuppression(DescribeAuditSuppressionRequest request)
AWSIot
Gets information about a Device Defender audit suppression.
describeAuditSuppression
in interface AWSIot
public DescribeAuditTaskResult describeAuditTask(DescribeAuditTaskRequest request)
AWSIot
Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
describeAuditTask
in interface AWSIot
public DescribeAuthorizerResult describeAuthorizer(DescribeAuthorizerRequest request)
AWSIot
Describes an authorizer.
Requires permission to access the DescribeAuthorizer action.
describeAuthorizer
in interface AWSIot
public DescribeBillingGroupResult describeBillingGroup(DescribeBillingGroupRequest request)
AWSIot
Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
describeBillingGroup
in interface AWSIot
public DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest request)
AWSIot
Describes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
describeCACertificate
in interface AWSIot
request
- The input for the DescribeCACertificate operation.public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
AWSIot
Gets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
describeCertificate
in interface AWSIot
request
- The input for the DescribeCertificate operation.public DescribeCertificateProviderResult describeCertificateProvider(DescribeCertificateProviderRequest request)
AWSIot
Describes a certificate provider.
Requires permission to access the DescribeCertificateProvider action.
describeCertificateProvider
in interface AWSIot
public DescribeCustomMetricResult describeCustomMetric(DescribeCustomMetricRequest request)
AWSIot
Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
describeCustomMetric
in interface AWSIot
public DescribeDefaultAuthorizerResult describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest request)
AWSIot
Describes the default authorizer.
Requires permission to access the DescribeDefaultAuthorizer action.
describeDefaultAuthorizer
in interface AWSIot
public DescribeDetectMitigationActionsTaskResult describeDetectMitigationActionsTask(DescribeDetectMitigationActionsTaskRequest request)
AWSIot
Gets information about a Device Defender ML Detect mitigation action.
Requires permission to access the DescribeDetectMitigationActionsTask action.
describeDetectMitigationActionsTask
in interface AWSIot
public DescribeDimensionResult describeDimension(DescribeDimensionRequest request)
AWSIot
Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
describeDimension
in interface AWSIot
public DescribeDomainConfigurationResult describeDomainConfiguration(DescribeDomainConfigurationRequest request)
AWSIot
Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
describeDomainConfiguration
in interface AWSIot
public DescribeEndpointResult describeEndpoint(DescribeEndpointRequest request)
AWSIot
Returns 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 AWSIot
request
- The input for the DescribeEndpoint operation.public DescribeEventConfigurationsResult describeEventConfigurations(DescribeEventConfigurationsRequest request)
AWSIot
Describes event configurations.
Requires permission to access the DescribeEventConfigurations action.
describeEventConfigurations
in interface AWSIot
public DescribeFleetMetricResult describeFleetMetric(DescribeFleetMetricRequest request)
AWSIot
Gets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
describeFleetMetric
in interface AWSIot
public DescribeIndexResult describeIndex(DescribeIndexRequest request)
AWSIot
Describes a search index.
Requires permission to access the DescribeIndex action.
describeIndex
in interface AWSIot
public DescribeJobResult describeJob(DescribeJobRequest request)
AWSIot
Describes a job.
Requires permission to access the DescribeJob action.
describeJob
in interface AWSIot
public DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest request)
AWSIot
Describes a job execution.
Requires permission to access the DescribeJobExecution action.
describeJobExecution
in interface AWSIot
public DescribeJobTemplateResult describeJobTemplate(DescribeJobTemplateRequest request)
AWSIot
Returns information about a job template.
describeJobTemplate
in interface AWSIot
public DescribeManagedJobTemplateResult describeManagedJobTemplate(DescribeManagedJobTemplateRequest request)
AWSIot
View details of a managed job template.
describeManagedJobTemplate
in interface AWSIot
public DescribeMitigationActionResult describeMitigationAction(DescribeMitigationActionRequest request)
AWSIot
Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
describeMitigationAction
in interface AWSIot
public DescribeProvisioningTemplateResult describeProvisioningTemplate(DescribeProvisioningTemplateRequest request)
AWSIot
Returns information about a provisioning template.
Requires permission to access the DescribeProvisioningTemplate action.
describeProvisioningTemplate
in interface AWSIot
public DescribeProvisioningTemplateVersionResult describeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest request)
AWSIot
Returns information about a provisioning template version.
Requires permission to access the DescribeProvisioningTemplateVersion action.
describeProvisioningTemplateVersion
in interface AWSIot
public DescribeRoleAliasResult describeRoleAlias(DescribeRoleAliasRequest request)
AWSIot
Describes a role alias.
Requires permission to access the DescribeRoleAlias action.
describeRoleAlias
in interface AWSIot
public DescribeScheduledAuditResult describeScheduledAudit(DescribeScheduledAuditRequest request)
AWSIot
Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
describeScheduledAudit
in interface AWSIot
public DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest request)
AWSIot
Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
describeSecurityProfile
in interface AWSIot
public DescribeStreamResult describeStream(DescribeStreamRequest request)
AWSIot
Gets information about a stream.
Requires permission to access the DescribeStream action.
describeStream
in interface AWSIot
public DescribeThingResult describeThing(DescribeThingRequest request)
AWSIot
Gets information about the specified thing.
Requires permission to access the DescribeThing action.
describeThing
in interface AWSIot
request
- The input for the DescribeThing operation.public DescribeThingGroupResult describeThingGroup(DescribeThingGroupRequest request)
AWSIot
Describe a thing group.
Requires permission to access the DescribeThingGroup action.
describeThingGroup
in interface AWSIot
public DescribeThingRegistrationTaskResult describeThingRegistrationTask(DescribeThingRegistrationTaskRequest request)
AWSIot
Describes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
describeThingRegistrationTask
in interface AWSIot
public DescribeThingTypeResult describeThingType(DescribeThingTypeRequest request)
AWSIot
Gets information about the specified thing type.
Requires permission to access the DescribeThingType action.
describeThingType
in interface AWSIot
request
- The input for the DescribeThingType operation.public DetachPolicyResult detachPolicy(DetachPolicyRequest request)
AWSIot
Detaches 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)
AWSIot
Removes 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 AWSIot
request
- The input for the DetachPrincipalPolicy operation.public DetachSecurityProfileResult detachSecurityProfile(DetachSecurityProfileRequest request)
AWSIot
Disassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
detachSecurityProfile
in interface AWSIot
public DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest request)
AWSIot
Detaches 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 AWSIot
request
- The input for the DetachThingPrincipal operation.public DisableTopicRuleResult disableTopicRule(DisableTopicRuleRequest request)
AWSIot
Disables the rule.
Requires permission to access the DisableTopicRule action.
disableTopicRule
in interface AWSIot
request
- The input for the DisableTopicRuleRequest operation.public EnableTopicRuleResult enableTopicRule(EnableTopicRuleRequest request)
AWSIot
Enables the rule.
Requires permission to access the EnableTopicRule action.
enableTopicRule
in interface AWSIot
request
- The input for the EnableTopicRuleRequest operation.public GetBehaviorModelTrainingSummariesResult getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest request)
AWSIot
Returns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
getBehaviorModelTrainingSummaries
in interface AWSIot
public GetBucketsAggregationResult getBucketsAggregation(GetBucketsAggregationRequest request)
AWSIot
Aggregates on indexed data with search queries pertaining to particular fields.
Requires permission to access the GetBucketsAggregation action.
getBucketsAggregation
in interface AWSIot
public GetCardinalityResult getCardinality(GetCardinalityRequest request)
AWSIot
Returns the approximate count of unique values that match the query.
Requires permission to access the GetCardinality action.
getCardinality
in interface AWSIot
public GetEffectivePoliciesResult getEffectivePolicies(GetEffectivePoliciesRequest request)
AWSIot
Gets 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 AWSIot
public GetIndexingConfigurationResult getIndexingConfiguration(GetIndexingConfigurationRequest request)
AWSIot
Gets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
getIndexingConfiguration
in interface AWSIot
public GetJobDocumentResult getJobDocument(GetJobDocumentRequest request)
AWSIot
Gets a job document.
Requires permission to access the GetJobDocument action.
getJobDocument
in interface AWSIot
public GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest request)
AWSIot
Gets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions
instead.
Requires permission to access the GetLoggingOptions action.
getLoggingOptions
in interface AWSIot
request
- The input for the GetLoggingOptions operation.public GetOTAUpdateResult getOTAUpdate(GetOTAUpdateRequest request)
AWSIot
Gets an OTA update.
Requires permission to access the GetOTAUpdate action.
getOTAUpdate
in interface AWSIot
public GetPackageResult getPackage(GetPackageRequest request)
AWSIot
Gets information about the specified software package.
Requires permission to access the GetPackage action.
getPackage
in interface AWSIot
public GetPackageConfigurationResult getPackageConfiguration(GetPackageConfigurationRequest request)
AWSIot
Gets information about the specified software package's configuration.
Requires permission to access the GetPackageConfiguration action.
getPackageConfiguration
in interface AWSIot
public GetPackageVersionResult getPackageVersion(GetPackageVersionRequest request)
AWSIot
Gets information about the specified package version.
Requires permission to access the GetPackageVersion action.
getPackageVersion
in interface AWSIot
public 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 AWSIot
public GetPolicyResult getPolicy(GetPolicyRequest request)
AWSIot
Gets 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)
AWSIot
Gets information about the specified policy version.
Requires permission to access the GetPolicyVersion action.
getPolicyVersion
in interface AWSIot
request
- The input for the GetPolicyVersion operation.public GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest request)
AWSIot
Gets 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 AWSIot
request
- 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 AWSIot
public GetTopicRuleResult getTopicRule(GetTopicRuleRequest request)
AWSIot
Gets information about the rule.
Requires permission to access the GetTopicRule action.
getTopicRule
in interface AWSIot
request
- The input for the GetTopicRule operation.public GetTopicRuleDestinationResult getTopicRuleDestination(GetTopicRuleDestinationRequest request)
AWSIot
Gets information about a topic rule destination.
Requires permission to access the GetTopicRuleDestination action.
getTopicRuleDestination
in interface AWSIot
public GetV2LoggingOptionsResult getV2LoggingOptions(GetV2LoggingOptionsRequest request)
AWSIot
Gets the fine grained logging options.
Requires permission to access the GetV2LoggingOptions action.
getV2LoggingOptions
in interface AWSIot
public ListActiveViolationsResult listActiveViolations(ListActiveViolationsRequest request)
AWSIot
Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
listActiveViolations
in interface AWSIot
public ListAttachedPoliciesResult listAttachedPolicies(ListAttachedPoliciesRequest request)
AWSIot
Lists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
listAttachedPolicies
in interface AWSIot
public ListAuditFindingsResult listAuditFindings(ListAuditFindingsRequest request)
AWSIot
Lists 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 AWSIot
public ListAuditMitigationActionsExecutionsResult listAuditMitigationActionsExecutions(ListAuditMitigationActionsExecutionsRequest request)
AWSIot
Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
listAuditMitigationActionsExecutions
in interface AWSIot
public ListAuditMitigationActionsTasksResult listAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest request)
AWSIot
Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
listAuditMitigationActionsTasks
in interface AWSIot
public ListAuditSuppressionsResult listAuditSuppressions(ListAuditSuppressionsRequest request)
AWSIot
Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
listAuditSuppressions
in interface AWSIot
public ListAuditTasksResult listAuditTasks(ListAuditTasksRequest request)
AWSIot
Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
listAuditTasks
in interface AWSIot
public ListAuthorizersResult listAuthorizers(ListAuthorizersRequest request)
AWSIot
Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
listAuthorizers
in interface AWSIot
public ListBillingGroupsResult listBillingGroups(ListBillingGroupsRequest request)
AWSIot
Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
listBillingGroups
in interface AWSIot
public ListCACertificatesResult listCACertificates(ListCACertificatesRequest request)
AWSIot
Lists 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 AWSIot
request
- Input for the ListCACertificates operation.public ListCertificateProvidersResult listCertificateProviders(ListCertificateProvidersRequest request)
AWSIot
Lists all your certificate providers in your Amazon Web Services account.
Requires permission to access the ListCertificateProviders action.
listCertificateProviders
in interface AWSIot
public ListCertificatesResult listCertificates(ListCertificatesRequest request)
AWSIot
Lists 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 AWSIot
request
- The input for the ListCertificates operation.public ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest request)
AWSIot
List the device certificates signed by the specified CA certificate.
Requires permission to access the ListCertificatesByCA action.
listCertificatesByCA
in interface AWSIot
request
- The input to the ListCertificatesByCA operation.public ListCustomMetricsResult listCustomMetrics(ListCustomMetricsRequest request)
AWSIot
Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
listCustomMetrics
in interface AWSIot
public ListDetectMitigationActionsExecutionsResult listDetectMitigationActionsExecutions(ListDetectMitigationActionsExecutionsRequest request)
AWSIot
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
listDetectMitigationActionsExecutions
in interface AWSIot
public ListDetectMitigationActionsTasksResult listDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest request)
AWSIot
List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
listDetectMitigationActionsTasks
in interface AWSIot
public ListDimensionsResult listDimensions(ListDimensionsRequest request)
AWSIot
List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
listDimensions
in interface AWSIot
public ListDomainConfigurationsResult listDomainConfigurations(ListDomainConfigurationsRequest request)
AWSIot
Gets 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 AWSIot
public ListFleetMetricsResult listFleetMetrics(ListFleetMetricsRequest request)
AWSIot
Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
listFleetMetrics
in interface AWSIot
public ListIndicesResult listIndices(ListIndicesRequest request)
AWSIot
Lists the search indices.
Requires permission to access the ListIndices action.
listIndices
in interface AWSIot
public ListJobExecutionsForJobResult listJobExecutionsForJob(ListJobExecutionsForJobRequest request)
AWSIot
Lists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
listJobExecutionsForJob
in interface AWSIot
public ListJobExecutionsForThingResult listJobExecutionsForThing(ListJobExecutionsForThingRequest request)
AWSIot
Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
listJobExecutionsForThing
in interface AWSIot
public ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest request)
AWSIot
Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
listJobTemplates
in interface AWSIot
public ListJobsResult listJobs(ListJobsRequest request)
AWSIot
Lists jobs.
Requires permission to access the ListJobs action.
public ListManagedJobTemplatesResult listManagedJobTemplates(ListManagedJobTemplatesRequest request)
AWSIot
Returns a list of managed job templates.
listManagedJobTemplates
in interface AWSIot
public ListMetricValuesResult listMetricValues(ListMetricValuesRequest request)
AWSIot
Lists 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 AWSIot
public ListMitigationActionsResult listMitigationActions(ListMitigationActionsRequest request)
AWSIot
Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
listMitigationActions
in interface AWSIot
public ListOTAUpdatesResult listOTAUpdates(ListOTAUpdatesRequest request)
AWSIot
Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
listOTAUpdates
in interface AWSIot
public ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest request)
AWSIot
Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
listOutgoingCertificates
in interface AWSIot
request
- The input to the ListOutgoingCertificates operation.public ListPackageVersionsResult listPackageVersions(ListPackageVersionsRequest request)
AWSIot
Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
listPackageVersions
in interface AWSIot
public ListPackagesResult listPackages(ListPackagesRequest request)
AWSIot
Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
listPackages
in interface AWSIot
public ListPoliciesResult listPolicies(ListPoliciesRequest request)
AWSIot
Lists your policies.
Requires permission to access the ListPolicies action.
listPolicies
in interface AWSIot
request
- The input for the ListPolicies operation.@Deprecated public ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest request)
AWSIot
Lists 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 AWSIot
request
- The input for the ListPolicyPrincipals operation.public ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest request)
AWSIot
Lists the versions of the specified policy and identifies the default version.
Requires permission to access the ListPolicyVersions action.
listPolicyVersions
in interface AWSIot
request
- The input for the ListPolicyVersions operation.@Deprecated public ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest request)
AWSIot
Lists 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 AWSIot
request
- The input for the ListPrincipalPolicies operation.public ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest request)
AWSIot
Lists 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 AWSIot
request
- The input for the ListPrincipalThings operation.public ListProvisioningTemplateVersionsResult listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest request)
AWSIot
A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
listProvisioningTemplateVersions
in interface AWSIot
public ListProvisioningTemplatesResult listProvisioningTemplates(ListProvisioningTemplatesRequest request)
AWSIot
Lists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
listProvisioningTemplates
in interface AWSIot
public ListRelatedResourcesForAuditFindingResult listRelatedResourcesForAuditFinding(ListRelatedResourcesForAuditFindingRequest request)
AWSIot
The 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 AWSIot
public ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest request)
AWSIot
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
listRoleAliases
in interface AWSIot
public ListScheduledAuditsResult listScheduledAudits(ListScheduledAuditsRequest request)
AWSIot
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
listScheduledAudits
in interface AWSIot
public ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest request)
AWSIot
Lists 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 AWSIot
public ListSecurityProfilesForTargetResult listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest request)
AWSIot
Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
listSecurityProfilesForTarget
in interface AWSIot
public ListStreamsResult listStreams(ListStreamsRequest request)
AWSIot
Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
listStreams
in interface AWSIot
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSIot
Lists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
listTagsForResource
in interface AWSIot
public ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest request)
AWSIot
List targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
listTargetsForPolicy
in interface AWSIot
public ListTargetsForSecurityProfileResult listTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest request)
AWSIot
Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
listTargetsForSecurityProfile
in interface AWSIot
public ListThingGroupsResult listThingGroups(ListThingGroupsRequest request)
AWSIot
List the thing groups in your account.
Requires permission to access the ListThingGroups action.
listThingGroups
in interface AWSIot
public ListThingGroupsForThingResult listThingGroupsForThing(ListThingGroupsForThingRequest request)
AWSIot
List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
listThingGroupsForThing
in interface AWSIot
public ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest request)
AWSIot
Lists 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 AWSIot
request
- The input for the ListThingPrincipal operation.public ListThingRegistrationTaskReportsResult listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest request)
AWSIot
Information about the thing registration tasks.
listThingRegistrationTaskReports
in interface AWSIot
public ListThingRegistrationTasksResult listThingRegistrationTasks(ListThingRegistrationTasksRequest request)
AWSIot
List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
listThingRegistrationTasks
in interface AWSIot
public ListThingTypesResult listThingTypes(ListThingTypesRequest request)
AWSIot
Lists the existing thing types.
Requires permission to access the ListThingTypes action.
listThingTypes
in interface AWSIot
request
- 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 AWSIot
request
- The input for the ListThings operation.public ListThingsInBillingGroupResult listThingsInBillingGroup(ListThingsInBillingGroupRequest request)
AWSIot
Lists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
listThingsInBillingGroup
in interface AWSIot
public ListThingsInThingGroupResult listThingsInThingGroup(ListThingsInThingGroupRequest request)
AWSIot
Lists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
listThingsInThingGroup
in interface AWSIot
public ListTopicRuleDestinationsResult listTopicRuleDestinations(ListTopicRuleDestinationsRequest request)
AWSIot
Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
listTopicRuleDestinations
in interface AWSIot
public ListTopicRulesResult listTopicRules(ListTopicRulesRequest request)
AWSIot
Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
listTopicRules
in interface AWSIot
request
- The input for the ListTopicRules operation.public ListV2LoggingLevelsResult listV2LoggingLevels(ListV2LoggingLevelsRequest request)
AWSIot
Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.
listV2LoggingLevels
in interface AWSIot
public ListViolationEventsResult listViolationEvents(ListViolationEventsRequest request)
AWSIot
Lists 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 AWSIot
public PutVerificationStateOnViolationResult putVerificationStateOnViolation(PutVerificationStateOnViolationRequest request)
AWSIot
Set a verification state and provide a description of that verification state on a violation (detect alarm).
putVerificationStateOnViolation
in interface AWSIot
public 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 AWSIot
request
- The input to the RegisterCACertificate operation.public RegisterCertificateResult registerCertificate(RegisterCertificateRequest request)
AWSIot
Registers 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 AWSIot
request
- The input to the RegisterCertificate operation.public RegisterCertificateWithoutCAResult registerCertificateWithoutCA(RegisterCertificateWithoutCARequest request)
AWSIot
Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.
registerCertificateWithoutCA
in interface AWSIot
public RegisterThingResult registerThing(RegisterThingRequest request)
AWSIot
Provisions 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 AWSIot
public RejectCertificateTransferResult rejectCertificateTransfer(RejectCertificateTransferRequest request)
AWSIot
Rejects 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 AWSIot
request
- The input for the RejectCertificateTransfer operation.public RemoveThingFromBillingGroupResult removeThingFromBillingGroup(RemoveThingFromBillingGroupRequest request)
AWSIot
Removes the given thing from the billing group.
Requires permission to access the RemoveThingFromBillingGroup action.
This call is asynchronous. It might take several seconds for the detachment to propagate.
removeThingFromBillingGroup
in interface AWSIot
public RemoveThingFromThingGroupResult removeThingFromThingGroup(RemoveThingFromThingGroupRequest request)
AWSIot
Remove 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 AWSIot
public ReplaceTopicRuleResult replaceTopicRule(ReplaceTopicRuleRequest request)
AWSIot
Replaces 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 AWSIot
request
- The input for the ReplaceTopicRule operation.public SearchIndexResult searchIndex(SearchIndexRequest request)
AWSIot
The query search index.
Requires permission to access the SearchIndex action.
searchIndex
in interface AWSIot
public SetDefaultAuthorizerResult setDefaultAuthorizer(SetDefaultAuthorizerRequest request)
AWSIot
Sets 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 AWSIot
public SetDefaultPolicyVersionResult setDefaultPolicyVersion(SetDefaultPolicyVersionRequest request)
AWSIot
Sets 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 AWSIot
request
- The input for the SetDefaultPolicyVersion operation.public SetLoggingOptionsResult setLoggingOptions(SetLoggingOptionsRequest request)
AWSIot
Sets the logging options.
NOTE: use of this command is not recommended. Use SetV2LoggingOptions
instead.
Requires permission to access the SetLoggingOptions action.
setLoggingOptions
in interface AWSIot
request
- The input for the SetLoggingOptions operation.public SetV2LoggingLevelResult setV2LoggingLevel(SetV2LoggingLevelRequest request)
AWSIot
Sets the logging level.
Requires permission to access the SetV2LoggingLevel action.
setV2LoggingLevel
in interface AWSIot
public SetV2LoggingOptionsResult setV2LoggingOptions(SetV2LoggingOptionsRequest request)
AWSIot
Sets the logging options for the V2 logging service.
Requires permission to access the SetV2LoggingOptions action.
setV2LoggingOptions
in interface AWSIot
public StartAuditMitigationActionsTaskResult startAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest request)
AWSIot
Starts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
startAuditMitigationActionsTask
in interface AWSIot
public StartDetectMitigationActionsTaskResult startDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest request)
AWSIot
Starts a Device Defender ML Detect mitigation actions task.
Requires permission to access the StartDetectMitigationActionsTask action.
startDetectMitigationActionsTask
in interface AWSIot
public StartOnDemandAuditTaskResult startOnDemandAuditTask(StartOnDemandAuditTaskRequest request)
AWSIot
Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
startOnDemandAuditTask
in interface AWSIot
public StartThingRegistrationTaskResult startThingRegistrationTask(StartThingRegistrationTaskRequest request)
AWSIot
Creates a bulk thing provisioning task.
Requires permission to access the StartThingRegistrationTask action.
startThingRegistrationTask
in interface AWSIot
public StopThingRegistrationTaskResult stopThingRegistrationTask(StopThingRegistrationTaskRequest request)
AWSIot
Cancels a bulk thing provisioning task.
Requires permission to access the StopThingRegistrationTask action.
stopThingRegistrationTask
in interface AWSIot
public TagResourceResult tagResource(TagResourceRequest request)
AWSIot
Adds 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 AWSIot
public TestAuthorizationResult testAuthorization(TestAuthorizationRequest request)
AWSIot
Tests 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 AWSIot
public TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest request)
AWSIot
Tests 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 AWSIot
public TransferCertificateResult transferCertificate(TransferCertificateRequest request)
AWSIot
Transfers 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 AWSIot
request
- The input for the TransferCertificate operation.public UntagResourceResult untagResource(UntagResourceRequest request)
AWSIot
Removes the given tags (metadata) from the resource.
Requires permission to access the UntagResource action.
untagResource
in interface AWSIot
public UpdateAccountAuditConfigurationResult updateAccountAuditConfiguration(UpdateAccountAuditConfigurationRequest request)
AWSIot
Configures 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 AWSIot
public UpdateAuditSuppressionResult updateAuditSuppression(UpdateAuditSuppressionRequest request)
AWSIot
Updates a Device Defender audit suppression.
updateAuditSuppression
in interface AWSIot
public UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest request)
AWSIot
Updates an authorizer.
Requires permission to access the UpdateAuthorizer action.
updateAuthorizer
in interface AWSIot
public UpdateBillingGroupResult updateBillingGroup(UpdateBillingGroupRequest request)
AWSIot
Updates information about the billing group.
Requires permission to access the UpdateBillingGroup action.
updateBillingGroup
in interface AWSIot
public UpdateCACertificateResult updateCACertificate(UpdateCACertificateRequest request)
AWSIot
Updates a registered CA certificate.
Requires permission to access the UpdateCACertificate action.
updateCACertificate
in interface AWSIot
request
- The input to the UpdateCACertificate operation.public UpdateCertificateResult updateCertificate(UpdateCertificateRequest request)
AWSIot
Updates 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 AWSIot
request
- The input for the UpdateCertificate operation.public UpdateCertificateProviderResult updateCertificateProvider(UpdateCertificateProviderRequest request)
AWSIot
Updates a certificate provider.
Requires permission to access the UpdateCertificateProvider action.
updateCertificateProvider
in interface AWSIot
public UpdateCustomMetricResult updateCustomMetric(UpdateCustomMetricRequest request)
AWSIot
Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
updateCustomMetric
in interface AWSIot
public UpdateDimensionResult updateDimension(UpdateDimensionRequest request)
AWSIot
Updates 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 AWSIot
public UpdateDomainConfigurationResult updateDomainConfiguration(UpdateDomainConfigurationRequest request)
AWSIot
Updates 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 AWSIot
public UpdateDynamicThingGroupResult updateDynamicThingGroup(UpdateDynamicThingGroupRequest request)
AWSIot
Updates a dynamic thing group.
Requires permission to access the UpdateDynamicThingGroup action.
updateDynamicThingGroup
in interface AWSIot
public UpdateEventConfigurationsResult updateEventConfigurations(UpdateEventConfigurationsRequest request)
AWSIot
Updates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
updateEventConfigurations
in interface AWSIot
public UpdateFleetMetricResult updateFleetMetric(UpdateFleetMetricRequest request)
AWSIot
Updates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
updateFleetMetric
in interface AWSIot
public UpdateIndexingConfigurationResult updateIndexingConfiguration(UpdateIndexingConfigurationRequest request)
AWSIot
Updates the search configuration.
Requires permission to access the UpdateIndexingConfiguration action.
updateIndexingConfiguration
in interface AWSIot
public UpdateJobResult updateJob(UpdateJobRequest request)
AWSIot
Updates supported fields of the specified job.
Requires permission to access the UpdateJob action.
public UpdateMitigationActionResult updateMitigationAction(UpdateMitigationActionRequest request)
AWSIot
Updates the definition for the specified mitigation action.
Requires permission to access the UpdateMitigationAction action.
updateMitigationAction
in interface AWSIot
public UpdatePackageResult updatePackage(UpdatePackageRequest request)
AWSIot
Updates the supported fields for a specific software package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
updatePackage
in interface AWSIot
public UpdatePackageConfigurationResult updatePackageConfiguration(UpdatePackageConfigurationRequest request)
AWSIot
Updates the software package configuration.
Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
updatePackageConfiguration
in interface AWSIot
public UpdatePackageVersionResult updatePackageVersion(UpdatePackageVersionRequest request)
AWSIot
Updates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
updatePackageVersion
in interface AWSIot
public UpdateProvisioningTemplateResult updateProvisioningTemplate(UpdateProvisioningTemplateRequest request)
AWSIot
Updates a provisioning template.
Requires permission to access the UpdateProvisioningTemplate action.
updateProvisioningTemplate
in interface AWSIot
public UpdateRoleAliasResult updateRoleAlias(UpdateRoleAliasRequest request)
AWSIot
Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
updateRoleAlias
in interface AWSIot
public UpdateScheduledAuditResult updateScheduledAudit(UpdateScheduledAuditRequest request)
AWSIot
Updates 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 AWSIot
public UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest request)
AWSIot
Updates a Device Defender security profile.
Requires permission to access the UpdateSecurityProfile action.
updateSecurityProfile
in interface AWSIot
public UpdateStreamResult updateStream(UpdateStreamRequest request)
AWSIot
Updates an existing stream. The stream version will be incremented by one.
Requires permission to access the UpdateStream action.
updateStream
in interface AWSIot
public UpdateThingResult updateThing(UpdateThingRequest request)
AWSIot
Updates the data for a thing.
Requires permission to access the UpdateThing action.
updateThing
in interface AWSIot
request
- The input for the UpdateThing operation.public UpdateThingGroupResult updateThingGroup(UpdateThingGroupRequest request)
AWSIot
Update a thing group.
Requires permission to access the UpdateThingGroup action.
updateThingGroup
in interface AWSIot
public UpdateThingGroupsForThingResult updateThingGroupsForThing(UpdateThingGroupsForThingRequest request)
AWSIot
Updates the groups to which the thing belongs.
Requires permission to access the UpdateThingGroupsForThing action.
updateThingGroupsForThing
in interface AWSIot
public UpdateTopicRuleDestinationResult updateTopicRuleDestination(UpdateTopicRuleDestinationRequest request)
AWSIot
Updates 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 AWSIot
public ValidateSecurityProfileBehaviorsResult validateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest request)
AWSIot
Validates a Device Defender security profile behaviors specification.
Requires permission to access the ValidateSecurityProfileBehaviors action.
validateSecurityProfileBehaviors
in interface AWSIot
public void shutdown()
AWSIot
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSIot
Response 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 AWSIot
request
- The originally executed request.