public interface AWSIot
AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.
The service endpoints that expose this API are listed in AWS IoT Core Endpoints and Quotas. You must use the endpoint for the region that has the resources you want to access.
The service name used by AWS Signature Version 4 to sign the request is: execute-api.
For more information about how AWS IoT works, see the Developer Guide.
For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.
Modifier and Type | Method and Description |
---|---|
void |
acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest)
Accepts a pending certificate transfer.
|
AddThingToBillingGroupResult |
addThingToBillingGroup(AddThingToBillingGroupRequest addThingToBillingGroupRequest)
Adds a thing to a billing group.
|
AddThingToThingGroupResult |
addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest)
Adds a thing to a thing group.
|
AssociateTargetsWithJobResult |
associateTargetsWithJob(AssociateTargetsWithJobRequest associateTargetsWithJobRequest)
Associates a group with a continuous job.
|
void |
attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches a policy to the specified target.
|
void |
attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest)
Deprecated.
|
AttachSecurityProfileResult |
attachSecurityProfile(AttachSecurityProfileRequest attachSecurityProfileRequest)
Associates a Device Defender security profile with a thing group or this
account.
|
AttachThingPrincipalResult |
attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest)
Attaches the specified principal to the specified thing.
|
CancelAuditMitigationActionsTaskResult |
cancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest cancelAuditMitigationActionsTaskRequest)
Cancels a mitigation action task that is in progress.
|
CancelAuditTaskResult |
cancelAuditTask(CancelAuditTaskRequest cancelAuditTaskRequest)
Cancels an audit that is in progress.
|
void |
cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest)
Cancels a pending transfer for the specified certificate.
|
CancelDetectMitigationActionsTaskResult |
cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest)
Cancels a Device Defender ML Detect mitigation action.
|
CancelJobResult |
cancelJob(CancelJobRequest cancelJobRequest)
Cancels a job.
|
void |
cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest)
Cancels the execution of a job for a given thing.
|
ClearDefaultAuthorizerResult |
clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest)
Clears the default authorizer.
|
ConfirmTopicRuleDestinationResult |
confirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest)
Confirms a topic rule destination.
|
CreateAuditSuppressionResult |
createAuditSuppression(CreateAuditSuppressionRequest createAuditSuppressionRequest)
Creates a Device Defender audit suppression.
|
CreateAuthorizerResult |
createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Creates an authorizer.
|
CreateBillingGroupResult |
createBillingGroup(CreateBillingGroupRequest createBillingGroupRequest)
Creates a billing group.
|
CreateCertificateFromCsrResult |
createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest)
Creates an X.509 certificate using the specified certificate signing
request.
|
CreateCustomMetricResult |
createCustomMetric(CreateCustomMetricRequest createCustomMetricRequest)
Use this API to define a Custom Metric published by your devices to
Device Defender.
|
CreateDimensionResult |
createDimension(CreateDimensionRequest createDimensionRequest)
Create a dimension that you can use to limit the scope of a metric used
in a security profile for AWS IoT Device Defender.
|
CreateDomainConfigurationResult |
createDomainConfiguration(CreateDomainConfigurationRequest createDomainConfigurationRequest)
Creates a domain configuration.
|
CreateDynamicThingGroupResult |
createDynamicThingGroup(CreateDynamicThingGroupRequest createDynamicThingGroupRequest)
Creates a dynamic thing group.
|
CreateJobResult |
createJob(CreateJobRequest createJobRequest)
Creates a job.
|
CreateKeysAndCertificateResult |
createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest)
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the
issued public key.
|
CreateMitigationActionResult |
createMitigationAction(CreateMitigationActionRequest createMitigationActionRequest)
Defines an action that can be applied to audit findings by using
StartAuditMitigationActionsTask.
|
CreateOTAUpdateResult |
createOTAUpdate(CreateOTAUpdateRequest createOTAUpdateRequest)
Creates an AWS IoT OTAUpdate on a target group of things or groups.
|
CreatePolicyResult |
createPolicy(CreatePolicyRequest createPolicyRequest)
Creates an AWS IoT policy.
|
CreatePolicyVersionResult |
createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified AWS IoT policy.
|
CreateProvisioningClaimResult |
createProvisioningClaim(CreateProvisioningClaimRequest createProvisioningClaimRequest)
Creates a provisioning claim.
|
CreateProvisioningTemplateResult |
createProvisioningTemplate(CreateProvisioningTemplateRequest createProvisioningTemplateRequest)
Creates a fleet provisioning template.
|
CreateProvisioningTemplateVersionResult |
createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest)
Creates a new version of a fleet provisioning template.
|
CreateRoleAliasResult |
createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest)
Creates a role alias.
|
CreateScheduledAuditResult |
createScheduledAudit(CreateScheduledAuditRequest createScheduledAuditRequest)
Creates a scheduled audit that is run at a specified time interval.
|
CreateSecurityProfileResult |
createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)
Creates a Device Defender security profile.
|
CreateStreamResult |
createStream(CreateStreamRequest createStreamRequest)
Creates a stream for delivering one or more large files in chunks over
MQTT.
|
CreateThingResult |
createThing(CreateThingRequest createThingRequest)
Creates a thing record in the registry.
|
CreateThingGroupResult |
createThingGroup(CreateThingGroupRequest createThingGroupRequest)
Create a thing group.
|
CreateThingTypeResult |
createThingType(CreateThingTypeRequest createThingTypeRequest)
Creates a new thing type.
|
void |
createTopicRule(CreateTopicRuleRequest createTopicRuleRequest)
Creates a rule.
|
CreateTopicRuleDestinationResult |
createTopicRuleDestination(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest)
Creates a topic rule destination.
|
DeleteAccountAuditConfigurationResult |
deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest deleteAccountAuditConfigurationRequest)
Restores the default settings for Device Defender audits for this
account.
|
DeleteAuditSuppressionResult |
deleteAuditSuppression(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest)
Deletes a Device Defender audit suppression.
|
DeleteAuthorizerResult |
deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an authorizer.
|
DeleteBillingGroupResult |
deleteBillingGroup(DeleteBillingGroupRequest deleteBillingGroupRequest)
Deletes the billing group.
|
DeleteCACertificateResult |
deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest)
Deletes a registered CA certificate.
|
void |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the specified certificate.
|
DeleteCustomMetricResult |
deleteCustomMetric(DeleteCustomMetricRequest deleteCustomMetricRequest)
|
DeleteDimensionResult |
deleteDimension(DeleteDimensionRequest deleteDimensionRequest)
Removes the specified dimension from your AWS account.
|
DeleteDomainConfigurationResult |
deleteDomainConfiguration(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest)
Deletes the specified domain configuration.
|
DeleteDynamicThingGroupResult |
deleteDynamicThingGroup(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest)
Deletes a dynamic thing group.
|
void |
deleteJob(DeleteJobRequest deleteJobRequest)
Deletes a job and its related job executions.
|
void |
deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest)
Deletes a job execution.
|
DeleteMitigationActionResult |
deleteMitigationAction(DeleteMitigationActionRequest deleteMitigationActionRequest)
Deletes a defined mitigation action from your AWS account.
|
DeleteOTAUpdateResult |
deleteOTAUpdate(DeleteOTAUpdateRequest deleteOTAUpdateRequest)
Delete an OTA update.
|
void |
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified policy.
|
void |
deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version of the specified policy.
|
DeleteProvisioningTemplateResult |
deleteProvisioningTemplate(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest)
Deletes a fleet provisioning template.
|
DeleteProvisioningTemplateVersionResult |
deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest)
Deletes a fleet provisioning template version.
|
DeleteRegistrationCodeResult |
deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest)
Deletes a CA certificate registration code.
|
DeleteRoleAliasResult |
deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest)
Deletes a role alias
|
DeleteScheduledAuditResult |
deleteScheduledAudit(DeleteScheduledAuditRequest deleteScheduledAuditRequest)
Deletes a scheduled audit.
|
DeleteSecurityProfileResult |
deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
Deletes a Device Defender security profile.
|
DeleteStreamResult |
deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a stream.
|
DeleteThingResult |
deleteThing(DeleteThingRequest deleteThingRequest)
Deletes the specified thing.
|
DeleteThingGroupResult |
deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest)
Deletes a thing group.
|
DeleteThingTypeResult |
deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest)
Deletes the specified thing type.
|
void |
deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest)
Deletes the rule.
|
DeleteTopicRuleDestinationResult |
deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest)
Deletes a topic rule destination.
|
void |
deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest)
Deletes a logging level.
|
DeprecateThingTypeResult |
deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest)
Deprecates a thing type.
|
DescribeAccountAuditConfigurationResult |
describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest)
Gets information about the Device Defender audit settings for this
account.
|
DescribeAuditFindingResult |
describeAuditFinding(DescribeAuditFindingRequest describeAuditFindingRequest)
Gets information about a single audit finding.
|
DescribeAuditMitigationActionsTaskResult |
describeAuditMitigationActionsTask(DescribeAuditMitigationActionsTaskRequest describeAuditMitigationActionsTaskRequest)
Gets information about an audit mitigation task that is used to apply
mitigation actions to a set of audit findings.
|
DescribeAuditSuppressionResult |
describeAuditSuppression(DescribeAuditSuppressionRequest describeAuditSuppressionRequest)
Gets information about a Device Defender audit suppression.
|
DescribeAuditTaskResult |
describeAuditTask(DescribeAuditTaskRequest describeAuditTaskRequest)
Gets information about a Device Defender audit.
|
DescribeAuthorizerResult |
describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest)
Describes an authorizer.
|
DescribeBillingGroupResult |
describeBillingGroup(DescribeBillingGroupRequest describeBillingGroupRequest)
Returns information about a billing group.
|
DescribeCACertificateResult |
describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest)
Describes a registered CA certificate.
|
DescribeCertificateResult |
describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Gets information about the specified certificate.
|
DescribeCustomMetricResult |
describeCustomMetric(DescribeCustomMetricRequest describeCustomMetricRequest)
Gets information about a Device Defender detect custom metric.
|
DescribeDefaultAuthorizerResult |
describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest)
Describes the default authorizer.
|
DescribeDetectMitigationActionsTaskResult |
describeDetectMitigationActionsTask(DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest)
Gets information about a Device Defender ML Detect mitigation action.
|
DescribeDimensionResult |
describeDimension(DescribeDimensionRequest describeDimensionRequest)
Provides details about a dimension that is defined in your AWS account.
|
DescribeDomainConfigurationResult |
describeDomainConfiguration(DescribeDomainConfigurationRequest describeDomainConfigurationRequest)
Gets summary information about a domain configuration.
|
DescribeEndpointResult |
describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
Returns a unique endpoint specific to the AWS account making the call.
|
DescribeEventConfigurationsResult |
describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest)
Describes event configurations.
|
DescribeIndexResult |
describeIndex(DescribeIndexRequest describeIndexRequest)
Describes a search index.
|
DescribeJobResult |
describeJob(DescribeJobRequest describeJobRequest)
Describes a job.
|
DescribeJobExecutionResult |
describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest)
Describes a job execution.
|
DescribeMitigationActionResult |
describeMitigationAction(DescribeMitigationActionRequest describeMitigationActionRequest)
Gets information about a mitigation action.
|
DescribeProvisioningTemplateResult |
describeProvisioningTemplate(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest)
Returns information about a fleet provisioning template.
|
DescribeProvisioningTemplateVersionResult |
describeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest)
Returns information about a fleet provisioning template version.
|
DescribeRoleAliasResult |
describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest)
Describes a role alias.
|
DescribeScheduledAuditResult |
describeScheduledAudit(DescribeScheduledAuditRequest describeScheduledAuditRequest)
Gets information about a scheduled audit.
|
DescribeSecurityProfileResult |
describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest)
Gets information about a Device Defender security profile.
|
DescribeStreamResult |
describeStream(DescribeStreamRequest describeStreamRequest)
Gets information about a stream.
|
DescribeThingResult |
describeThing(DescribeThingRequest describeThingRequest)
Gets information about the specified thing.
|
DescribeThingGroupResult |
describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest)
Describe a thing group.
|
DescribeThingRegistrationTaskResult |
describeThingRegistrationTask(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest)
Describes a bulk thing provisioning task.
|
DescribeThingTypeResult |
describeThingType(DescribeThingTypeRequest describeThingTypeRequest)
Gets information about the specified thing type.
|
void |
detachPolicy(DetachPolicyRequest detachPolicyRequest)
Detaches a policy from the specified target.
|
void |
detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest)
Deprecated.
|
DetachSecurityProfileResult |
detachSecurityProfile(DetachSecurityProfileRequest detachSecurityProfileRequest)
Disassociates a Device Defender security profile from a thing group or
from this account.
|
DetachThingPrincipalResult |
detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest)
Detaches the specified principal from the specified thing.
|
void |
disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest)
Disables the rule.
|
void |
enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest)
Enables the rule.
|
GetBehaviorModelTrainingSummariesResult |
getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest)
Returns a Device Defender's ML Detect Security Profile training model's
status.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
GetCardinalityResult |
getCardinality(GetCardinalityRequest getCardinalityRequest)
Returns the approximate count of unique values that match the query.
|
GetEffectivePoliciesResult |
getEffectivePolicies(GetEffectivePoliciesRequest getEffectivePoliciesRequest)
Gets a list of the policies that have an effect on the authorization
behavior of the specified device when it connects to the AWS IoT device
gateway.
|
GetIndexingConfigurationResult |
getIndexingConfiguration(GetIndexingConfigurationRequest getIndexingConfigurationRequest)
Gets the indexing configuration.
|
GetJobDocumentResult |
getJobDocument(GetJobDocumentRequest getJobDocumentRequest)
Gets a job document.
|
GetLoggingOptionsResult |
getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest)
Gets the logging options.
|
GetOTAUpdateResult |
getOTAUpdate(GetOTAUpdateRequest getOTAUpdateRequest)
Gets an OTA update.
|
GetPercentilesResult |
getPercentiles(GetPercentilesRequest getPercentilesRequest)
Groups the aggregated values that match the query into percentile
groupings.
|
GetPolicyResult |
getPolicy(GetPolicyRequest getPolicyRequest)
Gets information about the specified policy with the policy document of
the default version.
|
GetPolicyVersionResult |
getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)
Gets information about the specified policy version.
|
GetRegistrationCodeResult |
getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest)
Gets a registration code used to register a CA certificate with AWS IoT.
|
GetStatisticsResult |
getStatistics(GetStatisticsRequest getStatisticsRequest)
Returns the count, average, sum, minimum, maximum, sum of squares,
variance, and standard deviation for the specified aggregated field.
|
GetTopicRuleResult |
getTopicRule(GetTopicRuleRequest getTopicRuleRequest)
Gets information about the rule.
|
GetTopicRuleDestinationResult |
getTopicRuleDestination(GetTopicRuleDestinationRequest getTopicRuleDestinationRequest)
Gets information about a topic rule destination.
|
GetV2LoggingOptionsResult |
getV2LoggingOptions(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest)
Gets the fine grained logging options.
|
ListActiveViolationsResult |
listActiveViolations(ListActiveViolationsRequest listActiveViolationsRequest)
Lists the active violations for a given Device Defender security profile.
|
ListAttachedPoliciesResult |
listAttachedPolicies(ListAttachedPoliciesRequest listAttachedPoliciesRequest)
Lists the policies attached to the specified thing group.
|
ListAuditFindingsResult |
listAuditFindings(ListAuditFindingsRequest listAuditFindingsRequest)
Lists the findings (results) of a Device Defender audit or of the audits
performed during a specified time period.
|
ListAuditMitigationActionsExecutionsResult |
listAuditMitigationActionsExecutions(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest)
Gets the status of audit mitigation action tasks that were executed.
|
ListAuditMitigationActionsTasksResult |
listAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest)
Gets a list of audit mitigation action tasks that match the specified
filters.
|
ListAuditSuppressionsResult |
listAuditSuppressions(ListAuditSuppressionsRequest listAuditSuppressionsRequest)
Lists your Device Defender audit listings.
|
ListAuditTasksResult |
listAuditTasks(ListAuditTasksRequest listAuditTasksRequest)
Lists the Device Defender audits that have been performed during a given
time period.
|
ListAuthorizersResult |
listAuthorizers(ListAuthorizersRequest listAuthorizersRequest)
Lists the authorizers registered in your account.
|
ListBillingGroupsResult |
listBillingGroups(ListBillingGroupsRequest listBillingGroupsRequest)
Lists the billing groups you have created.
|
ListCACertificatesResult |
listCACertificates(ListCACertificatesRequest listCACertificatesRequest)
Lists the CA certificates registered for your AWS account.
|
ListCertificatesResult |
listCertificates(ListCertificatesRequest listCertificatesRequest)
Lists the certificates registered in your AWS account.
|
ListCertificatesByCAResult |
listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest)
List the device certificates signed by the specified CA certificate.
|
ListCustomMetricsResult |
listCustomMetrics(ListCustomMetricsRequest listCustomMetricsRequest)
Lists your Device Defender detect custom metrics.
|
ListDetectMitigationActionsExecutionsResult |
listDetectMitigationActionsExecutions(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest)
Lists mitigation actions executions for a Device Defender ML Detect
Security Profile.
|
ListDetectMitigationActionsTasksResult |
listDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest)
List of Device Defender ML Detect mitigation actions tasks.
|
ListDimensionsResult |
listDimensions(ListDimensionsRequest listDimensionsRequest)
List the set of dimensions that are defined for your AWS account.
|
ListDomainConfigurationsResult |
listDomainConfigurations(ListDomainConfigurationsRequest listDomainConfigurationsRequest)
Gets a list of domain configurations for the user.
|
ListIndicesResult |
listIndices(ListIndicesRequest listIndicesRequest)
Lists the search indices.
|
ListJobExecutionsForJobResult |
listJobExecutionsForJob(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest)
Lists the job executions for a job.
|
ListJobExecutionsForThingResult |
listJobExecutionsForThing(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest)
Lists the job executions for the specified thing.
|
ListJobsResult |
listJobs(ListJobsRequest listJobsRequest)
Lists jobs.
|
ListMitigationActionsResult |
listMitigationActions(ListMitigationActionsRequest listMitigationActionsRequest)
Gets a list of all mitigation actions that match the specified filter
criteria.
|
ListOTAUpdatesResult |
listOTAUpdates(ListOTAUpdatesRequest listOTAUpdatesRequest)
Lists OTA updates.
|
ListOutgoingCertificatesResult |
listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest)
Lists certificates that are being transferred but not yet accepted.
|
ListPoliciesResult |
listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists your policies.
|
ListPolicyPrincipalsResult |
listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest)
Deprecated.
|
ListPolicyVersionsResult |
listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists the versions of the specified policy and identifies the default
version.
|
ListPrincipalPoliciesResult |
listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest)
Deprecated.
|
ListPrincipalThingsResult |
listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest)
Lists the things associated with the specified principal.
|
ListProvisioningTemplatesResult |
listProvisioningTemplates(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest)
Lists the fleet provisioning templates in your AWS account.
|
ListProvisioningTemplateVersionsResult |
listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest)
A list of fleet provisioning template versions.
|
ListRoleAliasesResult |
listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest)
Lists the role aliases registered in your account.
|
ListScheduledAuditsResult |
listScheduledAudits(ListScheduledAuditsRequest listScheduledAuditsRequest)
Lists all of your scheduled audits.
|
ListSecurityProfilesResult |
listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest)
Lists the Device Defender security profiles you've created.
|
ListSecurityProfilesForTargetResult |
listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest)
Lists the Device Defender security profiles attached to a target (thing
group).
|
ListStreamsResult |
listStreams(ListStreamsRequest listStreamsRequest)
Lists all of the streams in your AWS account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags (metadata) you have assigned to the resource.
|
ListTargetsForPolicyResult |
listTargetsForPolicy(ListTargetsForPolicyRequest listTargetsForPolicyRequest)
List targets for the specified policy.
|
ListTargetsForSecurityProfileResult |
listTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest)
Lists the targets (thing groups) associated with a given Device Defender
security profile.
|
ListThingGroupsResult |
listThingGroups(ListThingGroupsRequest listThingGroupsRequest)
List the thing groups in your account.
|
ListThingGroupsForThingResult |
listThingGroupsForThing(ListThingGroupsForThingRequest listThingGroupsForThingRequest)
List the thing groups to which the specified thing belongs.
|
ListThingPrincipalsResult |
listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest)
Lists the principals associated with the specified thing.
|
ListThingRegistrationTaskReportsResult |
listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest)
Information about the thing registration tasks.
|
ListThingRegistrationTasksResult |
listThingRegistrationTasks(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest)
List bulk thing provisioning tasks.
|
ListThingsResult |
listThings(ListThingsRequest listThingsRequest)
Lists your things.
|
ListThingsInBillingGroupResult |
listThingsInBillingGroup(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest)
Lists the things you have added to the given billing group.
|
ListThingsInThingGroupResult |
listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest)
Lists the things in the specified group.
|
ListThingTypesResult |
listThingTypes(ListThingTypesRequest listThingTypesRequest)
Lists the existing thing types.
|
ListTopicRuleDestinationsResult |
listTopicRuleDestinations(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest)
Lists all the topic rule destinations in your AWS account.
|
ListTopicRulesResult |
listTopicRules(ListTopicRulesRequest listTopicRulesRequest)
Lists the rules for the specific topic.
|
ListV2LoggingLevelsResult |
listV2LoggingLevels(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest)
Lists logging levels.
|
ListViolationEventsResult |
listViolationEvents(ListViolationEventsRequest listViolationEventsRequest)
Lists the Device Defender security profile violations discovered during
the given time period.
|
RegisterCACertificateResult |
registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest)
Registers a CA certificate with AWS IoT.
|
RegisterCertificateResult |
registerCertificate(RegisterCertificateRequest registerCertificateRequest)
Registers a device certificate with AWS IoT.
|
RegisterCertificateWithoutCAResult |
registerCertificateWithoutCA(RegisterCertificateWithoutCARequest registerCertificateWithoutCARequest)
Register a certificate that does not have a certificate authority (CA).
|
RegisterThingResult |
registerThing(RegisterThingRequest registerThingRequest)
Provisions a thing in the device registry.
|
void |
rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest)
Rejects a pending certificate transfer.
|
RemoveThingFromBillingGroupResult |
removeThingFromBillingGroup(RemoveThingFromBillingGroupRequest removeThingFromBillingGroupRequest)
Removes the given thing from the billing group.
|
RemoveThingFromThingGroupResult |
removeThingFromThingGroup(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest)
Remove the specified thing from the specified group.
|
void |
replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest)
Replaces the rule.
|
SearchIndexResult |
searchIndex(SearchIndexRequest searchIndexRequest)
The query search index.
|
SetDefaultAuthorizerResult |
setDefaultAuthorizer(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest)
Sets the default authorizer.
|
void |
setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's
default (operative) version.
|
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client
("https://iot.us-east-1.amazonaws.com").
|
void |
setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest)
Sets the logging options.
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the regional
endpoint for this client's service calls. |
void |
setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest)
Sets the logging level.
|
void |
setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest)
Sets the logging options for the V2 logging service.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartAuditMitigationActionsTaskResult |
startAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest startAuditMitigationActionsTaskRequest)
Starts a task that applies a set of mitigation actions to the specified
target.
|
StartDetectMitigationActionsTaskResult |
startDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest startDetectMitigationActionsTaskRequest)
Starts a Device Defender ML Detect mitigation actions task.
|
StartOnDemandAuditTaskResult |
startOnDemandAuditTask(StartOnDemandAuditTaskRequest startOnDemandAuditTaskRequest)
Starts an on-demand Device Defender audit.
|
StartThingRegistrationTaskResult |
startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest)
Creates a bulk thing provisioning task.
|
StopThingRegistrationTaskResult |
stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest)
Cancels a bulk thing provisioning task.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource.
|
TestAuthorizationResult |
testAuthorization(TestAuthorizationRequest testAuthorizationRequest)
Tests if a specified principal is authorized to perform an AWS IoT action
on a specified resource.
|
TestInvokeAuthorizerResult |
testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Tests a custom authorization behavior by invoking a specified custom
authorizer.
|
TransferCertificateResult |
transferCertificate(TransferCertificateRequest transferCertificateRequest)
Transfers the specified certificate to the specified AWS account.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the given tags (metadata) from the resource.
|
UpdateAccountAuditConfigurationResult |
updateAccountAuditConfiguration(UpdateAccountAuditConfigurationRequest updateAccountAuditConfigurationRequest)
Configures or reconfigures the Device Defender audit settings for this
account.
|
UpdateAuditSuppressionResult |
updateAuditSuppression(UpdateAuditSuppressionRequest updateAuditSuppressionRequest)
Updates a Device Defender audit suppression.
|
UpdateAuthorizerResult |
updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an authorizer.
|
UpdateBillingGroupResult |
updateBillingGroup(UpdateBillingGroupRequest updateBillingGroupRequest)
Updates information about the billing group.
|
void |
updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest)
Updates a registered CA certificate.
|
void |
updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the status of the specified certificate.
|
UpdateCustomMetricResult |
updateCustomMetric(UpdateCustomMetricRequest updateCustomMetricRequest)
Updates a Device Defender detect custom metric.
|
UpdateDimensionResult |
updateDimension(UpdateDimensionRequest updateDimensionRequest)
Updates the definition for a dimension.
|
UpdateDomainConfigurationResult |
updateDomainConfiguration(UpdateDomainConfigurationRequest updateDomainConfigurationRequest)
Updates values stored in the domain configuration.
|
UpdateDynamicThingGroupResult |
updateDynamicThingGroup(UpdateDynamicThingGroupRequest updateDynamicThingGroupRequest)
Updates a dynamic thing group.
|
UpdateEventConfigurationsResult |
updateEventConfigurations(UpdateEventConfigurationsRequest updateEventConfigurationsRequest)
Updates the event configurations.
|
UpdateIndexingConfigurationResult |
updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest)
Updates the search configuration.
|
void |
updateJob(UpdateJobRequest updateJobRequest)
Updates supported fields of the specified job.
|
UpdateMitigationActionResult |
updateMitigationAction(UpdateMitigationActionRequest updateMitigationActionRequest)
Updates the definition for the specified mitigation action.
|
UpdateProvisioningTemplateResult |
updateProvisioningTemplate(UpdateProvisioningTemplateRequest updateProvisioningTemplateRequest)
Updates a fleet provisioning template.
|
UpdateRoleAliasResult |
updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest)
Updates a role alias.
|
UpdateScheduledAuditResult |
updateScheduledAudit(UpdateScheduledAuditRequest updateScheduledAuditRequest)
Updates a scheduled audit, including which checks are performed and how
often the audit takes place.
|
UpdateSecurityProfileResult |
updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest)
Updates a Device Defender security profile.
|
UpdateStreamResult |
updateStream(UpdateStreamRequest updateStreamRequest)
Updates an existing stream.
|
UpdateThingResult |
updateThing(UpdateThingRequest updateThingRequest)
Updates the data for a thing.
|
UpdateThingGroupResult |
updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest)
Update a thing group.
|
UpdateThingGroupsForThingResult |
updateThingGroupsForThing(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest)
Updates the groups to which the thing belongs.
|
UpdateTopicRuleDestinationResult |
updateTopicRuleDestination(UpdateTopicRuleDestinationRequest updateTopicRuleDestinationRequest)
Updates a topic rule destination.
|
ValidateSecurityProfileBehaviorsResult |
validateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest validateSecurityProfileBehaviorsRequest)
Validates a Device Defender security profile behaviors specification.
|
void setEndpoint(java.lang.String endpoint) throws java.lang.IllegalArgumentException
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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
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.
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.java.lang.IllegalArgumentException
- If any problems are detected with the
specified endpoint.void setRegion(Region region) throws java.lang.IllegalArgumentException
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.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.java.lang.IllegalArgumentException
- If the given region is null,
or if this service isn't available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
void acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest) throws AmazonClientException, AmazonServiceException
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.
acceptCertificateTransferRequest
- The input for the AcceptCertificateTransfer operation.
ResourceNotFoundException
TransferAlreadyCompletedException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.AddThingToBillingGroupResult addThingToBillingGroup(AddThingToBillingGroupRequest addThingToBillingGroupRequest) throws AmazonClientException, AmazonServiceException
Adds a thing to a billing group.
addThingToBillingGroupRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.AddThingToThingGroupResult addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest) throws AmazonClientException, AmazonServiceException
Adds a thing to a thing group.
addThingToThingGroupRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.AssociateTargetsWithJobResult associateTargetsWithJob(AssociateTargetsWithJobRequest associateTargetsWithJobRequest) throws AmazonClientException, AmazonServiceException
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.
associateTargetsWithJobRequest
- InvalidRequestException
ResourceNotFoundException
LimitExceededException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void attachPolicy(AttachPolicyRequest attachPolicyRequest) throws AmazonClientException, AmazonServiceException
Attaches a policy to the specified target.
attachPolicyRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.@Deprecated void attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest) throws AmazonClientException, AmazonServiceException
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This API is deprecated. Please use AttachPolicy instead.
attachPrincipalPolicyRequest
- The input for the AttachPrincipalPolicy operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.AttachSecurityProfileResult attachSecurityProfile(AttachSecurityProfileRequest attachSecurityProfileRequest) throws AmazonClientException, AmazonServiceException
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.
attachSecurityProfileRequest
- InvalidRequestException
ResourceNotFoundException
LimitExceededException
VersionConflictException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest) throws AmazonClientException, AmazonServiceException
Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
attachThingPrincipalRequest
- The input for the AttachThingPrincipal operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CancelAuditMitigationActionsTaskResult cancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest cancelAuditMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException
Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
cancelAuditMitigationActionsTaskRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CancelAuditTaskResult cancelAuditTask(CancelAuditTaskRequest cancelAuditTaskRequest) throws AmazonClientException, AmazonServiceException
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.
cancelAuditTaskRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest) throws AmazonClientException, AmazonServiceException
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, AWS 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.
cancelCertificateTransferRequest
- The input for the CancelCertificateTransfer operation.
ResourceNotFoundException
TransferAlreadyCompletedException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CancelDetectMitigationActionsTaskResult cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException
Cancels a Device Defender ML Detect mitigation action.
cancelDetectMitigationActionsTaskRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CancelJobResult cancelJob(CancelJobRequest cancelJobRequest) throws AmazonClientException, AmazonServiceException
Cancels a job.
cancelJobRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest) throws AmazonClientException, AmazonServiceException
Cancels the execution of a job for a given thing.
cancelJobExecutionRequest
- InvalidRequestException
InvalidStateTransitionException
ResourceNotFoundException
ThrottlingException
ServiceUnavailableException
VersionConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ClearDefaultAuthorizerResult clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Clears the default authorizer.
clearDefaultAuthorizerRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ConfirmTopicRuleDestinationResult confirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest) throws AmazonClientException, AmazonServiceException
Confirms a topic rule destination. When you create a rule requiring a
destination, AWS 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.
confirmTopicRuleDestinationRequest
- InternalException
InvalidRequestException
ServiceUnavailableException
UnauthorizedException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateAuditSuppressionResult createAuditSuppression(CreateAuditSuppressionRequest createAuditSuppressionRequest) throws AmazonClientException, AmazonServiceException
Creates a Device Defender audit suppression.
createAuditSuppressionRequest
- InvalidRequestException
ResourceAlreadyExistsException
ThrottlingException
InternalFailureException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Creates an authorizer.
createAuthorizerRequest
- ResourceAlreadyExistsException
InvalidRequestException
LimitExceededException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateBillingGroupResult createBillingGroup(CreateBillingGroupRequest createBillingGroupRequest) throws AmazonClientException, AmazonServiceException
Creates a billing group.
createBillingGroupRequest
- InvalidRequestException
ResourceAlreadyExistsException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest) throws AmazonClientException, AmazonServiceException
Creates an X.509 certificate using the specified certificate signing request.
Note: 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 or NIST P-384 curves.
Note: 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.
Assuming 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 AWS CLI command to create a certificate for the corresponding CSR.
The aws iot create-certificate-from-csr part of the command can also be run 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"
createCertificateFromCsrRequest
- The input for the CreateCertificateFromCsr operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateCustomMetricResult createCustomMetric(CreateCustomMetricRequest createCustomMetricRequest) throws AmazonClientException, AmazonServiceException
Use this API to define a Custom Metric published by your devices to Device Defender.
createCustomMetricRequest
- InvalidRequestException
LimitExceededException
ResourceAlreadyExistsException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateDimensionResult createDimension(CreateDimensionRequest createDimensionRequest) throws AmazonClientException, AmazonServiceException
Create a dimension that you can use to limit the scope of a metric used
in a security profile for AWS IoT Device Defender. For example, using a
TOPIC_FILTER
dimension, you can narrow down the scope of the
metric only to MQTT topics whose name match the pattern specified in the
dimension.
createDimensionRequest
- InternalFailureException
InvalidRequestException
LimitExceededException
ResourceAlreadyExistsException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateDomainConfigurationResult createDomainConfiguration(CreateDomainConfigurationRequest createDomainConfigurationRequest) throws AmazonClientException, AmazonServiceException
Creates a domain configuration.
The domain configuration feature is in public preview and is subject to change.
createDomainConfigurationRequest
- LimitExceededException
CertificateValidationException
ResourceAlreadyExistsException
ServiceUnavailableException
InternalFailureException
InvalidRequestException
UnauthorizedException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateDynamicThingGroupResult createDynamicThingGroup(CreateDynamicThingGroupRequest createDynamicThingGroupRequest) throws AmazonClientException, AmazonServiceException
Creates a dynamic thing group.
createDynamicThingGroupRequest
- InvalidRequestException
ResourceAlreadyExistsException
ResourceNotFoundException
ThrottlingException
InternalFailureException
InvalidQueryException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateJobResult createJob(CreateJobRequest createJobRequest) throws AmazonClientException, AmazonServiceException
Creates a job.
createJobRequest
- InvalidRequestException
ResourceNotFoundException
ResourceAlreadyExistsException
LimitExceededException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest) throws AmazonClientException, AmazonServiceException
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 AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
createKeysAndCertificateRequest
- The input for the CreateKeysAndCertificate operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateMitigationActionResult createMitigationAction(CreateMitigationActionRequest createMitigationActionRequest) throws AmazonClientException, AmazonServiceException
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.
createMitigationActionRequest
- InvalidRequestException
ResourceAlreadyExistsException
LimitExceededException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateOTAUpdateResult createOTAUpdate(CreateOTAUpdateRequest createOTAUpdateRequest) throws AmazonClientException, AmazonServiceException
Creates an AWS IoT OTAUpdate on a target group of things or groups.
createOTAUpdateRequest
- InvalidRequestException
LimitExceededException
ResourceNotFoundException
ResourceAlreadyExistsException
ThrottlingException
UnauthorizedException
InternalFailureException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreatePolicyResult createPolicy(CreatePolicyRequest createPolicyRequest) throws AmazonClientException, AmazonServiceException
Creates an AWS 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.
createPolicyRequest
- The input for the CreatePolicy operation.
ResourceAlreadyExistsException
MalformedPolicyException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) throws AmazonClientException, AmazonServiceException
Creates a new version of the specified AWS 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).
createPolicyVersionRequest
- The input for the CreatePolicyVersion operation.
ResourceNotFoundException
MalformedPolicyException
VersionsLimitExceededException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateProvisioningClaimResult createProvisioningClaim(CreateProvisioningClaimRequest createProvisioningClaimRequest) throws AmazonClientException, AmazonServiceException
Creates a provisioning claim.
createProvisioningClaimRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateProvisioningTemplateResult createProvisioningTemplate(CreateProvisioningTemplateRequest createProvisioningTemplateRequest) throws AmazonClientException, AmazonServiceException
Creates a fleet provisioning template.
createProvisioningTemplateRequest
- InternalFailureException
InvalidRequestException
LimitExceededException
ThrottlingException
UnauthorizedException
ResourceAlreadyExistsException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateProvisioningTemplateVersionResult createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest) throws AmazonClientException, AmazonServiceException
Creates a new version of a fleet provisioning template.
createProvisioningTemplateVersionRequest
- VersionsLimitExceededException
InternalFailureException
InvalidRequestException
ThrottlingException
ResourceNotFoundException
UnauthorizedException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateRoleAliasResult createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest) throws AmazonClientException, AmazonServiceException
Creates a role alias.
createRoleAliasRequest
- ResourceAlreadyExistsException
InvalidRequestException
LimitExceededException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateScheduledAuditResult createScheduledAudit(CreateScheduledAuditRequest createScheduledAuditRequest) throws AmazonClientException, AmazonServiceException
Creates a scheduled audit that is run at a specified time interval.
createScheduledAuditRequest
- InvalidRequestException
ResourceAlreadyExistsException
ThrottlingException
InternalFailureException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest) throws AmazonClientException, AmazonServiceException
Creates a Device Defender security profile.
createSecurityProfileRequest
- InvalidRequestException
ResourceAlreadyExistsException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateStreamResult createStream(CreateStreamRequest createStreamRequest) throws AmazonClientException, AmazonServiceException
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.
createStreamRequest
- InvalidRequestException
LimitExceededException
ResourceNotFoundException
ResourceAlreadyExistsException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateThingResult createThing(CreateThingRequest createThingRequest) throws AmazonClientException, AmazonServiceException
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.
createThingRequest
- The input for the CreateThing operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceAlreadyExistsException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateThingGroupResult createThingGroup(CreateThingGroupRequest createThingGroupRequest) throws AmazonClientException, AmazonServiceException
Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
createThingGroupRequest
- InvalidRequestException
ResourceAlreadyExistsException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateThingTypeResult createThingType(CreateThingTypeRequest createThingTypeRequest) throws AmazonClientException, AmazonServiceException
Creates a new thing type.
createThingTypeRequest
- The input for the CreateThingType operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceAlreadyExistsException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) throws AmazonClientException, AmazonServiceException
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.
createTopicRuleRequest
- The input for the CreateTopicRule operation.
SqlParseException
InternalException
InvalidRequestException
ResourceAlreadyExistsException
ServiceUnavailableException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.CreateTopicRuleDestinationResult createTopicRuleDestination(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest) throws AmazonClientException, AmazonServiceException
Creates a topic rule destination. The destination must be confirmed prior to use.
createTopicRuleDestinationRequest
- InternalException
InvalidRequestException
ResourceAlreadyExistsException
ServiceUnavailableException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteAccountAuditConfigurationResult deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest deleteAccountAuditConfigurationRequest) throws AmazonClientException, AmazonServiceException
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.
deleteAccountAuditConfigurationRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteAuditSuppressionResult deleteAuditSuppression(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest) throws AmazonClientException, AmazonServiceException
Deletes a Device Defender audit suppression.
deleteAuditSuppressionRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Deletes an authorizer.
deleteAuthorizerRequest
- DeleteConflictException
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteBillingGroupResult deleteBillingGroup(DeleteBillingGroupRequest deleteBillingGroupRequest) throws AmazonClientException, AmazonServiceException
Deletes the billing group.
deleteBillingGroupRequest
- InvalidRequestException
VersionConflictException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest) throws AmazonClientException, AmazonServiceException
Deletes a registered CA certificate.
deleteCACertificateRequest
- Input for the DeleteCACertificate operation.
InvalidRequestException
CertificateStateException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws AmazonClientException, AmazonServiceException
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 DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
deleteCertificateRequest
- The input for the DeleteCertificate operation.
CertificateStateException
DeleteConflictException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteCustomMetricResult deleteCustomMetric(DeleteCustomMetricRequest deleteCustomMetricRequest) throws AmazonClientException, AmazonServiceException
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.
Deletes a Device Defender detect custom metric.
deleteCustomMetricRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteDimensionResult deleteDimension(DeleteDimensionRequest deleteDimensionRequest) throws AmazonClientException, AmazonServiceException
Removes the specified dimension from your AWS account.
deleteDimensionRequest
- InternalFailureException
InvalidRequestException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteDomainConfigurationResult deleteDomainConfiguration(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified domain configuration.
The domain configuration feature is in public preview and is subject to change.
deleteDomainConfigurationRequest
- ResourceNotFoundException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
InvalidRequestException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteDynamicThingGroupResult deleteDynamicThingGroup(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest) throws AmazonClientException, AmazonServiceException
Deletes a dynamic thing group.
deleteDynamicThingGroupRequest
- InvalidRequestException
VersionConflictException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deleteJob(DeleteJobRequest deleteJobRequest) throws AmazonClientException, AmazonServiceException
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.
deleteJobRequest
- InvalidRequestException
InvalidStateTransitionException
ResourceNotFoundException
LimitExceededException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest) throws AmazonClientException, AmazonServiceException
Deletes a job execution.
deleteJobExecutionRequest
- InvalidRequestException
InvalidStateTransitionException
ResourceNotFoundException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteMitigationActionResult deleteMitigationAction(DeleteMitigationActionRequest deleteMitigationActionRequest) throws AmazonClientException, AmazonServiceException
Deletes a defined mitigation action from your AWS account.
deleteMitigationActionRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest deleteOTAUpdateRequest) throws AmazonClientException, AmazonServiceException
Delete an OTA update.
deleteOTAUpdateRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
UnauthorizedException
InternalFailureException
ServiceUnavailableException
VersionConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deletePolicy(DeletePolicyRequest deletePolicyRequest) throws AmazonClientException, AmazonServiceException
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 API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
deletePolicyRequest
- The input for the DeletePolicy operation.
DeleteConflictException
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
deletePolicyVersionRequest
- The input for the DeletePolicyVersion operation.
DeleteConflictException
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteProvisioningTemplateResult deleteProvisioningTemplate(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest) throws AmazonClientException, AmazonServiceException
Deletes a fleet provisioning template.
deleteProvisioningTemplateRequest
- InternalFailureException
InvalidRequestException
ResourceNotFoundException
DeleteConflictException
ThrottlingException
ConflictingResourceUpdateException
UnauthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteProvisioningTemplateVersionResult deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest) throws AmazonClientException, AmazonServiceException
Deletes a fleet provisioning template version.
deleteProvisioningTemplateVersionRequest
- InternalFailureException
InvalidRequestException
ThrottlingException
ResourceNotFoundException
UnauthorizedException
ConflictingResourceUpdateException
DeleteConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) throws AmazonClientException, AmazonServiceException
Deletes a CA certificate registration code.
deleteRegistrationCodeRequest
- The input for the DeleteRegistrationCode operation.
ThrottlingException
ResourceNotFoundException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteRoleAliasResult deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest) throws AmazonClientException, AmazonServiceException
Deletes a role alias
deleteRoleAliasRequest
- DeleteConflictException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteScheduledAuditResult deleteScheduledAudit(DeleteScheduledAuditRequest deleteScheduledAuditRequest) throws AmazonClientException, AmazonServiceException
Deletes a scheduled audit.
deleteScheduledAuditRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest) throws AmazonClientException, AmazonServiceException
Deletes a Device Defender security profile.
deleteSecurityProfileRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
VersionConflictException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest) throws AmazonClientException, AmazonServiceException
Deletes a stream.
deleteStreamRequest
- ResourceNotFoundException
DeleteConflictException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteThingResult deleteThing(DeleteThingRequest deleteThingRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
deleteThingRequest
- The input for the DeleteThing operation.
ResourceNotFoundException
VersionConflictException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteThingGroupResult deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest) throws AmazonClientException, AmazonServiceException
Deletes a thing group.
deleteThingGroupRequest
- InvalidRequestException
VersionConflictException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest) throws AmazonClientException, AmazonServiceException
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.
deleteThingTypeRequest
- The input for the DeleteThingType operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) throws AmazonClientException, AmazonServiceException
Deletes the rule.
deleteTopicRuleRequest
- The input for the DeleteTopicRule operation.
InternalException
InvalidRequestException
ServiceUnavailableException
UnauthorizedException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeleteTopicRuleDestinationResult deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest) throws AmazonClientException, AmazonServiceException
Deletes a topic rule destination.
deleteTopicRuleDestinationRequest
- InternalException
InvalidRequestException
ServiceUnavailableException
UnauthorizedException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest) throws AmazonClientException, AmazonServiceException
Deletes a logging level.
deleteV2LoggingLevelRequest
- InternalException
InvalidRequestException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest) throws AmazonClientException, AmazonServiceException
Deprecates a thing type. You can not associate new things with deprecated thing type.
deprecateThingTypeRequest
- The input for the DeprecateThingType operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeAccountAuditConfigurationResult describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest) throws AmazonClientException, AmazonServiceException
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.
describeAccountAuditConfigurationRequest
- ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeAuditFindingResult describeAuditFinding(DescribeAuditFindingRequest describeAuditFindingRequest) throws AmazonClientException, AmazonServiceException
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.
describeAuditFindingRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeAuditMitigationActionsTaskResult describeAuditMitigationActionsTask(DescribeAuditMitigationActionsTaskRequest describeAuditMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException
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.
describeAuditMitigationActionsTaskRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeAuditSuppressionResult describeAuditSuppression(DescribeAuditSuppressionRequest describeAuditSuppressionRequest) throws AmazonClientException, AmazonServiceException
Gets information about a Device Defender audit suppression.
describeAuditSuppressionRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeAuditTaskResult describeAuditTask(DescribeAuditTaskRequest describeAuditTaskRequest) throws AmazonClientException, AmazonServiceException
Gets information about a Device Defender audit.
describeAuditTaskRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeAuthorizerResult describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Describes an authorizer.
describeAuthorizerRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeBillingGroupResult describeBillingGroup(DescribeBillingGroupRequest describeBillingGroupRequest) throws AmazonClientException, AmazonServiceException
Returns information about a billing group.
describeBillingGroupRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest) throws AmazonClientException, AmazonServiceException
Describes a registered CA certificate.
describeCACertificateRequest
- The input for the DescribeCACertificate operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws AmazonClientException, AmazonServiceException
Gets information about the specified certificate.
describeCertificateRequest
- The input for the DescribeCertificate operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeCustomMetricResult describeCustomMetric(DescribeCustomMetricRequest describeCustomMetricRequest) throws AmazonClientException, AmazonServiceException
Gets information about a Device Defender detect custom metric.
describeCustomMetricRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeDefaultAuthorizerResult describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Describes the default authorizer.
describeDefaultAuthorizerRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeDetectMitigationActionsTaskResult describeDetectMitigationActionsTask(DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException
Gets information about a Device Defender ML Detect mitigation action.
describeDetectMitigationActionsTaskRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeDimensionResult describeDimension(DescribeDimensionRequest describeDimensionRequest) throws AmazonClientException, AmazonServiceException
Provides details about a dimension that is defined in your AWS account.
describeDimensionRequest
- InternalFailureException
InvalidRequestException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeDomainConfigurationResult describeDomainConfiguration(DescribeDomainConfigurationRequest describeDomainConfigurationRequest) throws AmazonClientException, AmazonServiceException
Gets summary information about a domain configuration.
The domain configuration feature is in public preview and is subject to change.
describeDomainConfigurationRequest
- ResourceNotFoundException
ThrottlingException
InvalidRequestException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws AmazonClientException, AmazonServiceException
Returns a unique endpoint specific to the AWS account making the call.
describeEndpointRequest
- The input for the DescribeEndpoint operation.
InternalFailureException
InvalidRequestException
UnauthorizedException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeEventConfigurationsResult describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest) throws AmazonClientException, AmazonServiceException
Describes event configurations.
describeEventConfigurationsRequest
- InternalFailureException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest) throws AmazonClientException, AmazonServiceException
Describes a search index.
describeIndexRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeJobResult describeJob(DescribeJobRequest describeJobRequest) throws AmazonClientException, AmazonServiceException
Describes a job.
describeJobRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest) throws AmazonClientException, AmazonServiceException
Describes a job execution.
describeJobExecutionRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeMitigationActionResult describeMitigationAction(DescribeMitigationActionRequest describeMitigationActionRequest) throws AmazonClientException, AmazonServiceException
Gets information about a mitigation action.
describeMitigationActionRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeProvisioningTemplateResult describeProvisioningTemplate(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest) throws AmazonClientException, AmazonServiceException
Returns information about a fleet provisioning template.
describeProvisioningTemplateRequest
- InternalFailureException
InvalidRequestException
ResourceNotFoundException
ThrottlingException
UnauthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeProvisioningTemplateVersionResult describeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest) throws AmazonClientException, AmazonServiceException
Returns information about a fleet provisioning template version.
describeProvisioningTemplateVersionRequest
- InternalFailureException
InvalidRequestException
ThrottlingException
ResourceNotFoundException
UnauthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeRoleAliasResult describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest) throws AmazonClientException, AmazonServiceException
Describes a role alias.
describeRoleAliasRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeScheduledAuditResult describeScheduledAudit(DescribeScheduledAuditRequest describeScheduledAuditRequest) throws AmazonClientException, AmazonServiceException
Gets information about a scheduled audit.
describeScheduledAuditRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest) throws AmazonClientException, AmazonServiceException
Gets information about a Device Defender security profile.
describeSecurityProfileRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest) throws AmazonClientException, AmazonServiceException
Gets information about a stream.
describeStreamRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeThingResult describeThing(DescribeThingRequest describeThingRequest) throws AmazonClientException, AmazonServiceException
Gets information about the specified thing.
describeThingRequest
- The input for the DescribeThing operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeThingGroupResult describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest) throws AmazonClientException, AmazonServiceException
Describe a thing group.
describeThingGroupRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeThingRegistrationTaskResult describeThingRegistrationTask(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest) throws AmazonClientException, AmazonServiceException
Describes a bulk thing provisioning task.
describeThingRegistrationTaskRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DescribeThingTypeResult describeThingType(DescribeThingTypeRequest describeThingTypeRequest) throws AmazonClientException, AmazonServiceException
Gets information about the specified thing type.
describeThingTypeRequest
- The input for the DescribeThingType operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void detachPolicy(DetachPolicyRequest detachPolicyRequest) throws AmazonClientException, AmazonServiceException
Detaches a policy from the specified target.
detachPolicyRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.@Deprecated void detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest) throws AmazonClientException, AmazonServiceException
Removes the specified policy from the specified certificate.
Note: This API is deprecated. Please use DetachPolicy instead.
detachPrincipalPolicyRequest
- The input for the DetachPrincipalPolicy operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DetachSecurityProfileResult detachSecurityProfile(DetachSecurityProfileRequest detachSecurityProfileRequest) throws AmazonClientException, AmazonServiceException
Disassociates a Device Defender security profile from a thing group or from this account.
detachSecurityProfileRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest) throws AmazonClientException, AmazonServiceException
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.
detachThingPrincipalRequest
- The input for the DetachThingPrincipal operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) throws AmazonClientException, AmazonServiceException
Disables the rule.
disableTopicRuleRequest
- The input for the DisableTopicRuleRequest operation.
InternalException
InvalidRequestException
ServiceUnavailableException
UnauthorizedException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) throws AmazonClientException, AmazonServiceException
Enables the rule.
enableTopicRuleRequest
- The input for the EnableTopicRuleRequest operation.
InternalException
InvalidRequestException
ServiceUnavailableException
UnauthorizedException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetBehaviorModelTrainingSummariesResult getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest) throws AmazonClientException, AmazonServiceException
Returns a Device Defender's ML Detect Security Profile training model's status.
getBehaviorModelTrainingSummariesRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetCardinalityResult getCardinality(GetCardinalityRequest getCardinalityRequest) throws AmazonClientException, AmazonServiceException
Returns the approximate count of unique values that match the query.
getCardinalityRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
InvalidQueryException
InvalidAggregationException
IndexNotReadyException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetEffectivePoliciesResult getEffectivePolicies(GetEffectivePoliciesRequest getEffectivePoliciesRequest) throws AmazonClientException, AmazonServiceException
Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.
getEffectivePoliciesRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetIndexingConfigurationResult getIndexingConfiguration(GetIndexingConfigurationRequest getIndexingConfigurationRequest) throws AmazonClientException, AmazonServiceException
Gets the indexing configuration.
getIndexingConfigurationRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetJobDocumentResult getJobDocument(GetJobDocumentRequest getJobDocumentRequest) throws AmazonClientException, AmazonServiceException
Gets a job document.
getJobDocumentRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) throws AmazonClientException, AmazonServiceException
Gets the logging options.
NOTE: use of this command is not recommended. Use
GetV2LoggingOptions
instead.
getLoggingOptionsRequest
- The input for the GetLoggingOptions operation.
InternalException
InvalidRequestException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetOTAUpdateResult getOTAUpdate(GetOTAUpdateRequest getOTAUpdateRequest) throws AmazonClientException, AmazonServiceException
Gets an OTA update.
getOTAUpdateRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
InternalFailureException
ServiceUnavailableException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetPercentilesResult getPercentiles(GetPercentilesRequest getPercentilesRequest) throws AmazonClientException, AmazonServiceException
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.
getPercentilesRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
InvalidQueryException
InvalidAggregationException
IndexNotReadyException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest) throws AmazonClientException, AmazonServiceException
Gets information about the specified policy with the policy document of the default version.
getPolicyRequest
- The input for the GetPolicy operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) throws AmazonClientException, AmazonServiceException
Gets information about the specified policy version.
getPolicyVersionRequest
- The input for the GetPolicyVersion operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest) throws AmazonClientException, AmazonServiceException
Gets a registration code used to register a CA certificate with AWS IoT.
getRegistrationCodeRequest
- The input to the GetRegistrationCode operation.
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
InvalidRequestException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetStatisticsResult getStatistics(GetStatisticsRequest getStatisticsRequest) throws AmazonClientException, AmazonServiceException
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.
getStatisticsRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
InvalidQueryException
InvalidAggregationException
IndexNotReadyException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetTopicRuleResult getTopicRule(GetTopicRuleRequest getTopicRuleRequest) throws AmazonClientException, AmazonServiceException
Gets information about the rule.
getTopicRuleRequest
- The input for the GetTopicRule operation.
InternalException
InvalidRequestException
ServiceUnavailableException
UnauthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetTopicRuleDestinationResult getTopicRuleDestination(GetTopicRuleDestinationRequest getTopicRuleDestinationRequest) throws AmazonClientException, AmazonServiceException
Gets information about a topic rule destination.
getTopicRuleDestinationRequest
- InternalException
InvalidRequestException
ServiceUnavailableException
UnauthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.GetV2LoggingOptionsResult getV2LoggingOptions(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest) throws AmazonClientException, AmazonServiceException
Gets the fine grained logging options.
getV2LoggingOptionsRequest
- InternalException
NotConfiguredException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListActiveViolationsResult listActiveViolations(ListActiveViolationsRequest listActiveViolationsRequest) throws AmazonClientException, AmazonServiceException
Lists the active violations for a given Device Defender security profile.
listActiveViolationsRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListAttachedPoliciesResult listAttachedPolicies(ListAttachedPoliciesRequest listAttachedPoliciesRequest) throws AmazonClientException, AmazonServiceException
Lists the policies attached to the specified thing group.
listAttachedPoliciesRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListAuditFindingsResult listAuditFindings(ListAuditFindingsRequest listAuditFindingsRequest) throws AmazonClientException, AmazonServiceException
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.)
listAuditFindingsRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListAuditMitigationActionsExecutionsResult listAuditMitigationActionsExecutions(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest) throws AmazonClientException, AmazonServiceException
Gets the status of audit mitigation action tasks that were executed.
listAuditMitigationActionsExecutionsRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListAuditMitigationActionsTasksResult listAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest) throws AmazonClientException, AmazonServiceException
Gets a list of audit mitigation action tasks that match the specified filters.
listAuditMitigationActionsTasksRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListAuditSuppressionsResult listAuditSuppressions(ListAuditSuppressionsRequest listAuditSuppressionsRequest) throws AmazonClientException, AmazonServiceException
Lists your Device Defender audit listings.
listAuditSuppressionsRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListAuditTasksResult listAuditTasks(ListAuditTasksRequest listAuditTasksRequest) throws AmazonClientException, AmazonServiceException
Lists the Device Defender audits that have been performed during a given time period.
listAuditTasksRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListAuthorizersResult listAuthorizers(ListAuthorizersRequest listAuthorizersRequest) throws AmazonClientException, AmazonServiceException
Lists the authorizers registered in your account.
listAuthorizersRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListBillingGroupsResult listBillingGroups(ListBillingGroupsRequest listBillingGroupsRequest) throws AmazonClientException, AmazonServiceException
Lists the billing groups you have created.
listBillingGroupsRequest
- InvalidRequestException
InternalFailureException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListCACertificatesResult listCACertificates(ListCACertificatesRequest listCACertificatesRequest) throws AmazonClientException, AmazonServiceException
Lists the CA certificates registered for your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
listCACertificatesRequest
- Input for the ListCACertificates operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest) throws AmazonClientException, AmazonServiceException
Lists the certificates registered in your AWS account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
listCertificatesRequest
- The input for the ListCertificates operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest) throws AmazonClientException, AmazonServiceException
List the device certificates signed by the specified CA certificate.
listCertificatesByCARequest
- The input to the ListCertificatesByCA operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListCustomMetricsResult listCustomMetrics(ListCustomMetricsRequest listCustomMetricsRequest) throws AmazonClientException, AmazonServiceException
Lists your Device Defender detect custom metrics.
listCustomMetricsRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListDetectMitigationActionsExecutionsResult listDetectMitigationActionsExecutions(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest) throws AmazonClientException, AmazonServiceException
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
listDetectMitigationActionsExecutionsRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListDetectMitigationActionsTasksResult listDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest) throws AmazonClientException, AmazonServiceException
List of Device Defender ML Detect mitigation actions tasks.
listDetectMitigationActionsTasksRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListDimensionsResult listDimensions(ListDimensionsRequest listDimensionsRequest) throws AmazonClientException, AmazonServiceException
List the set of dimensions that are defined for your AWS account.
listDimensionsRequest
- InternalFailureException
InvalidRequestException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListDomainConfigurationsResult listDomainConfigurations(ListDomainConfigurationsRequest listDomainConfigurationsRequest) throws AmazonClientException, AmazonServiceException
Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.
The domain configuration feature is in public preview and is subject to change.
listDomainConfigurationsRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListIndicesResult listIndices(ListIndicesRequest listIndicesRequest) throws AmazonClientException, AmazonServiceException
Lists the search indices.
listIndicesRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListJobExecutionsForJobResult listJobExecutionsForJob(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest) throws AmazonClientException, AmazonServiceException
Lists the job executions for a job.
listJobExecutionsForJobRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListJobExecutionsForThingResult listJobExecutionsForThing(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest) throws AmazonClientException, AmazonServiceException
Lists the job executions for the specified thing.
listJobExecutionsForThingRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListJobsResult listJobs(ListJobsRequest listJobsRequest) throws AmazonClientException, AmazonServiceException
Lists jobs.
listJobsRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListMitigationActionsResult listMitigationActions(ListMitigationActionsRequest listMitigationActionsRequest) throws AmazonClientException, AmazonServiceException
Gets a list of all mitigation actions that match the specified filter criteria.
listMitigationActionsRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListOTAUpdatesResult listOTAUpdates(ListOTAUpdatesRequest listOTAUpdatesRequest) throws AmazonClientException, AmazonServiceException
Lists OTA updates.
listOTAUpdatesRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
InternalFailureException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) throws AmazonClientException, AmazonServiceException
Lists certificates that are being transferred but not yet accepted.
listOutgoingCertificatesRequest
- The input to the ListOutgoingCertificates operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest) throws AmazonClientException, AmazonServiceException
Lists your policies.
listPoliciesRequest
- The input for the ListPolicies operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.@Deprecated ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest) throws AmazonClientException, AmazonServiceException
Lists the principals associated with the specified policy.
Note: This API is deprecated. Please use ListTargetsForPolicy instead.
listPolicyPrincipalsRequest
- The input for the ListPolicyPrincipals operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) throws AmazonClientException, AmazonServiceException
Lists the versions of the specified policy and identifies the default version.
listPolicyVersionsRequest
- The input for the ListPolicyVersions operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.@Deprecated ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest) throws AmazonClientException, AmazonServiceException
Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
Note: This API is deprecated. Please use ListAttachedPolicies instead.
listPrincipalPoliciesRequest
- The input for the ListPrincipalPolicies operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest) throws AmazonClientException, AmazonServiceException
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.
listPrincipalThingsRequest
- The input for the ListPrincipalThings operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListProvisioningTemplateVersionsResult listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest) throws AmazonClientException, AmazonServiceException
A list of fleet provisioning template versions.
listProvisioningTemplateVersionsRequest
- InternalFailureException
InvalidRequestException
ThrottlingException
ResourceNotFoundException
UnauthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListProvisioningTemplatesResult listProvisioningTemplates(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest) throws AmazonClientException, AmazonServiceException
Lists the fleet provisioning templates in your AWS account.
listProvisioningTemplatesRequest
- InternalFailureException
InvalidRequestException
ThrottlingException
UnauthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest) throws AmazonClientException, AmazonServiceException
Lists the role aliases registered in your account.
listRoleAliasesRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListScheduledAuditsResult listScheduledAudits(ListScheduledAuditsRequest listScheduledAuditsRequest) throws AmazonClientException, AmazonServiceException
Lists all of your scheduled audits.
listScheduledAuditsRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest) throws AmazonClientException, AmazonServiceException
Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.
dimensionName
and metricName
cannot be used in
the same request.
listSecurityProfilesRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListSecurityProfilesForTargetResult listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest) throws AmazonClientException, AmazonServiceException
Lists the Device Defender security profiles attached to a target (thing group).
listSecurityProfilesForTargetRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest) throws AmazonClientException, AmazonServiceException
Lists all of the streams in your AWS account.
listStreamsRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonClientException, AmazonServiceException
Lists the tags (metadata) you have assigned to the resource.
listTagsForResourceRequest
- InvalidRequestException
InternalFailureException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest listTargetsForPolicyRequest) throws AmazonClientException, AmazonServiceException
List targets for the specified policy.
listTargetsForPolicyRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListTargetsForSecurityProfileResult listTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest) throws AmazonClientException, AmazonServiceException
Lists the targets (thing groups) associated with a given Device Defender security profile.
listTargetsForSecurityProfileRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingGroupsResult listThingGroups(ListThingGroupsRequest listThingGroupsRequest) throws AmazonClientException, AmazonServiceException
List the thing groups in your account.
listThingGroupsRequest
- InvalidRequestException
InternalFailureException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingGroupsForThingResult listThingGroupsForThing(ListThingGroupsForThingRequest listThingGroupsForThingRequest) throws AmazonClientException, AmazonServiceException
List the thing groups to which the specified thing belongs.
listThingGroupsForThingRequest
- InvalidRequestException
InternalFailureException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest) throws AmazonClientException, AmazonServiceException
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.
listThingPrincipalsRequest
- The input for the ListThingPrincipal operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingRegistrationTaskReportsResult listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest) throws AmazonClientException, AmazonServiceException
Information about the thing registration tasks.
listThingRegistrationTaskReportsRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingRegistrationTasksResult listThingRegistrationTasks(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest) throws AmazonClientException, AmazonServiceException
List bulk thing provisioning tasks.
listThingRegistrationTasksRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingTypesResult listThingTypes(ListThingTypesRequest listThingTypesRequest) throws AmazonClientException, AmazonServiceException
Lists the existing thing types.
listThingTypesRequest
- The input for the ListThingTypes operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingsResult listThings(ListThingsRequest listThingsRequest) throws AmazonClientException, AmazonServiceException
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.
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.
listThingsRequest
- The input for the ListThings operation.
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingsInBillingGroupResult listThingsInBillingGroup(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest) throws AmazonClientException, AmazonServiceException
Lists the things you have added to the given billing group.
listThingsInBillingGroupRequest
- InvalidRequestException
InternalFailureException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListThingsInThingGroupResult listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest) throws AmazonClientException, AmazonServiceException
Lists the things in the specified group.
listThingsInThingGroupRequest
- InvalidRequestException
InternalFailureException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListTopicRuleDestinationsResult listTopicRuleDestinations(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest) throws AmazonClientException, AmazonServiceException
Lists all the topic rule destinations in your AWS account.
listTopicRuleDestinationsRequest
- InternalException
InvalidRequestException
ServiceUnavailableException
UnauthorizedException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListTopicRulesResult listTopicRules(ListTopicRulesRequest listTopicRulesRequest) throws AmazonClientException, AmazonServiceException
Lists the rules for the specific topic.
listTopicRulesRequest
- The input for the ListTopicRules operation.
InternalException
InvalidRequestException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListV2LoggingLevelsResult listV2LoggingLevels(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest) throws AmazonClientException, AmazonServiceException
Lists logging levels.
listV2LoggingLevelsRequest
- InternalException
NotConfiguredException
InvalidRequestException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ListViolationEventsResult listViolationEvents(ListViolationEventsRequest listViolationEventsRequest) throws AmazonClientException, AmazonServiceException
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).
listViolationEventsRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.RegisterCACertificateResult registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest) throws AmazonClientException, AmazonServiceException
Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.
registerCACertificateRequest
- The input to the RegisterCACertificate operation.
ResourceAlreadyExistsException
RegistrationCodeValidationException
InvalidRequestException
CertificateValidationException
ThrottlingException
LimitExceededException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.RegisterCertificateResult registerCertificate(RegisterCertificateRequest registerCertificateRequest) throws AmazonClientException, AmazonServiceException
Registers a device certificate with AWS IoT. 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.
registerCertificateRequest
- The input to the RegisterCertificate operation.
ResourceAlreadyExistsException
InvalidRequestException
CertificateValidationException
CertificateStateException
CertificateConflictException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.RegisterCertificateWithoutCAResult registerCertificateWithoutCA(RegisterCertificateWithoutCARequest registerCertificateWithoutCARequest) throws AmazonClientException, AmazonServiceException
Register a certificate that does not have a certificate authority (CA).
registerCertificateWithoutCARequest
- ResourceAlreadyExistsException
InvalidRequestException
CertificateStateException
CertificateValidationException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.RegisterThingResult registerThing(RegisterThingRequest registerThingRequest) throws AmazonClientException, AmazonServiceException
Provisions a thing in the device registry. RegisterThing calls other AWS IoT control plane APIs. These calls might exceed your account level AWS IoT Throttling Limits and cause throttle errors. Please contact AWS Customer Support to raise your throttling limits if necessary.
registerThingRequest
- InternalFailureException
ServiceUnavailableException
InvalidRequestException
UnauthorizedException
ThrottlingException
ConflictingResourceUpdateException
ResourceRegistrationFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) throws AmazonClientException, AmazonServiceException
Rejects a pending certificate transfer. After AWS 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.
rejectCertificateTransferRequest
- The input for the RejectCertificateTransfer operation.
ResourceNotFoundException
TransferAlreadyCompletedException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.RemoveThingFromBillingGroupResult removeThingFromBillingGroup(RemoveThingFromBillingGroupRequest removeThingFromBillingGroupRequest) throws AmazonClientException, AmazonServiceException
Removes the given thing from the billing group.
removeThingFromBillingGroupRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.RemoveThingFromThingGroupResult removeThingFromThingGroup(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest) throws AmazonClientException, AmazonServiceException
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.
removeThingFromThingGroupRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) throws AmazonClientException, AmazonServiceException
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.
replaceTopicRuleRequest
- The input for the ReplaceTopicRule operation.
SqlParseException
InternalException
InvalidRequestException
ServiceUnavailableException
UnauthorizedException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.SearchIndexResult searchIndex(SearchIndexRequest searchIndexRequest) throws AmazonClientException, AmazonServiceException
The query search index.
searchIndexRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
InvalidQueryException
IndexNotReadyException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.SetDefaultAuthorizerResult setDefaultAuthorizer(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
setDefaultAuthorizerRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceAlreadyExistsException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) throws AmazonClientException, AmazonServiceException
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 ListPrincipalPolicy API.
setDefaultPolicyVersionRequest
- The input for the SetDefaultPolicyVersion operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) throws AmazonClientException, AmazonServiceException
Sets the logging options.
NOTE: use of this command is not recommended. Use
SetV2LoggingOptions
instead.
setLoggingOptionsRequest
- The input for the SetLoggingOptions operation.
InternalException
InvalidRequestException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest) throws AmazonClientException, AmazonServiceException
Sets the logging level.
setV2LoggingLevelRequest
- InternalException
NotConfiguredException
InvalidRequestException
ServiceUnavailableException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest) throws AmazonClientException, AmazonServiceException
Sets the logging options for the V2 logging service.
setV2LoggingOptionsRequest
- InternalException
InvalidRequestException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.StartAuditMitigationActionsTaskResult startAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest startAuditMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException
Starts a task that applies a set of mitigation actions to the specified target.
startAuditMitigationActionsTaskRequest
- InvalidRequestException
TaskAlreadyExistsException
LimitExceededException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.StartDetectMitigationActionsTaskResult startDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest startDetectMitigationActionsTaskRequest) throws AmazonClientException, AmazonServiceException
Starts a Device Defender ML Detect mitigation actions task.
startDetectMitigationActionsTaskRequest
- InvalidRequestException
TaskAlreadyExistsException
LimitExceededException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.StartOnDemandAuditTaskResult startOnDemandAuditTask(StartOnDemandAuditTaskRequest startOnDemandAuditTaskRequest) throws AmazonClientException, AmazonServiceException
Starts an on-demand Device Defender audit.
startOnDemandAuditTaskRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.StartThingRegistrationTaskResult startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest) throws AmazonClientException, AmazonServiceException
Creates a bulk thing provisioning task.
startThingRegistrationTaskRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.StopThingRegistrationTaskResult stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest) throws AmazonClientException, AmazonServiceException
Cancels a bulk thing provisioning task.
stopThingRegistrationTaskRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.TagResourceResult tagResource(TagResourceRequest tagResourceRequest) throws AmazonClientException, AmazonServiceException
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
tagResourceRequest
- InvalidRequestException
InternalFailureException
ResourceNotFoundException
ThrottlingException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.TestAuthorizationResult testAuthorization(TestAuthorizationRequest testAuthorizationRequest) throws AmazonClientException, AmazonServiceException
Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.
testAuthorizationRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
LimitExceededException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest) throws AmazonClientException, AmazonServiceException
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 AWS IoT device gateway.
testInvokeAuthorizerRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
InvalidResponseException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.TransferCertificateResult transferCertificate(TransferCertificateRequest transferCertificateRequest) throws AmazonClientException, AmazonServiceException
Transfers the specified certificate to the specified AWS account.
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 API to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.
transferCertificateRequest
- The input for the TransferCertificate operation.
InvalidRequestException
ResourceNotFoundException
CertificateStateException
TransferConflictException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest) throws AmazonClientException, AmazonServiceException
Removes the given tags (metadata) from the resource.
untagResourceRequest
- InvalidRequestException
InternalFailureException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateAccountAuditConfigurationResult updateAccountAuditConfiguration(UpdateAccountAuditConfigurationRequest updateAccountAuditConfigurationRequest) throws AmazonClientException, AmazonServiceException
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.
updateAccountAuditConfigurationRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateAuditSuppressionResult updateAuditSuppression(UpdateAuditSuppressionRequest updateAuditSuppressionRequest) throws AmazonClientException, AmazonServiceException
Updates a Device Defender audit suppression.
updateAuditSuppressionRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest) throws AmazonClientException, AmazonServiceException
Updates an authorizer.
updateAuthorizerRequest
- ResourceNotFoundException
InvalidRequestException
LimitExceededException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateBillingGroupResult updateBillingGroup(UpdateBillingGroupRequest updateBillingGroupRequest) throws AmazonClientException, AmazonServiceException
Updates information about the billing group.
updateBillingGroupRequest
- InvalidRequestException
VersionConflictException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest) throws AmazonClientException, AmazonServiceException
Updates a registered CA certificate.
updateCACertificateRequest
- The input to the UpdateCACertificate operation.
ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void updateCertificate(UpdateCertificateRequest updateCertificateRequest) throws AmazonClientException, AmazonServiceException
Updates the status of the specified certificate. This operation is idempotent.
Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to AWS IoT.
Within a few minutes of updating a certificate from the ACTIVE state to any other state, AWS IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.
updateCertificateRequest
- The input for the UpdateCertificate operation.
ResourceNotFoundException
CertificateStateException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateCustomMetricResult updateCustomMetric(UpdateCustomMetricRequest updateCustomMetricRequest) throws AmazonClientException, AmazonServiceException
Updates a Device Defender detect custom metric.
updateCustomMetricRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateDimensionResult updateDimension(UpdateDimensionRequest updateDimensionRequest) throws AmazonClientException, AmazonServiceException
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).
updateDimensionRequest
- InternalFailureException
InvalidRequestException
ResourceNotFoundException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateDomainConfigurationResult updateDomainConfiguration(UpdateDomainConfigurationRequest updateDomainConfigurationRequest) throws AmazonClientException, AmazonServiceException
Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
The domain configuration feature is in public preview and is subject to change.
updateDomainConfigurationRequest
- ResourceNotFoundException
CertificateValidationException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateDynamicThingGroupResult updateDynamicThingGroup(UpdateDynamicThingGroupRequest updateDynamicThingGroupRequest) throws AmazonClientException, AmazonServiceException
Updates a dynamic thing group.
updateDynamicThingGroupRequest
- InvalidRequestException
VersionConflictException
ThrottlingException
InternalFailureException
ResourceNotFoundException
InvalidQueryException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateEventConfigurationsResult updateEventConfigurations(UpdateEventConfigurationsRequest updateEventConfigurationsRequest) throws AmazonClientException, AmazonServiceException
Updates the event configurations.
updateEventConfigurationsRequest
- InvalidRequestException
InternalFailureException
ThrottlingException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateIndexingConfigurationResult updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest) throws AmazonClientException, AmazonServiceException
Updates the search configuration.
updateIndexingConfigurationRequest
- InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void updateJob(UpdateJobRequest updateJobRequest) throws AmazonClientException, AmazonServiceException
Updates supported fields of the specified job.
updateJobRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
ServiceUnavailableException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateMitigationActionResult updateMitigationAction(UpdateMitigationActionRequest updateMitigationActionRequest) throws AmazonClientException, AmazonServiceException
Updates the definition for the specified mitigation action.
updateMitigationActionRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateProvisioningTemplateResult updateProvisioningTemplate(UpdateProvisioningTemplateRequest updateProvisioningTemplateRequest) throws AmazonClientException, AmazonServiceException
Updates a fleet provisioning template.
updateProvisioningTemplateRequest
- InternalFailureException
InvalidRequestException
ResourceNotFoundException
UnauthorizedException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateRoleAliasResult updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest) throws AmazonClientException, AmazonServiceException
Updates a role alias.
updateRoleAliasRequest
- ResourceNotFoundException
InvalidRequestException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateScheduledAuditResult updateScheduledAudit(UpdateScheduledAuditRequest updateScheduledAuditRequest) throws AmazonClientException, AmazonServiceException
Updates a scheduled audit, including which checks are performed and how often the audit takes place.
updateScheduledAuditRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest) throws AmazonClientException, AmazonServiceException
Updates a Device Defender security profile.
updateSecurityProfileRequest
- InvalidRequestException
ResourceNotFoundException
VersionConflictException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest) throws AmazonClientException, AmazonServiceException
Updates an existing stream. The stream version will be incremented by one.
updateStreamRequest
- InvalidRequestException
ResourceNotFoundException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateThingResult updateThing(UpdateThingRequest updateThingRequest) throws AmazonClientException, AmazonServiceException
Updates the data for a thing.
updateThingRequest
- The input for the UpdateThing operation.
InvalidRequestException
VersionConflictException
ThrottlingException
UnauthorizedException
ServiceUnavailableException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateThingGroupResult updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest) throws AmazonClientException, AmazonServiceException
Update a thing group.
updateThingGroupRequest
- InvalidRequestException
VersionConflictException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateThingGroupsForThingResult updateThingGroupsForThing(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest) throws AmazonClientException, AmazonServiceException
Updates the groups to which the thing belongs.
updateThingGroupsForThingRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
ResourceNotFoundException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.UpdateTopicRuleDestinationResult updateTopicRuleDestination(UpdateTopicRuleDestinationRequest updateTopicRuleDestinationRequest) throws AmazonClientException, AmazonServiceException
Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
updateTopicRuleDestinationRequest
- InternalException
InvalidRequestException
ServiceUnavailableException
UnauthorizedException
ConflictingResourceUpdateException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.ValidateSecurityProfileBehaviorsResult validateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest validateSecurityProfileBehaviorsRequest) throws AmazonClientException, AmazonServiceException
Validates a Device Defender security profile behaviors specification.
validateSecurityProfileBehaviorsRequest
- InvalidRequestException
ThrottlingException
InternalFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by AWS
IoT indicating either a problem with the data in the request,
or a server side issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.