@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIot
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSIot
instead.
IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Signature Version 4 to sign the request is: execute-api.
For more information about how IoT works, see the Developer Guide.
For information about how to use the credentials provider for IoT, see Authorizing Direct Calls to Amazon Web Services Services.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AcceptCertificateTransferResult |
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.
|
AttachPolicyResult |
attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches the specified policy to the specified principal (certificate or other credential).
|
AttachPrincipalPolicyResult |
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.
|
CancelCertificateTransferResult |
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.
|
CancelJobExecutionResult |
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.
|
CreateCertificateProviderResult |
createCertificateProvider(CreateCertificateProviderRequest createCertificateProviderRequest)
Creates an Amazon Web Services IoT Core certificate provider.
|
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 IoT Device
Defender.
|
CreateDomainConfigurationResult |
createDomainConfiguration(CreateDomainConfigurationRequest createDomainConfigurationRequest)
Creates a domain configuration.
|
CreateDynamicThingGroupResult |
createDynamicThingGroup(CreateDynamicThingGroupRequest createDynamicThingGroupRequest)
Creates a dynamic thing group.
|
CreateFleetMetricResult |
createFleetMetric(CreateFleetMetricRequest createFleetMetricRequest)
Creates a fleet metric.
|
CreateJobResult |
createJob(CreateJobRequest createJobRequest)
Creates a job.
|
CreateJobTemplateResult |
createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest)
Creates a job template.
|
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 IoT OTA update on a target group of things or groups.
|
CreatePackageResult |
createPackage(CreatePackageRequest createPackageRequest)
Creates an IoT software package that can be deployed to your fleet.
|
CreatePackageVersionResult |
createPackageVersion(CreatePackageVersionRequest createPackageVersionRequest)
Creates a new version for an existing IoT software package.
|
CreatePolicyResult |
createPolicy(CreatePolicyRequest createPolicyRequest)
Creates an IoT policy.
|
CreatePolicyVersionResult |
createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified IoT policy.
|
CreateProvisioningClaimResult |
createProvisioningClaim(CreateProvisioningClaimRequest createProvisioningClaimRequest)
Creates a provisioning claim.
|
CreateProvisioningTemplateResult |
createProvisioningTemplate(CreateProvisioningTemplateRequest createProvisioningTemplateRequest)
Creates a provisioning template.
|
CreateProvisioningTemplateVersionResult |
createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest)
Creates a new version of a 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.
|
CreateTopicRuleResult |
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.
|
DeleteCertificateResult |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the specified certificate.
|
DeleteCertificateProviderResult |
deleteCertificateProvider(DeleteCertificateProviderRequest deleteCertificateProviderRequest)
Deletes a certificate provider.
|
DeleteCustomMetricResult |
deleteCustomMetric(DeleteCustomMetricRequest deleteCustomMetricRequest)
Deletes a Device Defender detect custom metric.
|
DeleteDimensionResult |
deleteDimension(DeleteDimensionRequest deleteDimensionRequest)
Removes the specified dimension from your Amazon Web Services accounts.
|
DeleteDomainConfigurationResult |
deleteDomainConfiguration(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest)
Deletes the specified domain configuration.
|
DeleteDynamicThingGroupResult |
deleteDynamicThingGroup(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest)
Deletes a dynamic thing group.
|
DeleteFleetMetricResult |
deleteFleetMetric(DeleteFleetMetricRequest deleteFleetMetricRequest)
Deletes the specified fleet metric.
|
DeleteJobResult |
deleteJob(DeleteJobRequest deleteJobRequest)
Deletes a job and its related job executions.
|
DeleteJobExecutionResult |
deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest)
Deletes a job execution.
|
DeleteJobTemplateResult |
deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest)
Deletes the specified job template.
|
DeleteMitigationActionResult |
deleteMitigationAction(DeleteMitigationActionRequest deleteMitigationActionRequest)
Deletes a defined mitigation action from your Amazon Web Services accounts.
|
DeleteOTAUpdateResult |
deleteOTAUpdate(DeleteOTAUpdateRequest deleteOTAUpdateRequest)
Delete an OTA update.
|
DeletePackageResult |
deletePackage(DeletePackageRequest deletePackageRequest)
Deletes a specific version from a software package.
|
DeletePackageVersionResult |
deletePackageVersion(DeletePackageVersionRequest deletePackageVersionRequest)
Deletes a specific version from a software package.
|
DeletePolicyResult |
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified policy.
|
DeletePolicyVersionResult |
deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version of the specified policy.
|
DeleteProvisioningTemplateResult |
deleteProvisioningTemplate(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest)
Deletes a provisioning template.
|
DeleteProvisioningTemplateVersionResult |
deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest)
Deletes a 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.
|
DeleteTopicRuleResult |
deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest)
Deletes the rule.
|
DeleteTopicRuleDestinationResult |
deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest)
Deletes a topic rule destination.
|
DeleteV2LoggingLevelResult |
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.
|
DescribeCertificateProviderResult |
describeCertificateProvider(DescribeCertificateProviderRequest describeCertificateProviderRequest)
Describes a certificate provider.
|
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 Amazon Web Services accounts.
|
DescribeDomainConfigurationResult |
describeDomainConfiguration(DescribeDomainConfigurationRequest describeDomainConfigurationRequest)
Gets summary information about a domain configuration.
|
DescribeEndpointResult |
describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.
|
DescribeEventConfigurationsResult |
describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest)
Describes event configurations.
|
DescribeFleetMetricResult |
describeFleetMetric(DescribeFleetMetricRequest describeFleetMetricRequest)
Gets information about the specified fleet metric.
|
DescribeIndexResult |
describeIndex(DescribeIndexRequest describeIndexRequest)
Describes a search index.
|
DescribeJobResult |
describeJob(DescribeJobRequest describeJobRequest)
Describes a job.
|
DescribeJobExecutionResult |
describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest)
Describes a job execution.
|
DescribeJobTemplateResult |
describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest)
Returns information about a job template.
|
DescribeManagedJobTemplateResult |
describeManagedJobTemplate(DescribeManagedJobTemplateRequest describeManagedJobTemplateRequest)
View details of a managed job template.
|
DescribeMitigationActionResult |
describeMitigationAction(DescribeMitigationActionRequest describeMitigationActionRequest)
Gets information about a mitigation action.
|
DescribeProvisioningTemplateResult |
describeProvisioningTemplate(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest)
Returns information about a provisioning template.
|
DescribeProvisioningTemplateVersionResult |
describeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest)
Returns information about a 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.
|
DetachPolicyResult |
detachPolicy(DetachPolicyRequest detachPolicyRequest)
Detaches a policy from the specified target.
|
DetachPrincipalPolicyResult |
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.
|
DisableTopicRuleResult |
disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest)
Disables the rule.
|
EnableTopicRuleResult |
enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest)
Enables the rule.
|
GetBehaviorModelTrainingSummariesResult |
getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest)
Returns a Device Defender's ML Detect Security Profile training model's status.
|
GetBucketsAggregationResult |
getBucketsAggregation(GetBucketsAggregationRequest getBucketsAggregationRequest)
Aggregates on indexed data with search queries pertaining to particular fields.
|
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 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.
|
GetPackageResult |
getPackage(GetPackageRequest getPackageRequest)
Gets information about the specified software package.
|
GetPackageConfigurationResult |
getPackageConfiguration(GetPackageConfigurationRequest getPackageConfigurationRequest)
Gets information about the specified software package's configuration.
|
GetPackageVersionResult |
getPackageVersion(GetPackageVersionRequest getPackageVersionRequest)
Gets information about the specified package version.
|
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 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 Amazon Web Services account.
|
ListCertificateProvidersResult |
listCertificateProviders(ListCertificateProvidersRequest listCertificateProvidersRequest)
Lists all your certificate providers in your Amazon Web Services account.
|
ListCertificatesResult |
listCertificates(ListCertificatesRequest listCertificatesRequest)
Lists the certificates registered in your Amazon Web Services 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 Amazon Web Services accounts.
|
ListDomainConfigurationsResult |
listDomainConfigurations(ListDomainConfigurationsRequest listDomainConfigurationsRequest)
Gets a list of domain configurations for the user.
|
ListFleetMetricsResult |
listFleetMetrics(ListFleetMetricsRequest listFleetMetricsRequest)
Lists all your fleet metrics.
|
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.
|
ListJobTemplatesResult |
listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest)
Returns a list of job templates.
|
ListManagedJobTemplatesResult |
listManagedJobTemplates(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest)
Returns a list of managed job templates.
|
ListMetricValuesResult |
listMetricValues(ListMetricValuesRequest listMetricValuesRequest)
Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom
metric) by the given thing during the specified time period.
|
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.
|
ListPackagesResult |
listPackages(ListPackagesRequest listPackagesRequest)
Lists the software packages associated to the account.
|
ListPackageVersionsResult |
listPackageVersions(ListPackageVersionsRequest listPackageVersionsRequest)
Lists the software package versions associated to the account.
|
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 provisioning templates in your Amazon Web Services account.
|
ListProvisioningTemplateVersionsResult |
listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest)
A list of provisioning template versions.
|
ListRelatedResourcesForAuditFindingResult |
listRelatedResourcesForAuditFinding(ListRelatedResourcesForAuditFindingRequest listRelatedResourcesForAuditFindingRequest)
The related resources of an Audit finding.
|
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 Amazon Web Services 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 Amazon Web Services 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.
|
PutVerificationStateOnViolationResult |
putVerificationStateOnViolation(PutVerificationStateOnViolationRequest putVerificationStateOnViolationRequest)
Set a verification state and provide a description of that verification state on a violation (detect alarm).
|
RegisterCACertificateResult |
registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest)
Registers a CA certificate with Amazon Web Services IoT Core.
|
RegisterCertificateResult |
registerCertificate(RegisterCertificateRequest registerCertificateRequest)
Registers a device certificate with IoT in the same certificate mode as the signing CA.
|
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.
|
RejectCertificateTransferResult |
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.
|
ReplaceTopicRuleResult |
replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest)
Replaces the rule.
|
SearchIndexResult |
searchIndex(SearchIndexRequest searchIndexRequest)
The query search index.
|
SetDefaultAuthorizerResult |
setDefaultAuthorizer(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest)
Sets the default authorizer.
|
SetDefaultPolicyVersionResult |
setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's default (operative) version.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
SetLoggingOptionsResult |
setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest)
Sets the logging options.
|
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
SetV2LoggingLevelResult |
setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest)
Sets the logging level.
|
SetV2LoggingOptionsResult |
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 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 Amazon Web Services 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.
|
UpdateCACertificateResult |
updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest)
Updates a registered CA certificate.
|
UpdateCertificateResult |
updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the status of the specified certificate.
|
UpdateCertificateProviderResult |
updateCertificateProvider(UpdateCertificateProviderRequest updateCertificateProviderRequest)
Updates a certificate provider.
|
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.
|
UpdateFleetMetricResult |
updateFleetMetric(UpdateFleetMetricRequest updateFleetMetricRequest)
Updates the data for a fleet metric.
|
UpdateIndexingConfigurationResult |
updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest)
Updates the search configuration.
|
UpdateJobResult |
updateJob(UpdateJobRequest updateJobRequest)
Updates supported fields of the specified job.
|
UpdateMitigationActionResult |
updateMitigationAction(UpdateMitigationActionRequest updateMitigationActionRequest)
Updates the definition for the specified mitigation action.
|
UpdatePackageResult |
updatePackage(UpdatePackageRequest updatePackageRequest)
Updates the supported fields for a specific software package.
|
UpdatePackageConfigurationResult |
updatePackageConfiguration(UpdatePackageConfigurationRequest updatePackageConfigurationRequest)
Updates the software package configuration.
|
UpdatePackageVersionResult |
updatePackageVersion(UpdatePackageVersionRequest updatePackageVersionRequest)
Updates the supported fields for a specific package version.
|
UpdateProvisioningTemplateResult |
updateProvisioningTemplate(UpdateProvisioningTemplateRequest updateProvisioningTemplateRequest)
Updates a 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.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "iot.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://iot.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
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. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
AcceptCertificateTransferResult acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest)
Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
Requires permission to access the AcceptCertificateTransfer action.
acceptCertificateTransferRequest
- The input for the AcceptCertificateTransfer operation.ResourceNotFoundException
- The specified resource does not exist.TransferAlreadyCompletedException
- You can't revert the certificate transfer because the transfer is already complete.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.AddThingToBillingGroupResult addThingToBillingGroup(AddThingToBillingGroupRequest addThingToBillingGroupRequest)
Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
addThingToBillingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.AddThingToThingGroupResult addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest)
Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
addThingToThingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.AssociateTargetsWithJobResult associateTargetsWithJob(AssociateTargetsWithJobRequest associateTargetsWithJobRequest)
Associates a group with a continuous job. The following criteria must be met:
The job must have been created with the targetSelection
field set to "CONTINUOUS".
The job status must currently be "IN_PROGRESS".
The total number of targets associated with a job must not exceed 100.
Requires permission to access the AssociateTargetsWithJob action.
associateTargetsWithJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.AttachPolicyResult attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
attachPolicyRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.@Deprecated AttachPrincipalPolicyResult attachPrincipalPolicy(AttachPrincipalPolicyRequest attachPrincipalPolicyRequest)
Attaches the specified policy to the specified principal (certificate or other credential).
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use AttachPolicy instead.
Requires permission to access the AttachPrincipalPolicy action.
attachPrincipalPolicyRequest
- The input for the AttachPrincipalPolicy operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.AttachSecurityProfileResult attachSecurityProfile(AttachSecurityProfileRequest attachSecurityProfileRequest)
Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
Requires permission to access the AttachSecurityProfile action.
attachSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.LimitExceededException
- A limit has been exceeded.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.AttachThingPrincipalResult attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest)
Attaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities.
Requires permission to access the AttachThingPrincipal action.
attachThingPrincipalRequest
- The input for the AttachThingPrincipal operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CancelAuditMitigationActionsTaskResult cancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest cancelAuditMitigationActionsTaskRequest)
Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
Requires permission to access the CancelAuditMitigationActionsTask action.
cancelAuditMitigationActionsTaskRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.CancelAuditTaskResult cancelAuditTask(CancelAuditTaskRequest cancelAuditTaskRequest)
Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.
Requires permission to access the CancelAuditTask action.
cancelAuditTaskRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.CancelCertificateTransferResult cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest)
Cancels a pending transfer for the specified certificate.
Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.
After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
Requires permission to access the CancelCertificateTransfer action.
cancelCertificateTransferRequest
- The input for the CancelCertificateTransfer operation.ResourceNotFoundException
- The specified resource does not exist.TransferAlreadyCompletedException
- You can't revert the certificate transfer because the transfer is already complete.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CancelDetectMitigationActionsTaskResult cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest)
Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
cancelDetectMitigationActionsTaskRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)
Cancels a job.
Requires permission to access the CancelJob action.
cancelJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.LimitExceededException
- A limit has been exceeded.CancelJobExecutionResult cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest)
Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
cancelJobExecutionRequest
- InvalidRequestException
- The request is not valid.InvalidStateTransitionException
- An attempt was made to change to an invalid state, for example by deleting a job or a job execution which
is "IN_PROGRESS" without setting the force
parameter.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ClearDefaultAuthorizerResult clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest)
Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
clearDefaultAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ConfirmTopicRuleDestinationResult confirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest)
Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation
message to the endpoint or base address you specify. The message includes a token which you pass back when
calling ConfirmTopicRuleDestination
to confirm that you own or have access to the endpoint.
Requires permission to access the ConfirmTopicRuleDestination action.
confirmTopicRuleDestinationRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.CreateAuditSuppressionResult createAuditSuppression(CreateAuditSuppressionRequest createAuditSuppressionRequest)
Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
createAuditSuppressionRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.CreateAuthorizerResult createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
createAuthorizerRequest
- ResourceAlreadyExistsException
- The resource already exists.InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CreateBillingGroupResult createBillingGroup(CreateBillingGroupRequest createBillingGroupRequest)
Creates a billing group.
Requires permission to access the CreateBillingGroup action.
createBillingGroupRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.CreateCertificateFromCsrResult createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest)
Creates an X.509 certificate using the specified certificate signing request.
Requires permission to access the CreateCertificateFromCsr action.
The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple .csr
files
into that directory, and then specifying that directory on the command line. The following commands show how to
create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are
located inside of the directory my-csr-directory:
On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the
aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for the
corresponding CSR.
You can also run the aws iot create-certificate-from-csr
part of the command in parallel to speed up
the certificate creation process:
$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
createCertificateFromCsrRequest
- The input for the CreateCertificateFromCsr operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CreateCertificateProviderResult createCertificateProvider(CreateCertificateProviderRequest createCertificateProviderRequest)
Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.
Requires permission to access the CreateCertificateProvider action.
After you create a certificate provider, the behavior of
CreateCertificateFromCsr
API for fleet provisioning will change and all API calls to
CreateCertificateFromCsr
will invoke the certificate provider to create the certificates. It can
take up to a few minutes for this behavior to change after a certificate provider is created.
createCertificateProviderRequest
- LimitExceededException
- A limit has been exceeded.ResourceAlreadyExistsException
- The resource already exists.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CreateCustomMetricResult createCustomMetric(CreateCustomMetricRequest createCustomMetricRequest)
Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
createCustomMetricRequest
- InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.CreateDimensionResult createDimension(CreateDimensionRequest createDimensionRequest)
Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device
Defender. For example, using a TOPIC_FILTER
dimension, you can narrow down the scope of the metric
only to MQTT topics whose name match the pattern specified in the dimension.
Requires permission to access the CreateDimension action.
createDimensionRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.CreateDomainConfigurationResult createDomainConfiguration(CreateDomainConfigurationRequest createDomainConfigurationRequest)
Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
createDomainConfigurationRequest
- LimitExceededException
- A limit has been exceeded.CertificateValidationException
- The certificate is invalid.ResourceAlreadyExistsException
- The resource already exists.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.UnauthorizedException
- You are not authorized to perform this operation.ThrottlingException
- The rate exceeds the limit.CreateDynamicThingGroupResult createDynamicThingGroup(CreateDynamicThingGroupRequest createDynamicThingGroupRequest)
Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
createDynamicThingGroupRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.InvalidQueryException
- The query is invalid.LimitExceededException
- A limit has been exceeded.CreateFleetMetricResult createFleetMetric(CreateFleetMetricRequest createFleetMetricRequest)
Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
createFleetMetricRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.InvalidAggregationException
- The aggregation is invalid.IndexNotReadyException
- The index is not ready.CreateJobResult createJob(CreateJobRequest createJobRequest)
Creates a job.
Requires permission to access the CreateJob action.
createJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ResourceAlreadyExistsException
- The resource already exists.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest)
Creates a job template.
Requires permission to access the CreateJobTemplate action.
createJobTemplateRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ConflictException
- A resource with the same name already exists.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.CreateKeysAndCertificateResult createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest)
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call
CreateKeysAndCertificate
over MQTT from a device, for more information, see Provisioning MQTT API.
Note This is the only time IoT issues the private key for this certificate, so it is important to keep it in a secure location.
Requires permission to access the CreateKeysAndCertificate action.
createKeysAndCertificateRequest
- The input for the CreateKeysAndCertificate operation.
Requires permission to access the CreateKeysAndCertificateRequest action.
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CreateMitigationActionResult createMitigationAction(CreateMitigationActionRequest createMitigationActionRequest)
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.
Requires permission to access the CreateMitigationAction action.
createMitigationActionRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.CreateOTAUpdateResult createOTAUpdate(CreateOTAUpdateRequest createOTAUpdateRequest)
Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
createOTAUpdateRequest
- InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ResourceNotFoundException
- The specified resource does not exist.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ServiceUnavailableException
- The service is temporarily unavailable.CreatePackageResult createPackage(CreatePackageRequest createPackageRequest)
Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
createPackageRequest
- ThrottlingException
- The rate exceeds the limit.ConflictException
- A resource with the same name already exists.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ServiceQuotaExceededException
- A limit has been exceeded.CreatePackageVersionResult createPackageVersion(CreatePackageVersionRequest createPackageVersionRequest)
Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
createPackageVersionRequest
- ThrottlingException
- The rate exceeds the limit.ConflictException
- A resource with the same name already exists.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ServiceQuotaExceededException
- A limit has been exceeded.CreatePolicyResult createPolicy(CreatePolicyRequest createPolicyRequest)
Creates an IoT policy.
The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
Requires permission to access the CreatePolicy action.
createPolicyRequest
- The input for the CreatePolicy operation.ResourceAlreadyExistsException
- The resource already exists.MalformedPolicyException
- The policy documentation is not valid.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CreatePolicyVersionResult createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.
Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
Requires permission to access the CreatePolicyVersion action.
createPolicyVersionRequest
- The input for the CreatePolicyVersion operation.ResourceNotFoundException
- The specified resource does not exist.MalformedPolicyException
- The policy documentation is not valid.VersionsLimitExceededException
- The number of policy versions exceeds the limit.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CreateProvisioningClaimResult createProvisioningClaim(CreateProvisioningClaimRequest createProvisioningClaimRequest)
Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
createProvisioningClaimRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CreateProvisioningTemplateResult createProvisioningTemplate(CreateProvisioningTemplateRequest createProvisioningTemplateRequest)
Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
createProvisioningTemplateRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ResourceAlreadyExistsException
- The resource already exists.CreateProvisioningTemplateVersionResult createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest)
Creates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
createProvisioningTemplateVersionRequest
- VersionsLimitExceededException
- The number of policy versions exceeds the limit.InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.CreateRoleAliasResult createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest)
Creates a role alias.
Requires permission to access the CreateRoleAlias action.
createRoleAliasRequest
- ResourceAlreadyExistsException
- The resource already exists.InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CreateScheduledAuditResult createScheduledAudit(CreateScheduledAuditRequest createScheduledAuditRequest)
Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
createScheduledAuditRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.CreateSecurityProfileResult createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)
Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
createSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.CreateStreamResult createStream(CreateStreamRequest createStreamRequest)
Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.
Requires permission to access the CreateStream action.
createStreamRequest
- InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ResourceNotFoundException
- The specified resource does not exist.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.CreateThingResult createThing(CreateThingRequest createThingRequest)
Creates a thing record in the registry. If this call is made multiple times using the same thing name and
configuration, the call will succeed. If this call is made with the same thing name but different configuration a
ResourceAlreadyExistsException
is thrown.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
Requires permission to access the CreateThing action.
createThingRequest
- The input for the CreateThing operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceAlreadyExistsException
- The resource already exists.ResourceNotFoundException
- The specified resource does not exist.CreateThingGroupResult createThingGroup(CreateThingGroupRequest createThingGroupRequest)
Create a thing group.
This is a control plane operation. See Authorization for information about authorizing control plane actions.
If the ThingGroup
that you create has the exact same attributes as an existing
ThingGroup
, you will get a 200 success response.
Requires permission to access the CreateThingGroup action.
createThingGroupRequest
- InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.CreateThingTypeResult createThingType(CreateThingTypeRequest createThingTypeRequest)
Creates a new thing type.
Requires permission to access the CreateThingType action.
createThingTypeRequest
- The input for the CreateThingType operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceAlreadyExistsException
- The resource already exists.CreateTopicRuleResult createTopicRule(CreateTopicRuleRequest createTopicRuleRequest)
Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
Requires permission to access the CreateTopicRule action.
createTopicRuleRequest
- The input for the CreateTopicRule operation.SqlParseException
- The Rule-SQL expression can't be parsed correctly.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ServiceUnavailableException
- The service is temporarily unavailable.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.CreateTopicRuleDestinationResult createTopicRuleDestination(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest)
Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
createTopicRuleDestinationRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceAlreadyExistsException
- The resource already exists.ServiceUnavailableException
- The service is temporarily unavailable.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.DeleteAccountAuditConfigurationResult deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest deleteAccountAuditConfigurationRequest)
Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.
Requires permission to access the DeleteAccountAuditConfiguration action.
deleteAccountAuditConfigurationRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DeleteAuditSuppressionResult deleteAuditSuppression(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest)
Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
deleteAuditSuppressionRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DeleteAuthorizerResult deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
deleteAuthorizerRequest
- DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DeleteBillingGroupResult deleteBillingGroup(DeleteBillingGroupRequest deleteBillingGroupRequest)
Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
deleteBillingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DeleteCACertificateResult deleteCACertificate(DeleteCACertificateRequest deleteCACertificateRequest)
Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
deleteCACertificateRequest
- Input for the DeleteCACertificate operation.InvalidRequestException
- The request is not valid.CertificateStateException
- The certificate operation is not allowed.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DeleteCertificateResult deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the specified certificate.
A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPolicy action to detach all policies. Next, use the UpdateCertificate action to set the certificate to the INACTIVE status.
Requires permission to access the DeleteCertificate action.
deleteCertificateRequest
- The input for the DeleteCertificate operation.CertificateStateException
- The certificate operation is not allowed.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DeleteCertificateProviderResult deleteCertificateProvider(DeleteCertificateProviderRequest deleteCertificateProviderRequest)
Deletes a certificate provider.
Requires permission to access the DeleteCertificateProvider action.
If you delete the certificate provider resource, the behavior of CreateCertificateFromCsr
will
resume, and IoT will create certificates signed by IoT from a certificate signing request (CSR).
deleteCertificateProviderRequest
- DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DeleteCustomMetricResult deleteCustomMetric(DeleteCustomMetricRequest deleteCustomMetricRequest)
Deletes a Device Defender detect custom metric.
Requires permission to access the DeleteCustomMetric action.
Before you can delete a custom metric, you must first remove the custom metric from all security profiles it's a
part of. The security profile associated with the custom metric can be found using the ListSecurityProfiles
API with metricName
set to your custom metric name.
deleteCustomMetricRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DeleteDimensionResult deleteDimension(DeleteDimensionRequest deleteDimensionRequest)
Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
deleteDimensionRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.DeleteDomainConfigurationResult deleteDomainConfiguration(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest)
Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
deleteDomainConfigurationRequest
- ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.DeleteDynamicThingGroupResult deleteDynamicThingGroup(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest)
Deletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
deleteDynamicThingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DeleteFleetMetricResult deleteFleetMetric(DeleteFleetMetricRequest deleteFleetMetricRequest)
Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.
Requires permission to access the DeleteFleetMetric action.
deleteFleetMetricRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.DeleteJobResult deleteJob(DeleteJobRequest deleteJobRequest)
Deletes a job and its related job executions.
Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error.
Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.
Requires permission to access the DeleteJob action.
deleteJobRequest
- InvalidRequestException
- The request is not valid.InvalidStateTransitionException
- An attempt was made to change to an invalid state, for example by deleting a job or a job execution which
is "IN_PROGRESS" without setting the force
parameter.ResourceNotFoundException
- The specified resource does not exist.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.DeleteJobExecutionResult deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest)
Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
deleteJobExecutionRequest
- InvalidRequestException
- The request is not valid.InvalidStateTransitionException
- An attempt was made to change to an invalid state, for example by deleting a job or a job execution which
is "IN_PROGRESS" without setting the force
parameter.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.DeleteJobTemplateResult deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest)
Deletes the specified job template.
deleteJobTemplateRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DeleteMitigationActionResult deleteMitigationAction(DeleteMitigationActionRequest deleteMitigationActionRequest)
Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
deleteMitigationActionRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DeleteOTAUpdateResult deleteOTAUpdate(DeleteOTAUpdateRequest deleteOTAUpdateRequest)
Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
deleteOTAUpdateRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ServiceUnavailableException
- The service is temporarily unavailable.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.DeletePackageResult deletePackage(DeletePackageRequest deletePackageRequest)
Deletes a specific version from a software package.
Note: All package versions must be deleted before deleting the software package.
Requires permission to access the DeletePackageVersion action.
deletePackageRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.DeletePackageVersionResult deletePackageVersion(DeletePackageVersionRequest deletePackageVersionRequest)
Deletes a specific version from a software package.
Note: If a package version is designated as default, you must remove the designation from the software package using the UpdatePackage action.
deletePackageVersionRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.DeletePolicyResult deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified policy.
A policy cannot be deleted if it has non-default versions or it is attached to any certificate.
To delete a policy, use the DeletePolicyVersion action to delete all non-default versions of the policy; use the DetachPolicy action to detach the policy from any certificate; and then use the DeletePolicy action to delete the policy.
When a policy is deleted using DeletePolicy, its default version is deleted with it.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.
Requires permission to access the DeletePolicy action.
deletePolicyRequest
- The input for the DeletePolicy operation.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DeletePolicyVersionResult deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
Requires permission to access the DeletePolicyVersion action.
deletePolicyVersionRequest
- The input for the DeletePolicyVersion operation.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DeleteProvisioningTemplateResult deleteProvisioningTemplate(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest)
Deletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
deleteProvisioningTemplateRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.ThrottlingException
- The rate exceeds the limit.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.UnauthorizedException
- You are not authorized to perform this operation.DeleteProvisioningTemplateVersionResult deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest)
Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
deleteProvisioningTemplateVersionRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.DeleteRegistrationCodeResult deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest)
Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
deleteRegistrationCodeRequest
- The input for the DeleteRegistrationCode operation.ThrottlingException
- The rate exceeds the limit.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DeleteRoleAliasResult deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest)
Deletes a role alias
Requires permission to access the DeleteRoleAlias action.
deleteRoleAliasRequest
- DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DeleteScheduledAuditResult deleteScheduledAudit(DeleteScheduledAuditRequest deleteScheduledAuditRequest)
Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
deleteScheduledAuditRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DeleteSecurityProfileResult deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
deleteSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a stream.
Requires permission to access the DeleteStream action.
deleteStreamRequest
- ResourceNotFoundException
- The specified resource does not exist.DeleteConflictException
- You can't delete the resource because it is attached to one or more resources.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DeleteThingResult deleteThing(DeleteThingRequest deleteThingRequest)
Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
Requires permission to access the DeleteThing action.
deleteThingRequest
- The input for the DeleteThing operation.ResourceNotFoundException
- The specified resource does not exist.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DeleteThingGroupResult deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest)
Deletes a thing group.
Requires permission to access the DeleteThingGroup action.
deleteThingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DeleteThingTypeResult deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest)
Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.
Requires permission to access the DeleteThingType action.
deleteThingTypeRequest
- The input for the DeleteThingType operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DeleteTopicRuleResult deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest)
Deletes the rule.
Requires permission to access the DeleteTopicRule action.
deleteTopicRuleRequest
- The input for the DeleteTopicRule operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.DeleteTopicRuleDestinationResult deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest)
Deletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
deleteTopicRuleDestinationRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.DeleteV2LoggingLevelResult deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest)
Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
deleteV2LoggingLevelRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.DeprecateThingTypeResult deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest)
Deprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
deprecateThingTypeRequest
- The input for the DeprecateThingType operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DescribeAccountAuditConfigurationResult describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest)
Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the DescribeAccountAuditConfiguration action.
describeAccountAuditConfigurationRequest
- ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeAuditFindingResult describeAuditFinding(DescribeAuditFindingRequest describeAuditFindingRequest)
Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.
Requires permission to access the DescribeAuditFinding action.
describeAuditFindingRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeAuditMitigationActionsTaskResult describeAuditMitigationActionsTask(DescribeAuditMitigationActionsTaskRequest describeAuditMitigationActionsTaskRequest)
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
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeAuditSuppressionResult describeAuditSuppression(DescribeAuditSuppressionRequest describeAuditSuppressionRequest)
Gets information about a Device Defender audit suppression.
describeAuditSuppressionRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeAuditTaskResult describeAuditTask(DescribeAuditTaskRequest describeAuditTaskRequest)
Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
describeAuditTaskRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeAuthorizerResult describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest)
Describes an authorizer.
Requires permission to access the DescribeAuthorizer action.
describeAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DescribeBillingGroupResult describeBillingGroup(DescribeBillingGroupRequest describeBillingGroupRequest)
Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
describeBillingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DescribeCACertificateResult describeCACertificate(DescribeCACertificateRequest describeCACertificateRequest)
Describes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
describeCACertificateRequest
- The input for the DescribeCACertificate operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DescribeCertificateResult describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Gets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
describeCertificateRequest
- The input for the DescribeCertificate operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DescribeCertificateProviderResult describeCertificateProvider(DescribeCertificateProviderRequest describeCertificateProviderRequest)
Describes a certificate provider.
Requires permission to access the DescribeCertificateProvider action.
describeCertificateProviderRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DescribeCustomMetricResult describeCustomMetric(DescribeCustomMetricRequest describeCustomMetricRequest)
Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
describeCustomMetricRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeDefaultAuthorizerResult describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest)
Describes the default authorizer.
Requires permission to access the DescribeDefaultAuthorizer action.
describeDefaultAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DescribeDetectMitigationActionsTaskResult describeDetectMitigationActionsTask(DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest)
Gets information about a Device Defender ML Detect mitigation action.
Requires permission to access the DescribeDetectMitigationActionsTask action.
describeDetectMitigationActionsTaskRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeDimensionResult describeDimension(DescribeDimensionRequest describeDimensionRequest)
Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
describeDimensionRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.DescribeDomainConfigurationResult describeDomainConfiguration(DescribeDomainConfigurationRequest describeDomainConfigurationRequest)
Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
describeDomainConfigurationRequest
- ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InvalidRequestException
- The request is not valid.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DescribeEndpointResult describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.
The first time DescribeEndpoint
is called, an endpoint is created. All subsequent calls to
DescribeEndpoint
return the same endpoint.
Requires permission to access the DescribeEndpoint action.
describeEndpointRequest
- The input for the DescribeEndpoint operation.InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.UnauthorizedException
- You are not authorized to perform this operation.ThrottlingException
- The rate exceeds the limit.DescribeEventConfigurationsResult describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest)
Describes event configurations.
Requires permission to access the DescribeEventConfigurations action.
describeEventConfigurationsRequest
- InternalFailureException
- An unexpected error has occurred.ThrottlingException
- The rate exceeds the limit.DescribeFleetMetricResult describeFleetMetric(DescribeFleetMetricRequest describeFleetMetricRequest)
Gets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
describeFleetMetricRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DescribeIndexResult describeIndex(DescribeIndexRequest describeIndexRequest)
Describes a search index.
Requires permission to access the DescribeIndex action.
describeIndexRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DescribeJobResult describeJob(DescribeJobRequest describeJobRequest)
Describes a job.
Requires permission to access the DescribeJob action.
describeJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.DescribeJobExecutionResult describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest)
Describes a job execution.
Requires permission to access the DescribeJobExecution action.
describeJobExecutionRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.DescribeJobTemplateResult describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest)
Returns information about a job template.
describeJobTemplateRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeManagedJobTemplateResult describeManagedJobTemplate(DescribeManagedJobTemplateRequest describeManagedJobTemplateRequest)
View details of a managed job template.
describeManagedJobTemplateRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.DescribeMitigationActionResult describeMitigationAction(DescribeMitigationActionRequest describeMitigationActionRequest)
Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
describeMitigationActionRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeProvisioningTemplateResult describeProvisioningTemplate(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest)
Returns information about a provisioning template.
Requires permission to access the DescribeProvisioningTemplate action.
describeProvisioningTemplateRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.DescribeProvisioningTemplateVersionResult describeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest)
Returns information about a provisioning template version.
Requires permission to access the DescribeProvisioningTemplateVersion action.
describeProvisioningTemplateVersionRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.DescribeRoleAliasResult describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest)
Describes a role alias.
Requires permission to access the DescribeRoleAlias action.
describeRoleAliasRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DescribeScheduledAuditResult describeScheduledAudit(DescribeScheduledAuditRequest describeScheduledAuditRequest)
Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
describeScheduledAuditRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeSecurityProfileResult describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest)
Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
describeSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest)
Gets information about a stream.
Requires permission to access the DescribeStream action.
describeStreamRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DescribeThingResult describeThing(DescribeThingRequest describeThingRequest)
Gets information about the specified thing.
Requires permission to access the DescribeThing action.
describeThingRequest
- The input for the DescribeThing operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DescribeThingGroupResult describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest)
Describe a thing group.
Requires permission to access the DescribeThingGroup action.
describeThingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DescribeThingRegistrationTaskResult describeThingRegistrationTask(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest)
Describes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
describeThingRegistrationTaskRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.DescribeThingTypeResult describeThingType(DescribeThingTypeRequest describeThingTypeRequest)
Gets information about the specified thing type.
Requires permission to access the DescribeThingType action.
describeThingTypeRequest
- The input for the DescribeThingType operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DetachPolicyResult detachPolicy(DetachPolicyRequest detachPolicyRequest)
Detaches a policy from the specified target.
Because of the distributed nature of Amazon Web Services, it can take up to five minutes after a policy is detached before it's ready to be deleted.
Requires permission to access the DetachPolicy action.
detachPolicyRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.@Deprecated DetachPrincipalPolicyResult detachPrincipalPolicy(DetachPrincipalPolicyRequest detachPrincipalPolicyRequest)
Removes the specified policy from the specified certificate.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use DetachPolicy instead.
Requires permission to access the DetachPrincipalPolicy action.
detachPrincipalPolicyRequest
- The input for the DetachPrincipalPolicy operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DetachSecurityProfileResult detachSecurityProfile(DetachSecurityProfileRequest detachSecurityProfileRequest)
Disassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
detachSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.DetachThingPrincipalResult detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest)
Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
This call is asynchronous. It might take several seconds for the detachment to propagate.
Requires permission to access the DetachThingPrincipal action.
detachThingPrincipalRequest
- The input for the DetachThingPrincipal operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.DisableTopicRuleResult disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest)
Disables the rule.
Requires permission to access the DisableTopicRule action.
disableTopicRuleRequest
- The input for the DisableTopicRuleRequest operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.EnableTopicRuleResult enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest)
Enables the rule.
Requires permission to access the EnableTopicRule action.
enableTopicRuleRequest
- The input for the EnableTopicRuleRequest operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.GetBehaviorModelTrainingSummariesResult getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest)
Returns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
getBehaviorModelTrainingSummariesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.GetBucketsAggregationResult getBucketsAggregation(GetBucketsAggregationRequest getBucketsAggregationRequest)
Aggregates on indexed data with search queries pertaining to particular fields.
Requires permission to access the GetBucketsAggregation action.
getBucketsAggregationRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.InvalidAggregationException
- The aggregation is invalid.IndexNotReadyException
- The index is not ready.GetCardinalityResult getCardinality(GetCardinalityRequest getCardinalityRequest)
Returns the approximate count of unique values that match the query.
Requires permission to access the GetCardinality action.
getCardinalityRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.InvalidAggregationException
- The aggregation is invalid.IndexNotReadyException
- The index is not ready.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 IoT device gateway.
Requires permission to access the GetEffectivePolicies action.
getEffectivePoliciesRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.GetIndexingConfigurationResult getIndexingConfiguration(GetIndexingConfigurationRequest getIndexingConfigurationRequest)
Gets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
getIndexingConfigurationRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.GetJobDocumentResult getJobDocument(GetJobDocumentRequest getJobDocumentRequest)
Gets a job document.
Requires permission to access the GetJobDocument action.
getJobDocumentRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.GetLoggingOptionsResult getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest)
Gets the logging options.
NOTE: use of this command is not recommended. Use GetV2LoggingOptions
instead.
Requires permission to access the GetLoggingOptions action.
getLoggingOptionsRequest
- The input for the GetLoggingOptions operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.GetOTAUpdateResult getOTAUpdate(GetOTAUpdateRequest getOTAUpdateRequest)
Gets an OTA update.
Requires permission to access the GetOTAUpdate action.
getOTAUpdateRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ServiceUnavailableException
- The service is temporarily unavailable.ResourceNotFoundException
- The specified resource does not exist.GetPackageResult getPackage(GetPackageRequest getPackageRequest)
Gets information about the specified software package.
Requires permission to access the GetPackage action.
getPackageRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.GetPackageConfigurationResult getPackageConfiguration(GetPackageConfigurationRequest getPackageConfigurationRequest)
Gets information about the specified software package's configuration.
Requires permission to access the GetPackageConfiguration action.
getPackageConfigurationRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.GetPackageVersionResult getPackageVersion(GetPackageVersionRequest getPackageVersionRequest)
Gets information about the specified package version.
Requires permission to access the GetPackageVersion action.
getPackageVersionRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.GetPercentilesResult getPercentiles(GetPercentilesRequest getPercentilesRequest)
Groups the aggregated values that match the query into percentile groupings. The default percentile groupings
are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles
. This
function returns a value for each percentile group specified (or the default percentile groupings). The
percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values
that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately
five percent of the values that match the query, and so on. The result is an approximation, the more values that
match the query, the more accurate the percentile values.
Requires permission to access the GetPercentiles action.
getPercentilesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.InvalidAggregationException
- The aggregation is invalid.IndexNotReadyException
- The index is not ready.GetPolicyResult getPolicy(GetPolicyRequest getPolicyRequest)
Gets information about the specified policy with the policy document of the default version.
Requires permission to access the GetPolicy action.
getPolicyRequest
- The input for the GetPolicy operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.GetPolicyVersionResult getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)
Gets information about the specified policy version.
Requires permission to access the GetPolicyVersion action.
getPolicyVersionRequest
- The input for the GetPolicyVersion operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.GetRegistrationCodeResult getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest)
Gets a registration code used to register a CA certificate with IoT.
IoT will create a registration code as part of this API call if the registration code doesn't exist or has been deleted. If you already have a registration code, this API call will return the same registration code.
Requires permission to access the GetRegistrationCode action.
getRegistrationCodeRequest
- The input to the GetRegistrationCode operation.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.GetStatisticsResult getStatistics(GetStatisticsRequest getStatisticsRequest)
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the
specified aggregated field. If the aggregation field is of type String
, only the count statistic is
returned.
Requires permission to access the GetStatistics action.
getStatisticsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.InvalidAggregationException
- The aggregation is invalid.IndexNotReadyException
- The index is not ready.GetTopicRuleResult getTopicRule(GetTopicRuleRequest getTopicRuleRequest)
Gets information about the rule.
Requires permission to access the GetTopicRule action.
getTopicRuleRequest
- The input for the GetTopicRule operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.GetTopicRuleDestinationResult getTopicRuleDestination(GetTopicRuleDestinationRequest getTopicRuleDestinationRequest)
Gets information about a topic rule destination.
Requires permission to access the GetTopicRuleDestination action.
getTopicRuleDestinationRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.GetV2LoggingOptionsResult getV2LoggingOptions(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest)
Gets the fine grained logging options.
Requires permission to access the GetV2LoggingOptions action.
getV2LoggingOptionsRequest
- InternalException
- An unexpected error has occurred.NotConfiguredException
- The resource is not configured.ServiceUnavailableException
- The service is temporarily unavailable.ListActiveViolationsResult listActiveViolations(ListActiveViolationsRequest listActiveViolationsRequest)
Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
listActiveViolationsRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListAttachedPoliciesResult listAttachedPolicies(ListAttachedPoliciesRequest listAttachedPoliciesRequest)
Lists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
listAttachedPoliciesRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.ListAuditFindingsResult listAuditFindings(ListAuditFindingsRequest listAuditFindingsRequest)
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)
Requires permission to access the ListAuditFindings action.
listAuditFindingsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListAuditMitigationActionsExecutionsResult listAuditMitigationActionsExecutions(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest)
Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
listAuditMitigationActionsExecutionsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListAuditMitigationActionsTasksResult listAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest)
Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
listAuditMitigationActionsTasksRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListAuditSuppressionsResult listAuditSuppressions(ListAuditSuppressionsRequest listAuditSuppressionsRequest)
Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
listAuditSuppressionsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListAuditTasksResult listAuditTasks(ListAuditTasksRequest listAuditTasksRequest)
Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
listAuditTasksRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListAuthorizersResult listAuthorizers(ListAuthorizersRequest listAuthorizersRequest)
Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
listAuthorizersRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListBillingGroupsResult listBillingGroups(ListBillingGroupsRequest listBillingGroupsRequest)
Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
listBillingGroupsRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ListCACertificatesResult listCACertificates(ListCACertificatesRequest listCACertificatesRequest)
Lists the CA certificates registered for your Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCACertificates action.
listCACertificatesRequest
- Input for the ListCACertificates operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListCertificateProvidersResult listCertificateProviders(ListCertificateProvidersRequest listCertificateProvidersRequest)
Lists all your certificate providers in your Amazon Web Services account.
Requires permission to access the ListCertificateProviders action.
listCertificateProvidersRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListCertificatesResult listCertificates(ListCertificatesRequest listCertificatesRequest)
Lists the certificates registered in your Amazon Web Services account.
The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
Requires permission to access the ListCertificates action.
listCertificatesRequest
- The input for the ListCertificates operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListCertificatesByCAResult listCertificatesByCA(ListCertificatesByCARequest listCertificatesByCARequest)
List the device certificates signed by the specified CA certificate.
Requires permission to access the ListCertificatesByCA action.
listCertificatesByCARequest
- The input to the ListCertificatesByCA operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListCustomMetricsResult listCustomMetrics(ListCustomMetricsRequest listCustomMetricsRequest)
Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
listCustomMetricsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListDetectMitigationActionsExecutionsResult listDetectMitigationActionsExecutions(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest)
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
listDetectMitigationActionsExecutionsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListDetectMitigationActionsTasksResult listDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest)
List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
listDetectMitigationActionsTasksRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListDimensionsResult listDimensions(ListDimensionsRequest listDimensionsRequest)
List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
listDimensionsRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.ListDomainConfigurationsResult listDomainConfigurations(ListDomainConfigurationsRequest listDomainConfigurationsRequest)
Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.
Requires permission to access the ListDomainConfigurations action.
listDomainConfigurationsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListFleetMetricsResult listFleetMetrics(ListFleetMetricsRequest listFleetMetricsRequest)
Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
listFleetMetricsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListIndicesResult listIndices(ListIndicesRequest listIndicesRequest)
Lists the search indices.
Requires permission to access the ListIndices action.
listIndicesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListJobExecutionsForJobResult listJobExecutionsForJob(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest)
Lists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
listJobExecutionsForJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.ListJobExecutionsForThingResult listJobExecutionsForThing(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest)
Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
listJobExecutionsForThingRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest)
Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
listJobTemplatesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListJobsResult listJobs(ListJobsRequest listJobsRequest)
Lists jobs.
Requires permission to access the ListJobs action.
listJobsRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.ListManagedJobTemplatesResult listManagedJobTemplates(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest)
Returns a list of managed job templates.
listManagedJobTemplatesRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ListMetricValuesResult listMetricValues(ListMetricValuesRequest listMetricValuesRequest)
Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.
listMetricValuesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ListMitigationActionsResult listMitigationActions(ListMitigationActionsRequest listMitigationActionsRequest)
Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
listMitigationActionsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListOTAUpdatesResult listOTAUpdates(ListOTAUpdatesRequest listOTAUpdatesRequest)
Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
listOTAUpdatesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ServiceUnavailableException
- The service is temporarily unavailable.ListOutgoingCertificatesResult listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest)
Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
listOutgoingCertificatesRequest
- The input to the ListOutgoingCertificates operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListPackageVersionsResult listPackageVersions(ListPackageVersionsRequest listPackageVersionsRequest)
Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
listPackageVersionsRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ListPackagesResult listPackages(ListPackagesRequest listPackagesRequest)
Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
listPackagesRequest
- ThrottlingException
- The rate exceeds the limit.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ListPoliciesResult listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists your policies.
Requires permission to access the ListPolicies action.
listPoliciesRequest
- The input for the ListPolicies operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.@Deprecated ListPolicyPrincipalsResult listPolicyPrincipals(ListPolicyPrincipalsRequest listPolicyPrincipalsRequest)
Lists the principals associated with the specified policy.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListTargetsForPolicy instead.
Requires permission to access the ListPolicyPrincipals action.
listPolicyPrincipalsRequest
- The input for the ListPolicyPrincipals operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListPolicyVersionsResult listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists the versions of the specified policy and identifies the default version.
Requires permission to access the ListPolicyVersions action.
listPolicyVersionsRequest
- The input for the ListPolicyVersions operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.@Deprecated ListPrincipalPoliciesResult listPrincipalPolicies(ListPrincipalPoliciesRequest listPrincipalPoliciesRequest)
Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.
Note: This action is deprecated and works as expected for backward compatibility, but we won't add enhancements. Use ListAttachedPolicies instead.
Requires permission to access the ListPrincipalPolicies action.
listPrincipalPoliciesRequest
- The input for the ListPrincipalPolicies operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListPrincipalThingsResult listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest)
Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the ListPrincipalThings action.
listPrincipalThingsRequest
- The input for the ListPrincipalThings operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ListProvisioningTemplateVersionsResult listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest)
A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
listProvisioningTemplateVersionsRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.ListProvisioningTemplatesResult listProvisioningTemplates(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest)
Lists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
listProvisioningTemplatesRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ListRelatedResourcesForAuditFindingResult listRelatedResourcesForAuditFinding(ListRelatedResourcesForAuditFindingRequest listRelatedResourcesForAuditFindingRequest)
The related resources of an Audit finding. The following resources can be returned from calling this API:
DEVICE_CERTIFICATE
CA_CERTIFICATE
IOT_POLICY
COGNITO_IDENTITY_POOL
CLIENT_ID
ACCOUNT_SETTINGS
ROLE_ALIAS
IAM_ROLE
ISSUER_CERTIFICATE
This API is similar to DescribeAuditFinding's RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.
listRelatedResourcesForAuditFindingRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListRoleAliasesResult listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest)
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
listRoleAliasesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListScheduledAuditsResult listScheduledAudits(ListScheduledAuditsRequest listScheduledAuditsRequest)
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
listScheduledAuditsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListSecurityProfilesResult listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest)
Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.
Requires permission to access the ListSecurityProfiles action.
dimensionName
and metricName
cannot be used in the same request.
listSecurityProfilesRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ListSecurityProfilesForTargetResult listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest)
Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
listSecurityProfilesForTargetRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest)
Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
listStreamsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
listTagsForResourceRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ListTargetsForPolicyResult listTargetsForPolicy(ListTargetsForPolicyRequest listTargetsForPolicyRequest)
List targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
listTargetsForPolicyRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.ListTargetsForSecurityProfileResult listTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest)
Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
listTargetsForSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ListThingGroupsResult listThingGroups(ListThingGroupsRequest listThingGroupsRequest)
List the thing groups in your account.
Requires permission to access the ListThingGroups action.
listThingGroupsRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ListThingGroupsForThingResult listThingGroupsForThing(ListThingGroupsForThingRequest listThingGroupsForThingRequest)
List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
listThingGroupsForThingRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ListThingPrincipalsResult listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest)
Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
Requires permission to access the ListThingPrincipals action.
listThingPrincipalsRequest
- The input for the ListThingPrincipal operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ListThingRegistrationTaskReportsResult listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest)
Information about the thing registration tasks.
listThingRegistrationTaskReportsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ListThingRegistrationTasksResult listThingRegistrationTasks(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest)
List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
listThingRegistrationTasksRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ListThingTypesResult listThingTypes(ListThingTypesRequest listThingTypesRequest)
Lists the existing thing types.
Requires permission to access the ListThingTypes action.
listThingTypesRequest
- The input for the ListThingTypes operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListThingsResult listThings(ListThingsRequest listThingsRequest)
Lists your things. Use the attributeName and attributeValue parameters to filter your things. For
example, calling ListThings
with attributeName=Color and attributeValue=Red retrieves all things in
the registry that contain an attribute Color with the value Red. For more information, see List Things from
the Amazon Web Services IoT Core Developer Guide.
Requires permission to access the ListThings action.
You will not be charged for calling this API if an Access denied
error is returned. You will also
not be charged if no attributes or pagination token was provided in request and no pagination token and no
results were returned.
listThingsRequest
- The input for the ListThings operation.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ListThingsInBillingGroupResult listThingsInBillingGroup(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest)
Lists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
listThingsInBillingGroupRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ListThingsInThingGroupResult listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest)
Lists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
listThingsInThingGroupRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ListTopicRuleDestinationsResult listTopicRuleDestinations(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest)
Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
listTopicRuleDestinationsRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ListTopicRulesResult listTopicRules(ListTopicRulesRequest listTopicRulesRequest)
Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
listTopicRulesRequest
- The input for the ListTopicRules operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.ListV2LoggingLevelsResult listV2LoggingLevels(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest)
Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.
listV2LoggingLevelsRequest
- InternalException
- An unexpected error has occurred.NotConfiguredException
- The resource is not configured.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.ListViolationEventsResult listViolationEvents(ListViolationEventsRequest listViolationEventsRequest)
Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).
Requires permission to access the ListViolationEvents action.
listViolationEventsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.PutVerificationStateOnViolationResult putVerificationStateOnViolation(PutVerificationStateOnViolationRequest putVerificationStateOnViolationRequest)
Set a verification state and provide a description of that verification state on a violation (detect alarm).
putVerificationStateOnViolationRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.RegisterCACertificateResult registerCACertificate(RegisterCACertificateRequest registerCACertificateRequest)
Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates
you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same
CA subject field
per Amazon Web Services account.
Requires permission to access the RegisterCACertificate action.
registerCACertificateRequest
- The input to the RegisterCACertificate operation.ResourceNotFoundException
- The specified resource does not exist.ResourceAlreadyExistsException
- The resource already exists.RegistrationCodeValidationException
- The registration code is invalid.InvalidRequestException
- The request is not valid.CertificateValidationException
- The certificate is invalid.ThrottlingException
- The rate exceeds the limit.LimitExceededException
- A limit has been exceeded.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.RegisterCertificateResult registerCertificate(RegisterCertificateRequest registerCertificateRequest)
Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
Requires permission to access the RegisterCertificate action.
registerCertificateRequest
- The input to the RegisterCertificate operation.ResourceAlreadyExistsException
- The resource already exists.InvalidRequestException
- The request is not valid.CertificateValidationException
- The certificate is invalid.CertificateStateException
- The certificate operation is not allowed.CertificateConflictException
- Unable to verify the CA certificate used to sign the device certificate you are attempting to register.
This is happens when you have registered more than one CA certificate that has the same subject field and
public key.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.RegisterCertificateWithoutCAResult registerCertificateWithoutCA(RegisterCertificateWithoutCARequest registerCertificateWithoutCARequest)
Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.
registerCertificateWithoutCARequest
- ResourceAlreadyExistsException
- The resource already exists.InvalidRequestException
- The request is not valid.CertificateStateException
- The certificate operation is not allowed.CertificateValidationException
- The certificate is invalid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.RegisterThingResult registerThing(RegisterThingRequest registerThingRequest)
Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.
Requires permission to access the RegisterThing action.
registerThingRequest
- InternalFailureException
- An unexpected error has occurred.ServiceUnavailableException
- The service is temporarily unavailable.InvalidRequestException
- The request is not valid.UnauthorizedException
- You are not authorized to perform this operation.ThrottlingException
- The rate exceeds the limit.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.ResourceRegistrationFailureException
- The resource registration failed.RejectCertificateTransferResult rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest)
Rejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.
To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
Requires permission to access the RejectCertificateTransfer action.
rejectCertificateTransferRequest
- The input for the RejectCertificateTransfer operation.ResourceNotFoundException
- The specified resource does not exist.TransferAlreadyCompletedException
- You can't revert the certificate transfer because the transfer is already complete.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.RemoveThingFromBillingGroupResult removeThingFromBillingGroup(RemoveThingFromBillingGroupRequest removeThingFromBillingGroupRequest)
Removes the given thing from the billing group.
Requires permission to access the RemoveThingFromBillingGroup action.
This call is asynchronous. It might take several seconds for the detachment to propagate.
removeThingFromBillingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.RemoveThingFromThingGroupResult removeThingFromThingGroup(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest)
Remove the specified thing from the specified group.
You must specify either a thingGroupArn
or a thingGroupName
to identify the thing group
and either a thingArn
or a thingName
to identify the thing to remove from the thing
group.
Requires permission to access the RemoveThingFromThingGroup action.
removeThingFromThingGroupRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ReplaceTopicRuleResult replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest)
Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
Requires permission to access the ReplaceTopicRule action.
replaceTopicRuleRequest
- The input for the ReplaceTopicRule operation.SqlParseException
- The Rule-SQL expression can't be parsed correctly.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.SearchIndexResult searchIndex(SearchIndexRequest searchIndexRequest)
The query search index.
Requires permission to access the SearchIndex action.
searchIndexRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.IndexNotReadyException
- The index is not ready.SetDefaultAuthorizerResult setDefaultAuthorizer(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest)
Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
Requires permission to access the SetDefaultAuthorizer action.
setDefaultAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceAlreadyExistsException
- The resource already exists.SetDefaultPolicyVersionResult setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action.
Requires permission to access the SetDefaultPolicyVersion action.
setDefaultPolicyVersionRequest
- The input for the SetDefaultPolicyVersion operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.SetLoggingOptionsResult setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest)
Sets the logging options.
NOTE: use of this command is not recommended. Use SetV2LoggingOptions
instead.
Requires permission to access the SetLoggingOptions action.
setLoggingOptionsRequest
- The input for the SetLoggingOptions operation.InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.SetV2LoggingLevelResult setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest)
Sets the logging level.
Requires permission to access the SetV2LoggingLevel action.
setV2LoggingLevelRequest
- InternalException
- An unexpected error has occurred.NotConfiguredException
- The resource is not configured.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.LimitExceededException
- A limit has been exceeded.SetV2LoggingOptionsResult setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest)
Sets the logging options for the V2 logging service.
Requires permission to access the SetV2LoggingOptions action.
setV2LoggingOptionsRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.StartAuditMitigationActionsTaskResult startAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest startAuditMitigationActionsTaskRequest)
Starts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
startAuditMitigationActionsTaskRequest
- InvalidRequestException
- The request is not valid.TaskAlreadyExistsException
- This exception occurs if you attempt to start a task with the same task-id as an existing task but with a
different clientRequestToken.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.StartDetectMitigationActionsTaskResult startDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest startDetectMitigationActionsTaskRequest)
Starts a Device Defender ML Detect mitigation actions task.
Requires permission to access the StartDetectMitigationActionsTask action.
startDetectMitigationActionsTaskRequest
- InvalidRequestException
- The request is not valid.TaskAlreadyExistsException
- This exception occurs if you attempt to start a task with the same task-id as an existing task but with a
different clientRequestToken.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.StartOnDemandAuditTaskResult startOnDemandAuditTask(StartOnDemandAuditTaskRequest startOnDemandAuditTaskRequest)
Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
startOnDemandAuditTaskRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.StartThingRegistrationTaskResult startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest)
Creates a bulk thing provisioning task.
Requires permission to access the StartThingRegistrationTask action.
startThingRegistrationTaskRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.StopThingRegistrationTaskResult stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest)
Cancels a bulk thing provisioning task.
Requires permission to access the StopThingRegistrationTask action.
stopThingRegistrationTaskRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
Requires permission to access the TagResource action.
tagResourceRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.LimitExceededException
- A limit has been exceeded.TestAuthorizationResult testAuthorization(TestAuthorizationRequest testAuthorizationRequest)
Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.
Requires permission to access the TestAuthorization action.
testAuthorizationRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.LimitExceededException
- A limit has been exceeded.TestInvokeAuthorizerResult testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway.
Requires permission to access the TestInvokeAuthorizer action.
testInvokeAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.InvalidResponseException
- The response is invalid.TransferCertificateResult transferCertificate(TransferCertificateRequest transferCertificateRequest)
Transfers the specified certificate to the specified Amazon Web Services account.
Requires permission to access the TransferCertificate action.
You can cancel the transfer until it is acknowledged by the recipient.
No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.
The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate action to deactivate it.
The certificate must not have any policies attached to it. You can use the DetachPolicy action to detach them.
transferCertificateRequest
- The input for the TransferCertificate operation.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.CertificateStateException
- The certificate operation is not allowed.TransferConflictException
- You can't transfer the certificate because authorization policies are still attached.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes the given tags (metadata) from the resource.
Requires permission to access the UntagResource action.
untagResourceRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UpdateAccountAuditConfigurationResult updateAccountAuditConfiguration(UpdateAccountAuditConfigurationRequest updateAccountAuditConfigurationRequest)
Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
Requires permission to access the UpdateAccountAuditConfiguration action.
updateAccountAuditConfigurationRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.UpdateAuditSuppressionResult updateAuditSuppression(UpdateAuditSuppressionRequest updateAuditSuppressionRequest)
Updates a Device Defender audit suppression.
updateAuditSuppressionRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.UpdateAuthorizerResult updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an authorizer.
Requires permission to access the UpdateAuthorizer action.
updateAuthorizerRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.LimitExceededException
- A limit has been exceeded.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.UpdateBillingGroupResult updateBillingGroup(UpdateBillingGroupRequest updateBillingGroupRequest)
Updates information about the billing group.
Requires permission to access the UpdateBillingGroup action.
updateBillingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.UpdateCACertificateResult updateCACertificate(UpdateCACertificateRequest updateCACertificateRequest)
Updates a registered CA certificate.
Requires permission to access the UpdateCACertificate action.
updateCACertificateRequest
- The input to the UpdateCACertificate operation.ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.UpdateCertificateResult updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the status of the specified certificate. This operation is idempotent.
Requires permission to access the UpdateCertificate action.
Certificates must be in the ACTIVE state to authenticate devices that use a certificate to connect to IoT.
Within a few minutes of updating a certificate from the ACTIVE state to any other state, IoT disconnects all devices that used that certificate to connect. Devices cannot use a certificate that is not in the ACTIVE state to reconnect.
updateCertificateRequest
- The input for the UpdateCertificate operation.ResourceNotFoundException
- The specified resource does not exist.CertificateStateException
- The certificate operation is not allowed.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.UpdateCertificateProviderResult updateCertificateProvider(UpdateCertificateProviderRequest updateCertificateProviderRequest)
Updates a certificate provider.
Requires permission to access the UpdateCertificateProvider action.
updateCertificateProviderRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.UpdateCustomMetricResult updateCustomMetric(UpdateCustomMetricRequest updateCustomMetricRequest)
Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
updateCustomMetricRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.UpdateDimensionResult updateDimension(UpdateDimensionRequest updateDimensionRequest)
Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).
Requires permission to access the UpdateDimension action.
updateDimensionRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UpdateDomainConfigurationResult updateDomainConfiguration(UpdateDomainConfigurationRequest updateDomainConfigurationRequest)
Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
Requires permission to access the UpdateDomainConfiguration action.
updateDomainConfigurationRequest
- ResourceNotFoundException
- The specified resource does not exist.CertificateValidationException
- The certificate is invalid.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.UpdateDynamicThingGroupResult updateDynamicThingGroup(UpdateDynamicThingGroupRequest updateDynamicThingGroupRequest)
Updates a dynamic thing group.
Requires permission to access the UpdateDynamicThingGroup action.
updateDynamicThingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.UpdateEventConfigurationsResult updateEventConfigurations(UpdateEventConfigurationsRequest updateEventConfigurationsRequest)
Updates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
updateEventConfigurationsRequest
- InvalidRequestException
- The request is not valid.InternalFailureException
- An unexpected error has occurred.ThrottlingException
- The rate exceeds the limit.UpdateFleetMetricResult updateFleetMetric(UpdateFleetMetricRequest updateFleetMetricRequest)
Updates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
updateFleetMetricRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.InvalidQueryException
- The query is invalid.InvalidAggregationException
- The aggregation is invalid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.IndexNotReadyException
- The index is not ready.UpdateIndexingConfigurationResult updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest)
Updates the search configuration.
Requires permission to access the UpdateIndexingConfiguration action.
updateIndexingConfigurationRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.UpdateJobResult updateJob(UpdateJobRequest updateJobRequest)
Updates supported fields of the specified job.
Requires permission to access the UpdateJob action.
updateJobRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.ServiceUnavailableException
- The service is temporarily unavailable.UpdateMitigationActionResult updateMitigationAction(UpdateMitigationActionRequest updateMitigationActionRequest)
Updates the definition for the specified mitigation action.
Requires permission to access the UpdateMitigationAction action.
updateMitigationActionRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.UpdatePackageResult updatePackage(UpdatePackageRequest updatePackageRequest)
Updates the supported fields for a specific software package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
updatePackageRequest
- ThrottlingException
- The rate exceeds the limit.ConflictException
- A resource with the same name already exists.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.UpdatePackageConfigurationResult updatePackageConfiguration(UpdatePackageConfigurationRequest updatePackageConfigurationRequest)
Updates the software package configuration.
Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
updatePackageConfigurationRequest
- ThrottlingException
- The rate exceeds the limit.ConflictException
- A resource with the same name already exists.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.UpdatePackageVersionResult updatePackageVersion(UpdatePackageVersionRequest updatePackageVersionRequest)
Updates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
updatePackageVersionRequest
- ThrottlingException
- The rate exceeds the limit.ConflictException
- A resource with the same name already exists.InternalServerException
- Internal error from the service that indicates an unexpected error or that the service is unavailable.ValidationException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.UpdateProvisioningTemplateResult updateProvisioningTemplate(UpdateProvisioningTemplateRequest updateProvisioningTemplateRequest)
Updates a provisioning template.
Requires permission to access the UpdateProvisioningTemplate action.
updateProvisioningTemplateRequest
- InternalFailureException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.UpdateRoleAliasResult updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest)
Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
updateRoleAliasRequest
- ResourceNotFoundException
- The specified resource does not exist.InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.UpdateScheduledAuditResult updateScheduledAudit(UpdateScheduledAuditRequest updateScheduledAuditRequest)
Updates a scheduled audit, including which checks are performed and how often the audit takes place.
Requires permission to access the UpdateScheduledAudit action.
updateScheduledAuditRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.UpdateSecurityProfileResult updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest)
Updates a Device Defender security profile.
Requires permission to access the UpdateSecurityProfile action.
updateSecurityProfileRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.UpdateStreamResult updateStream(UpdateStreamRequest updateStreamRequest)
Updates an existing stream. The stream version will be incremented by one.
Requires permission to access the UpdateStream action.
updateStreamRequest
- InvalidRequestException
- The request is not valid.ResourceNotFoundException
- The specified resource does not exist.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.UpdateThingResult updateThing(UpdateThingRequest updateThingRequest)
Updates the data for a thing.
Requires permission to access the UpdateThing action.
updateThingRequest
- The input for the UpdateThing operation.InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.UnauthorizedException
- You are not authorized to perform this operation.ServiceUnavailableException
- The service is temporarily unavailable.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.UpdateThingGroupResult updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest)
Update a thing group.
Requires permission to access the UpdateThingGroup action.
updateThingGroupRequest
- InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with the expectedVersion
parameter does not match the latest version in the system.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.UpdateThingGroupsForThingResult updateThingGroupsForThing(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest)
Updates the groups to which the thing belongs.
Requires permission to access the UpdateThingGroupsForThing action.
updateThingGroupsForThingRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.ResourceNotFoundException
- The specified resource does not exist.UpdateTopicRuleDestinationResult updateTopicRuleDestination(UpdateTopicRuleDestinationRequest updateTopicRuleDestinationRequest)
Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.
Requires permission to access the UpdateTopicRuleDestination action.
updateTopicRuleDestinationRequest
- InternalException
- An unexpected error has occurred.InvalidRequestException
- The request is not valid.ServiceUnavailableException
- The service is temporarily unavailable.UnauthorizedException
- You are not authorized to perform this operation.ConflictingResourceUpdateException
- A conflicting resource update exception. This exception is thrown when two pending updates cause a
conflict.ValidateSecurityProfileBehaviorsResult validateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest validateSecurityProfileBehaviorsRequest)
Validates a Device Defender security profile behaviors specification.
Requires permission to access the ValidateSecurityProfileBehaviors action.
validateSecurityProfileBehaviorsRequest
- InvalidRequestException
- The request is not valid.ThrottlingException
- The rate exceeds the limit.InternalFailureException
- An unexpected error has occurred.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.