Interface IotAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionacceptCertificateTransfer
(Consumer<AcceptCertificateTransferRequest.Builder> acceptCertificateTransferRequest) Accepts a pending certificate transfer.acceptCertificateTransfer
(AcceptCertificateTransferRequest acceptCertificateTransferRequest) Accepts a pending certificate transfer.addThingToBillingGroup
(Consumer<AddThingToBillingGroupRequest.Builder> addThingToBillingGroupRequest) Adds a thing to a billing group.addThingToBillingGroup
(AddThingToBillingGroupRequest addThingToBillingGroupRequest) Adds a thing to a billing group.addThingToThingGroup
(Consumer<AddThingToThingGroupRequest.Builder> addThingToThingGroupRequest) Adds a thing to a thing group.addThingToThingGroup
(AddThingToThingGroupRequest addThingToThingGroupRequest) Adds a thing to a thing group.associateSbomWithPackageVersion
(Consumer<AssociateSbomWithPackageVersionRequest.Builder> associateSbomWithPackageVersionRequest) Associates the selected software bill of materials (SBOM) with a specific software package version.associateSbomWithPackageVersion
(AssociateSbomWithPackageVersionRequest associateSbomWithPackageVersionRequest) Associates the selected software bill of materials (SBOM) with a specific software package version.associateTargetsWithJob
(Consumer<AssociateTargetsWithJobRequest.Builder> associateTargetsWithJobRequest) Associates a group with a continuous job.associateTargetsWithJob
(AssociateTargetsWithJobRequest associateTargetsWithJobRequest) Associates a group with a continuous job.default CompletableFuture
<AttachPolicyResponse> attachPolicy
(Consumer<AttachPolicyRequest.Builder> attachPolicyRequest) Attaches the specified policy to the specified principal (certificate or other credential).default CompletableFuture
<AttachPolicyResponse> attachPolicy
(AttachPolicyRequest attachPolicyRequest) Attaches the specified policy to the specified principal (certificate or other credential).attachSecurityProfile
(Consumer<AttachSecurityProfileRequest.Builder> attachSecurityProfileRequest) Associates a Device Defender security profile with a thing group or this account.attachSecurityProfile
(AttachSecurityProfileRequest attachSecurityProfileRequest) Associates a Device Defender security profile with a thing group or this account.attachThingPrincipal
(Consumer<AttachThingPrincipalRequest.Builder> attachThingPrincipalRequest) Attaches the specified principal to the specified thing.attachThingPrincipal
(AttachThingPrincipalRequest attachThingPrincipalRequest) Attaches the specified principal to the specified thing.static IotAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aIotAsyncClient
.cancelAuditMitigationActionsTask
(Consumer<CancelAuditMitigationActionsTaskRequest.Builder> cancelAuditMitigationActionsTaskRequest) Cancels a mitigation action task that is in progress.cancelAuditMitigationActionsTask
(CancelAuditMitigationActionsTaskRequest cancelAuditMitigationActionsTaskRequest) Cancels a mitigation action task that is in progress.default CompletableFuture
<CancelAuditTaskResponse> cancelAuditTask
(Consumer<CancelAuditTaskRequest.Builder> cancelAuditTaskRequest) Cancels an audit that is in progress.default CompletableFuture
<CancelAuditTaskResponse> cancelAuditTask
(CancelAuditTaskRequest cancelAuditTaskRequest) Cancels an audit that is in progress.cancelCertificateTransfer
(Consumer<CancelCertificateTransferRequest.Builder> cancelCertificateTransferRequest) Cancels a pending transfer for the specified certificate.cancelCertificateTransfer
(CancelCertificateTransferRequest cancelCertificateTransferRequest) Cancels a pending transfer for the specified certificate.cancelDetectMitigationActionsTask
(Consumer<CancelDetectMitigationActionsTaskRequest.Builder> cancelDetectMitigationActionsTaskRequest) Cancels a Device Defender ML Detect mitigation action.cancelDetectMitigationActionsTask
(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest) Cancels a Device Defender ML Detect mitigation action.default CompletableFuture
<CancelJobResponse> cancelJob
(Consumer<CancelJobRequest.Builder> cancelJobRequest) Cancels a job.default CompletableFuture
<CancelJobResponse> cancelJob
(CancelJobRequest cancelJobRequest) Cancels a job.cancelJobExecution
(Consumer<CancelJobExecutionRequest.Builder> cancelJobExecutionRequest) Cancels the execution of a job for a given thing.cancelJobExecution
(CancelJobExecutionRequest cancelJobExecutionRequest) Cancels the execution of a job for a given thing.Clears the default authorizer.clearDefaultAuthorizer
(Consumer<ClearDefaultAuthorizerRequest.Builder> clearDefaultAuthorizerRequest) Clears the default authorizer.clearDefaultAuthorizer
(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest) Clears the default authorizer.confirmTopicRuleDestination
(Consumer<ConfirmTopicRuleDestinationRequest.Builder> confirmTopicRuleDestinationRequest) Confirms a topic rule destination.confirmTopicRuleDestination
(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest) Confirms a topic rule destination.static IotAsyncClient
create()
Create aIotAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAuditSuppression
(Consumer<CreateAuditSuppressionRequest.Builder> createAuditSuppressionRequest) Creates a Device Defender audit suppression.createAuditSuppression
(CreateAuditSuppressionRequest createAuditSuppressionRequest) Creates a Device Defender audit suppression.createAuthorizer
(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest) Creates an authorizer.createAuthorizer
(CreateAuthorizerRequest createAuthorizerRequest) Creates an authorizer.createBillingGroup
(Consumer<CreateBillingGroupRequest.Builder> createBillingGroupRequest) Creates a billing group.createBillingGroup
(CreateBillingGroupRequest createBillingGroupRequest) Creates a billing group.createCertificateFromCsr
(Consumer<CreateCertificateFromCsrRequest.Builder> createCertificateFromCsrRequest) Creates an X.509 certificate using the specified certificate signing request.createCertificateFromCsr
(CreateCertificateFromCsrRequest createCertificateFromCsrRequest) Creates an X.509 certificate using the specified certificate signing request.createCertificateProvider
(Consumer<CreateCertificateProviderRequest.Builder> createCertificateProviderRequest) Creates an Amazon Web Services IoT Core certificate provider.createCertificateProvider
(CreateCertificateProviderRequest createCertificateProviderRequest) Creates an Amazon Web Services IoT Core certificate provider.createCustomMetric
(Consumer<CreateCustomMetricRequest.Builder> createCustomMetricRequest) Use this API to define a Custom Metric published by your devices to Device Defender.createCustomMetric
(CreateCustomMetricRequest createCustomMetricRequest) Use this API to define a Custom Metric published by your devices to Device Defender.default CompletableFuture
<CreateDimensionResponse> createDimension
(Consumer<CreateDimensionRequest.Builder> createDimensionRequest) Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender.default CompletableFuture
<CreateDimensionResponse> 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.createDomainConfiguration
(Consumer<CreateDomainConfigurationRequest.Builder> createDomainConfigurationRequest) Creates a domain configuration.createDomainConfiguration
(CreateDomainConfigurationRequest createDomainConfigurationRequest) Creates a domain configuration.createDynamicThingGroup
(Consumer<CreateDynamicThingGroupRequest.Builder> createDynamicThingGroupRequest) Creates a dynamic thing group.createDynamicThingGroup
(CreateDynamicThingGroupRequest createDynamicThingGroupRequest) Creates a dynamic thing group.createFleetMetric
(Consumer<CreateFleetMetricRequest.Builder> createFleetMetricRequest) Creates a fleet metric.createFleetMetric
(CreateFleetMetricRequest createFleetMetricRequest) Creates a fleet metric.default CompletableFuture
<CreateJobResponse> createJob
(Consumer<CreateJobRequest.Builder> createJobRequest) Creates a job.default CompletableFuture
<CreateJobResponse> createJob
(CreateJobRequest createJobRequest) Creates a job.createJobTemplate
(Consumer<CreateJobTemplateRequest.Builder> createJobTemplateRequest) Creates a job template.createJobTemplate
(CreateJobTemplateRequest createJobTemplateRequest) Creates a job template.Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.createKeysAndCertificate
(Consumer<CreateKeysAndCertificateRequest.Builder> createKeysAndCertificateRequest) Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.createKeysAndCertificate
(CreateKeysAndCertificateRequest createKeysAndCertificateRequest) Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.createMitigationAction
(Consumer<CreateMitigationActionRequest.Builder> createMitigationActionRequest) Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.createMitigationAction
(CreateMitigationActionRequest createMitigationActionRequest) Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.default CompletableFuture
<CreateOtaUpdateResponse> createOTAUpdate
(Consumer<CreateOtaUpdateRequest.Builder> createOtaUpdateRequest) Creates an IoT OTA update on a target group of things or groups.default CompletableFuture
<CreateOtaUpdateResponse> createOTAUpdate
(CreateOtaUpdateRequest createOtaUpdateRequest) Creates an IoT OTA update on a target group of things or groups.default CompletableFuture
<CreatePackageResponse> createPackage
(Consumer<CreatePackageRequest.Builder> createPackageRequest) Creates an IoT software package that can be deployed to your fleet.default CompletableFuture
<CreatePackageResponse> createPackage
(CreatePackageRequest createPackageRequest) Creates an IoT software package that can be deployed to your fleet.createPackageVersion
(Consumer<CreatePackageVersionRequest.Builder> createPackageVersionRequest) Creates a new version for an existing IoT software package.createPackageVersion
(CreatePackageVersionRequest createPackageVersionRequest) Creates a new version for an existing IoT software package.default CompletableFuture
<CreatePolicyResponse> createPolicy
(Consumer<CreatePolicyRequest.Builder> createPolicyRequest) Creates an IoT policy.default CompletableFuture
<CreatePolicyResponse> createPolicy
(CreatePolicyRequest createPolicyRequest) Creates an IoT policy.createPolicyVersion
(Consumer<CreatePolicyVersionRequest.Builder> createPolicyVersionRequest) Creates a new version of the specified IoT policy.createPolicyVersion
(CreatePolicyVersionRequest createPolicyVersionRequest) Creates a new version of the specified IoT policy.createProvisioningClaim
(Consumer<CreateProvisioningClaimRequest.Builder> createProvisioningClaimRequest) Creates a provisioning claim.createProvisioningClaim
(CreateProvisioningClaimRequest createProvisioningClaimRequest) Creates a provisioning claim.createProvisioningTemplate
(Consumer<CreateProvisioningTemplateRequest.Builder> createProvisioningTemplateRequest) Creates a provisioning template.createProvisioningTemplate
(CreateProvisioningTemplateRequest createProvisioningTemplateRequest) Creates a provisioning template.createProvisioningTemplateVersion
(Consumer<CreateProvisioningTemplateVersionRequest.Builder> createProvisioningTemplateVersionRequest) Creates a new version of a provisioning template.createProvisioningTemplateVersion
(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest) Creates a new version of a provisioning template.default CompletableFuture
<CreateRoleAliasResponse> createRoleAlias
(Consumer<CreateRoleAliasRequest.Builder> createRoleAliasRequest) Creates a role alias.default CompletableFuture
<CreateRoleAliasResponse> createRoleAlias
(CreateRoleAliasRequest createRoleAliasRequest) Creates a role alias.createScheduledAudit
(Consumer<CreateScheduledAuditRequest.Builder> createScheduledAuditRequest) Creates a scheduled audit that is run at a specified time interval.createScheduledAudit
(CreateScheduledAuditRequest createScheduledAuditRequest) Creates a scheduled audit that is run at a specified time interval.createSecurityProfile
(Consumer<CreateSecurityProfileRequest.Builder> createSecurityProfileRequest) Creates a Device Defender security profile.createSecurityProfile
(CreateSecurityProfileRequest createSecurityProfileRequest) Creates a Device Defender security profile.default CompletableFuture
<CreateStreamResponse> createStream
(Consumer<CreateStreamRequest.Builder> createStreamRequest) Creates a stream for delivering one or more large files in chunks over MQTT.default CompletableFuture
<CreateStreamResponse> createStream
(CreateStreamRequest createStreamRequest) Creates a stream for delivering one or more large files in chunks over MQTT.default CompletableFuture
<CreateThingResponse> createThing
(Consumer<CreateThingRequest.Builder> createThingRequest) Creates a thing record in the registry.default CompletableFuture
<CreateThingResponse> createThing
(CreateThingRequest createThingRequest) Creates a thing record in the registry.createThingGroup
(Consumer<CreateThingGroupRequest.Builder> createThingGroupRequest) Create a thing group.createThingGroup
(CreateThingGroupRequest createThingGroupRequest) Create a thing group.default CompletableFuture
<CreateThingTypeResponse> createThingType
(Consumer<CreateThingTypeRequest.Builder> createThingTypeRequest) Creates a new thing type.default CompletableFuture
<CreateThingTypeResponse> createThingType
(CreateThingTypeRequest createThingTypeRequest) Creates a new thing type.default CompletableFuture
<CreateTopicRuleResponse> createTopicRule
(Consumer<CreateTopicRuleRequest.Builder> createTopicRuleRequest) Creates a rule.default CompletableFuture
<CreateTopicRuleResponse> createTopicRule
(CreateTopicRuleRequest createTopicRuleRequest) Creates a rule.createTopicRuleDestination
(Consumer<CreateTopicRuleDestinationRequest.Builder> createTopicRuleDestinationRequest) Creates a topic rule destination.createTopicRuleDestination
(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest) Creates a topic rule destination.Restores the default settings for Device Defender audits for this account.deleteAccountAuditConfiguration
(Consumer<DeleteAccountAuditConfigurationRequest.Builder> deleteAccountAuditConfigurationRequest) Restores the default settings for Device Defender audits for this account.deleteAccountAuditConfiguration
(DeleteAccountAuditConfigurationRequest deleteAccountAuditConfigurationRequest) Restores the default settings for Device Defender audits for this account.deleteAuditSuppression
(Consumer<DeleteAuditSuppressionRequest.Builder> deleteAuditSuppressionRequest) Deletes a Device Defender audit suppression.deleteAuditSuppression
(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest) Deletes a Device Defender audit suppression.deleteAuthorizer
(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest) Deletes an authorizer.deleteAuthorizer
(DeleteAuthorizerRequest deleteAuthorizerRequest) Deletes an authorizer.deleteBillingGroup
(Consumer<DeleteBillingGroupRequest.Builder> deleteBillingGroupRequest) Deletes the billing group.deleteBillingGroup
(DeleteBillingGroupRequest deleteBillingGroupRequest) Deletes the billing group.deleteCACertificate
(Consumer<DeleteCaCertificateRequest.Builder> deleteCaCertificateRequest) Deletes a registered CA certificate.deleteCACertificate
(DeleteCaCertificateRequest deleteCaCertificateRequest) Deletes a registered CA certificate.deleteCertificate
(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) Deletes the specified certificate.deleteCertificate
(DeleteCertificateRequest deleteCertificateRequest) Deletes the specified certificate.deleteCertificateProvider
(Consumer<DeleteCertificateProviderRequest.Builder> deleteCertificateProviderRequest) Deletes a certificate provider.deleteCertificateProvider
(DeleteCertificateProviderRequest deleteCertificateProviderRequest) Deletes a certificate provider.deleteCustomMetric
(Consumer<DeleteCustomMetricRequest.Builder> deleteCustomMetricRequest) Deletes a Device Defender detect custom metric.deleteCustomMetric
(DeleteCustomMetricRequest deleteCustomMetricRequest) Deletes a Device Defender detect custom metric.default CompletableFuture
<DeleteDimensionResponse> deleteDimension
(Consumer<DeleteDimensionRequest.Builder> deleteDimensionRequest) Removes the specified dimension from your Amazon Web Services accounts.default CompletableFuture
<DeleteDimensionResponse> deleteDimension
(DeleteDimensionRequest deleteDimensionRequest) Removes the specified dimension from your Amazon Web Services accounts.deleteDomainConfiguration
(Consumer<DeleteDomainConfigurationRequest.Builder> deleteDomainConfigurationRequest) Deletes the specified domain configuration.deleteDomainConfiguration
(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest) Deletes the specified domain configuration.deleteDynamicThingGroup
(Consumer<DeleteDynamicThingGroupRequest.Builder> deleteDynamicThingGroupRequest) Deletes a dynamic thing group.deleteDynamicThingGroup
(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest) Deletes a dynamic thing group.deleteFleetMetric
(Consumer<DeleteFleetMetricRequest.Builder> deleteFleetMetricRequest) Deletes the specified fleet metric.deleteFleetMetric
(DeleteFleetMetricRequest deleteFleetMetricRequest) Deletes the specified fleet metric.default CompletableFuture
<DeleteJobResponse> deleteJob
(Consumer<DeleteJobRequest.Builder> deleteJobRequest) Deletes a job and its related job executions.default CompletableFuture
<DeleteJobResponse> deleteJob
(DeleteJobRequest deleteJobRequest) Deletes a job and its related job executions.deleteJobExecution
(Consumer<DeleteJobExecutionRequest.Builder> deleteJobExecutionRequest) Deletes a job execution.deleteJobExecution
(DeleteJobExecutionRequest deleteJobExecutionRequest) Deletes a job execution.deleteJobTemplate
(Consumer<DeleteJobTemplateRequest.Builder> deleteJobTemplateRequest) Deletes the specified job template.deleteJobTemplate
(DeleteJobTemplateRequest deleteJobTemplateRequest) Deletes the specified job template.deleteMitigationAction
(Consumer<DeleteMitigationActionRequest.Builder> deleteMitigationActionRequest) Deletes a defined mitigation action from your Amazon Web Services accounts.deleteMitigationAction
(DeleteMitigationActionRequest deleteMitigationActionRequest) Deletes a defined mitigation action from your Amazon Web Services accounts.default CompletableFuture
<DeleteOtaUpdateResponse> deleteOTAUpdate
(Consumer<DeleteOtaUpdateRequest.Builder> deleteOtaUpdateRequest) Delete an OTA update.default CompletableFuture
<DeleteOtaUpdateResponse> deleteOTAUpdate
(DeleteOtaUpdateRequest deleteOtaUpdateRequest) Delete an OTA update.default CompletableFuture
<DeletePackageResponse> deletePackage
(Consumer<DeletePackageRequest.Builder> deletePackageRequest) Deletes a specific version from a software package.default CompletableFuture
<DeletePackageResponse> deletePackage
(DeletePackageRequest deletePackageRequest) Deletes a specific version from a software package.deletePackageVersion
(Consumer<DeletePackageVersionRequest.Builder> deletePackageVersionRequest) Deletes a specific version from a software package.deletePackageVersion
(DeletePackageVersionRequest deletePackageVersionRequest) Deletes a specific version from a software package.default CompletableFuture
<DeletePolicyResponse> deletePolicy
(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) Deletes the specified policy.default CompletableFuture
<DeletePolicyResponse> deletePolicy
(DeletePolicyRequest deletePolicyRequest) Deletes the specified policy.deletePolicyVersion
(Consumer<DeletePolicyVersionRequest.Builder> deletePolicyVersionRequest) Deletes the specified version of the specified policy.deletePolicyVersion
(DeletePolicyVersionRequest deletePolicyVersionRequest) Deletes the specified version of the specified policy.deleteProvisioningTemplate
(Consumer<DeleteProvisioningTemplateRequest.Builder> deleteProvisioningTemplateRequest) Deletes a provisioning template.deleteProvisioningTemplate
(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest) Deletes a provisioning template.deleteProvisioningTemplateVersion
(Consumer<DeleteProvisioningTemplateVersionRequest.Builder> deleteProvisioningTemplateVersionRequest) Deletes a provisioning template version.deleteProvisioningTemplateVersion
(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest) Deletes a provisioning template version.Deletes a CA certificate registration code.deleteRegistrationCode
(Consumer<DeleteRegistrationCodeRequest.Builder> deleteRegistrationCodeRequest) Deletes a CA certificate registration code.deleteRegistrationCode
(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) Deletes a CA certificate registration code.default CompletableFuture
<DeleteRoleAliasResponse> deleteRoleAlias
(Consumer<DeleteRoleAliasRequest.Builder> deleteRoleAliasRequest) Deletes a role aliasdefault CompletableFuture
<DeleteRoleAliasResponse> deleteRoleAlias
(DeleteRoleAliasRequest deleteRoleAliasRequest) Deletes a role aliasdeleteScheduledAudit
(Consumer<DeleteScheduledAuditRequest.Builder> deleteScheduledAuditRequest) Deletes a scheduled audit.deleteScheduledAudit
(DeleteScheduledAuditRequest deleteScheduledAuditRequest) Deletes a scheduled audit.deleteSecurityProfile
(Consumer<DeleteSecurityProfileRequest.Builder> deleteSecurityProfileRequest) Deletes a Device Defender security profile.deleteSecurityProfile
(DeleteSecurityProfileRequest deleteSecurityProfileRequest) Deletes a Device Defender security profile.default CompletableFuture
<DeleteStreamResponse> deleteStream
(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest) Deletes a stream.default CompletableFuture
<DeleteStreamResponse> deleteStream
(DeleteStreamRequest deleteStreamRequest) Deletes a stream.default CompletableFuture
<DeleteThingResponse> deleteThing
(Consumer<DeleteThingRequest.Builder> deleteThingRequest) Deletes the specified thing.default CompletableFuture
<DeleteThingResponse> deleteThing
(DeleteThingRequest deleteThingRequest) Deletes the specified thing.deleteThingGroup
(Consumer<DeleteThingGroupRequest.Builder> deleteThingGroupRequest) Deletes a thing group.deleteThingGroup
(DeleteThingGroupRequest deleteThingGroupRequest) Deletes a thing group.default CompletableFuture
<DeleteThingTypeResponse> deleteThingType
(Consumer<DeleteThingTypeRequest.Builder> deleteThingTypeRequest) Deletes the specified thing type.default CompletableFuture
<DeleteThingTypeResponse> deleteThingType
(DeleteThingTypeRequest deleteThingTypeRequest) Deletes the specified thing type.default CompletableFuture
<DeleteTopicRuleResponse> deleteTopicRule
(Consumer<DeleteTopicRuleRequest.Builder> deleteTopicRuleRequest) Deletes the rule.default CompletableFuture
<DeleteTopicRuleResponse> deleteTopicRule
(DeleteTopicRuleRequest deleteTopicRuleRequest) Deletes the rule.deleteTopicRuleDestination
(Consumer<DeleteTopicRuleDestinationRequest.Builder> deleteTopicRuleDestinationRequest) Deletes a topic rule destination.deleteTopicRuleDestination
(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest) Deletes a topic rule destination.deleteV2LoggingLevel
(Consumer<DeleteV2LoggingLevelRequest.Builder> deleteV2LoggingLevelRequest) Deletes a logging level.deleteV2LoggingLevel
(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest) Deletes a logging level.deprecateThingType
(Consumer<DeprecateThingTypeRequest.Builder> deprecateThingTypeRequest) Deprecates a thing type.deprecateThingType
(DeprecateThingTypeRequest deprecateThingTypeRequest) Deprecates a thing type.Gets information about the Device Defender audit settings for this account.describeAccountAuditConfiguration
(Consumer<DescribeAccountAuditConfigurationRequest.Builder> describeAccountAuditConfigurationRequest) Gets information about the Device Defender audit settings for this account.describeAccountAuditConfiguration
(DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest) Gets information about the Device Defender audit settings for this account.describeAuditFinding
(Consumer<DescribeAuditFindingRequest.Builder> describeAuditFindingRequest) Gets information about a single audit finding.describeAuditFinding
(DescribeAuditFindingRequest describeAuditFindingRequest) Gets information about a single audit finding.describeAuditMitigationActionsTask
(Consumer<DescribeAuditMitigationActionsTaskRequest.Builder> describeAuditMitigationActionsTaskRequest) Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings.describeAuditMitigationActionsTask
(DescribeAuditMitigationActionsTaskRequest describeAuditMitigationActionsTaskRequest) Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings.describeAuditSuppression
(Consumer<DescribeAuditSuppressionRequest.Builder> describeAuditSuppressionRequest) Gets information about a Device Defender audit suppression.describeAuditSuppression
(DescribeAuditSuppressionRequest describeAuditSuppressionRequest) Gets information about a Device Defender audit suppression.describeAuditTask
(Consumer<DescribeAuditTaskRequest.Builder> describeAuditTaskRequest) Gets information about a Device Defender audit.describeAuditTask
(DescribeAuditTaskRequest describeAuditTaskRequest) Gets information about a Device Defender audit.describeAuthorizer
(Consumer<DescribeAuthorizerRequest.Builder> describeAuthorizerRequest) Describes an authorizer.describeAuthorizer
(DescribeAuthorizerRequest describeAuthorizerRequest) Describes an authorizer.describeBillingGroup
(Consumer<DescribeBillingGroupRequest.Builder> describeBillingGroupRequest) Returns information about a billing group.describeBillingGroup
(DescribeBillingGroupRequest describeBillingGroupRequest) Returns information about a billing group.describeCACertificate
(Consumer<DescribeCaCertificateRequest.Builder> describeCaCertificateRequest) Describes a registered CA certificate.describeCACertificate
(DescribeCaCertificateRequest describeCaCertificateRequest) Describes a registered CA certificate.describeCertificate
(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) Gets information about the specified certificate.describeCertificate
(DescribeCertificateRequest describeCertificateRequest) Gets information about the specified certificate.describeCertificateProvider
(Consumer<DescribeCertificateProviderRequest.Builder> describeCertificateProviderRequest) Describes a certificate provider.describeCertificateProvider
(DescribeCertificateProviderRequest describeCertificateProviderRequest) Describes a certificate provider.describeCustomMetric
(Consumer<DescribeCustomMetricRequest.Builder> describeCustomMetricRequest) Gets information about a Device Defender detect custom metric.describeCustomMetric
(DescribeCustomMetricRequest describeCustomMetricRequest) Gets information about a Device Defender detect custom metric.describeDefaultAuthorizer
(Consumer<DescribeDefaultAuthorizerRequest.Builder> describeDefaultAuthorizerRequest) Describes the default authorizer.describeDefaultAuthorizer
(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest) Describes the default authorizer.describeDetectMitigationActionsTask
(Consumer<DescribeDetectMitigationActionsTaskRequest.Builder> describeDetectMitigationActionsTaskRequest) Gets information about a Device Defender ML Detect mitigation action.describeDetectMitigationActionsTask
(DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest) Gets information about a Device Defender ML Detect mitigation action.describeDimension
(Consumer<DescribeDimensionRequest.Builder> describeDimensionRequest) Provides details about a dimension that is defined in your Amazon Web Services accounts.describeDimension
(DescribeDimensionRequest describeDimensionRequest) Provides details about a dimension that is defined in your Amazon Web Services accounts.describeDomainConfiguration
(Consumer<DescribeDomainConfigurationRequest.Builder> describeDomainConfigurationRequest) Gets summary information about a domain configuration.describeDomainConfiguration
(DescribeDomainConfigurationRequest describeDomainConfigurationRequest) Gets summary information about a domain configuration.Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.describeEndpoint
(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest) Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.describeEndpoint
(DescribeEndpointRequest describeEndpointRequest) Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.Describes event configurations.describeEventConfigurations
(Consumer<DescribeEventConfigurationsRequest.Builder> describeEventConfigurationsRequest) Describes event configurations.describeEventConfigurations
(DescribeEventConfigurationsRequest describeEventConfigurationsRequest) Describes event configurations.describeFleetMetric
(Consumer<DescribeFleetMetricRequest.Builder> describeFleetMetricRequest) Gets information about the specified fleet metric.describeFleetMetric
(DescribeFleetMetricRequest describeFleetMetricRequest) Gets information about the specified fleet metric.default CompletableFuture
<DescribeIndexResponse> describeIndex
(Consumer<DescribeIndexRequest.Builder> describeIndexRequest) Describes a search index.default CompletableFuture
<DescribeIndexResponse> describeIndex
(DescribeIndexRequest describeIndexRequest) Describes a search index.default CompletableFuture
<DescribeJobResponse> describeJob
(Consumer<DescribeJobRequest.Builder> describeJobRequest) Describes a job.default CompletableFuture
<DescribeJobResponse> describeJob
(DescribeJobRequest describeJobRequest) Describes a job.describeJobExecution
(Consumer<DescribeJobExecutionRequest.Builder> describeJobExecutionRequest) Describes a job execution.describeJobExecution
(DescribeJobExecutionRequest describeJobExecutionRequest) Describes a job execution.describeJobTemplate
(Consumer<DescribeJobTemplateRequest.Builder> describeJobTemplateRequest) Returns information about a job template.describeJobTemplate
(DescribeJobTemplateRequest describeJobTemplateRequest) Returns information about a job template.describeManagedJobTemplate
(Consumer<DescribeManagedJobTemplateRequest.Builder> describeManagedJobTemplateRequest) View details of a managed job template.describeManagedJobTemplate
(DescribeManagedJobTemplateRequest describeManagedJobTemplateRequest) View details of a managed job template.describeMitigationAction
(Consumer<DescribeMitigationActionRequest.Builder> describeMitigationActionRequest) Gets information about a mitigation action.describeMitigationAction
(DescribeMitigationActionRequest describeMitigationActionRequest) Gets information about a mitigation action.describeProvisioningTemplate
(Consumer<DescribeProvisioningTemplateRequest.Builder> describeProvisioningTemplateRequest) Returns information about a provisioning template.describeProvisioningTemplate
(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest) Returns information about a provisioning template.describeProvisioningTemplateVersion
(Consumer<DescribeProvisioningTemplateVersionRequest.Builder> describeProvisioningTemplateVersionRequest) Returns information about a provisioning template version.describeProvisioningTemplateVersion
(DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest) Returns information about a provisioning template version.describeRoleAlias
(Consumer<DescribeRoleAliasRequest.Builder> describeRoleAliasRequest) Describes a role alias.describeRoleAlias
(DescribeRoleAliasRequest describeRoleAliasRequest) Describes a role alias.describeScheduledAudit
(Consumer<DescribeScheduledAuditRequest.Builder> describeScheduledAuditRequest) Gets information about a scheduled audit.describeScheduledAudit
(DescribeScheduledAuditRequest describeScheduledAuditRequest) Gets information about a scheduled audit.describeSecurityProfile
(Consumer<DescribeSecurityProfileRequest.Builder> describeSecurityProfileRequest) Gets information about a Device Defender security profile.describeSecurityProfile
(DescribeSecurityProfileRequest describeSecurityProfileRequest) Gets information about a Device Defender security profile.default CompletableFuture
<DescribeStreamResponse> describeStream
(Consumer<DescribeStreamRequest.Builder> describeStreamRequest) Gets information about a stream.default CompletableFuture
<DescribeStreamResponse> describeStream
(DescribeStreamRequest describeStreamRequest) Gets information about a stream.default CompletableFuture
<DescribeThingResponse> describeThing
(Consumer<DescribeThingRequest.Builder> describeThingRequest) Gets information about the specified thing.default CompletableFuture
<DescribeThingResponse> describeThing
(DescribeThingRequest describeThingRequest) Gets information about the specified thing.describeThingGroup
(Consumer<DescribeThingGroupRequest.Builder> describeThingGroupRequest) Describe a thing group.describeThingGroup
(DescribeThingGroupRequest describeThingGroupRequest) Describe a thing group.describeThingRegistrationTask
(Consumer<DescribeThingRegistrationTaskRequest.Builder> describeThingRegistrationTaskRequest) Describes a bulk thing provisioning task.describeThingRegistrationTask
(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest) Describes a bulk thing provisioning task.describeThingType
(Consumer<DescribeThingTypeRequest.Builder> describeThingTypeRequest) Gets information about the specified thing type.describeThingType
(DescribeThingTypeRequest describeThingTypeRequest) Gets information about the specified thing type.default CompletableFuture
<DetachPolicyResponse> detachPolicy
(Consumer<DetachPolicyRequest.Builder> detachPolicyRequest) Detaches a policy from the specified target.default CompletableFuture
<DetachPolicyResponse> detachPolicy
(DetachPolicyRequest detachPolicyRequest) Detaches a policy from the specified target.detachSecurityProfile
(Consumer<DetachSecurityProfileRequest.Builder> detachSecurityProfileRequest) Disassociates a Device Defender security profile from a thing group or from this account.detachSecurityProfile
(DetachSecurityProfileRequest detachSecurityProfileRequest) Disassociates a Device Defender security profile from a thing group or from this account.detachThingPrincipal
(Consumer<DetachThingPrincipalRequest.Builder> detachThingPrincipalRequest) Detaches the specified principal from the specified thing.detachThingPrincipal
(DetachThingPrincipalRequest detachThingPrincipalRequest) Detaches the specified principal from the specified thing.disableTopicRule
(Consumer<DisableTopicRuleRequest.Builder> disableTopicRuleRequest) Disables the rule.disableTopicRule
(DisableTopicRuleRequest disableTopicRuleRequest) Disables the rule.disassociateSbomFromPackageVersion
(Consumer<DisassociateSbomFromPackageVersionRequest.Builder> disassociateSbomFromPackageVersionRequest) Disassociates the selected software bill of materials (SBOM) from a specific software package version.disassociateSbomFromPackageVersion
(DisassociateSbomFromPackageVersionRequest disassociateSbomFromPackageVersionRequest) Disassociates the selected software bill of materials (SBOM) from a specific software package version.default CompletableFuture
<EnableTopicRuleResponse> enableTopicRule
(Consumer<EnableTopicRuleRequest.Builder> enableTopicRuleRequest) Enables the rule.default CompletableFuture
<EnableTopicRuleResponse> enableTopicRule
(EnableTopicRuleRequest enableTopicRuleRequest) Enables the rule.getBehaviorModelTrainingSummaries
(Consumer<GetBehaviorModelTrainingSummariesRequest.Builder> getBehaviorModelTrainingSummariesRequest) Returns a Device Defender's ML Detect Security Profile training model's status.getBehaviorModelTrainingSummaries
(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest) Returns a Device Defender's ML Detect Security Profile training model's status.getBehaviorModelTrainingSummariesPaginator
(Consumer<GetBehaviorModelTrainingSummariesRequest.Builder> getBehaviorModelTrainingSummariesRequest) This is a variant ofgetBehaviorModelTrainingSummaries(software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesRequest)
operation.getBehaviorModelTrainingSummariesPaginator
(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest) This is a variant ofgetBehaviorModelTrainingSummaries(software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesRequest)
operation.getBucketsAggregation
(Consumer<GetBucketsAggregationRequest.Builder> getBucketsAggregationRequest) Aggregates on indexed data with search queries pertaining to particular fields.getBucketsAggregation
(GetBucketsAggregationRequest getBucketsAggregationRequest) Aggregates on indexed data with search queries pertaining to particular fields.default CompletableFuture
<GetCardinalityResponse> getCardinality
(Consumer<GetCardinalityRequest.Builder> getCardinalityRequest) Returns the approximate count of unique values that match the query.default CompletableFuture
<GetCardinalityResponse> getCardinality
(GetCardinalityRequest getCardinalityRequest) Returns the approximate count of unique values that match the query.getEffectivePolicies
(Consumer<GetEffectivePoliciesRequest.Builder> 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.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.Gets the indexing configuration.getIndexingConfiguration
(Consumer<GetIndexingConfigurationRequest.Builder> getIndexingConfigurationRequest) Gets the indexing configuration.getIndexingConfiguration
(GetIndexingConfigurationRequest getIndexingConfigurationRequest) Gets the indexing configuration.default CompletableFuture
<GetJobDocumentResponse> getJobDocument
(Consumer<GetJobDocumentRequest.Builder> getJobDocumentRequest) Gets a job document.default CompletableFuture
<GetJobDocumentResponse> getJobDocument
(GetJobDocumentRequest getJobDocumentRequest) Gets a job document.Gets the logging options.getLoggingOptions
(Consumer<GetLoggingOptionsRequest.Builder> getLoggingOptionsRequest) Gets the logging options.getLoggingOptions
(GetLoggingOptionsRequest getLoggingOptionsRequest) Gets the logging options.default CompletableFuture
<GetOtaUpdateResponse> getOTAUpdate
(Consumer<GetOtaUpdateRequest.Builder> getOtaUpdateRequest) Gets an OTA update.default CompletableFuture
<GetOtaUpdateResponse> getOTAUpdate
(GetOtaUpdateRequest getOtaUpdateRequest) Gets an OTA update.default CompletableFuture
<GetPackageResponse> getPackage
(Consumer<GetPackageRequest.Builder> getPackageRequest) Gets information about the specified software package.default CompletableFuture
<GetPackageResponse> getPackage
(GetPackageRequest getPackageRequest) Gets information about the specified software package.getPackageConfiguration
(Consumer<GetPackageConfigurationRequest.Builder> getPackageConfigurationRequest) Gets information about the specified software package's configuration.getPackageConfiguration
(GetPackageConfigurationRequest getPackageConfigurationRequest) Gets information about the specified software package's configuration.getPackageVersion
(Consumer<GetPackageVersionRequest.Builder> getPackageVersionRequest) Gets information about the specified package version.getPackageVersion
(GetPackageVersionRequest getPackageVersionRequest) Gets information about the specified package version.default CompletableFuture
<GetPercentilesResponse> getPercentiles
(Consumer<GetPercentilesRequest.Builder> getPercentilesRequest) Groups the aggregated values that match the query into percentile groupings.default CompletableFuture
<GetPercentilesResponse> getPercentiles
(GetPercentilesRequest getPercentilesRequest) Groups the aggregated values that match the query into percentile groupings.default CompletableFuture
<GetPolicyResponse> getPolicy
(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Gets information about the specified policy with the policy document of the default version.default CompletableFuture
<GetPolicyResponse> getPolicy
(GetPolicyRequest getPolicyRequest) Gets information about the specified policy with the policy document of the default version.getPolicyVersion
(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) Gets information about the specified policy version.getPolicyVersion
(GetPolicyVersionRequest getPolicyVersionRequest) Gets information about the specified policy version.Gets a registration code used to register a CA certificate with IoT.getRegistrationCode
(Consumer<GetRegistrationCodeRequest.Builder> getRegistrationCodeRequest) Gets a registration code used to register a CA certificate with IoT.getRegistrationCode
(GetRegistrationCodeRequest getRegistrationCodeRequest) Gets a registration code used to register a CA certificate with IoT.default CompletableFuture
<GetStatisticsResponse> getStatistics
(Consumer<GetStatisticsRequest.Builder> getStatisticsRequest) Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field.default CompletableFuture
<GetStatisticsResponse> getStatistics
(GetStatisticsRequest getStatisticsRequest) Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field.default CompletableFuture
<GetTopicRuleResponse> getTopicRule
(Consumer<GetTopicRuleRequest.Builder> getTopicRuleRequest) Gets information about the rule.default CompletableFuture
<GetTopicRuleResponse> getTopicRule
(GetTopicRuleRequest getTopicRuleRequest) Gets information about the rule.getTopicRuleDestination
(Consumer<GetTopicRuleDestinationRequest.Builder> getTopicRuleDestinationRequest) Gets information about a topic rule destination.getTopicRuleDestination
(GetTopicRuleDestinationRequest getTopicRuleDestinationRequest) Gets information about a topic rule destination.getV2LoggingOptions
(Consumer<GetV2LoggingOptionsRequest.Builder> getV2LoggingOptionsRequest) Gets the fine grained logging options.getV2LoggingOptions
(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest) Gets the fine grained logging options.Lists the active violations for a given Device Defender security profile.listActiveViolations
(Consumer<ListActiveViolationsRequest.Builder> listActiveViolationsRequest) Lists the active violations for a given Device Defender security profile.listActiveViolations
(ListActiveViolationsRequest listActiveViolationsRequest) Lists the active violations for a given Device Defender security profile.default ListActiveViolationsPublisher
This is a variant oflistActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation.default ListActiveViolationsPublisher
listActiveViolationsPaginator
(Consumer<ListActiveViolationsRequest.Builder> listActiveViolationsRequest) This is a variant oflistActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation.default ListActiveViolationsPublisher
listActiveViolationsPaginator
(ListActiveViolationsRequest listActiveViolationsRequest) This is a variant oflistActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation.listAttachedPolicies
(Consumer<ListAttachedPoliciesRequest.Builder> listAttachedPoliciesRequest) Lists the policies attached to the specified thing group.listAttachedPolicies
(ListAttachedPoliciesRequest listAttachedPoliciesRequest) Lists the policies attached to the specified thing group.default ListAttachedPoliciesPublisher
listAttachedPoliciesPaginator
(Consumer<ListAttachedPoliciesRequest.Builder> listAttachedPoliciesRequest) This is a variant oflistAttachedPolicies(software.amazon.awssdk.services.iot.model.ListAttachedPoliciesRequest)
operation.default ListAttachedPoliciesPublisher
listAttachedPoliciesPaginator
(ListAttachedPoliciesRequest listAttachedPoliciesRequest) This is a variant oflistAttachedPolicies(software.amazon.awssdk.services.iot.model.ListAttachedPoliciesRequest)
operation.listAuditFindings
(Consumer<ListAuditFindingsRequest.Builder> listAuditFindingsRequest) Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.listAuditFindings
(ListAuditFindingsRequest listAuditFindingsRequest) Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.default ListAuditFindingsPublisher
listAuditFindingsPaginator
(Consumer<ListAuditFindingsRequest.Builder> listAuditFindingsRequest) This is a variant oflistAuditFindings(software.amazon.awssdk.services.iot.model.ListAuditFindingsRequest)
operation.default ListAuditFindingsPublisher
listAuditFindingsPaginator
(ListAuditFindingsRequest listAuditFindingsRequest) This is a variant oflistAuditFindings(software.amazon.awssdk.services.iot.model.ListAuditFindingsRequest)
operation.listAuditMitigationActionsExecutions
(Consumer<ListAuditMitigationActionsExecutionsRequest.Builder> listAuditMitigationActionsExecutionsRequest) Gets the status of audit mitigation action tasks that were executed.listAuditMitigationActionsExecutions
(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest) Gets the status of audit mitigation action tasks that were executed.listAuditMitigationActionsExecutionsPaginator
(Consumer<ListAuditMitigationActionsExecutionsRequest.Builder> listAuditMitigationActionsExecutionsRequest) This is a variant oflistAuditMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsRequest)
operation.listAuditMitigationActionsExecutionsPaginator
(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest) This is a variant oflistAuditMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsRequest)
operation.listAuditMitigationActionsTasks
(Consumer<ListAuditMitigationActionsTasksRequest.Builder> listAuditMitigationActionsTasksRequest) Gets a list of audit mitigation action tasks that match the specified filters.listAuditMitigationActionsTasks
(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest) Gets a list of audit mitigation action tasks that match the specified filters.listAuditMitigationActionsTasksPaginator
(Consumer<ListAuditMitigationActionsTasksRequest.Builder> listAuditMitigationActionsTasksRequest) This is a variant oflistAuditMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksRequest)
operation.listAuditMitigationActionsTasksPaginator
(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest) This is a variant oflistAuditMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksRequest)
operation.listAuditSuppressions
(Consumer<ListAuditSuppressionsRequest.Builder> listAuditSuppressionsRequest) Lists your Device Defender audit listings.listAuditSuppressions
(ListAuditSuppressionsRequest listAuditSuppressionsRequest) Lists your Device Defender audit listings.default ListAuditSuppressionsPublisher
listAuditSuppressionsPaginator
(Consumer<ListAuditSuppressionsRequest.Builder> listAuditSuppressionsRequest) This is a variant oflistAuditSuppressions(software.amazon.awssdk.services.iot.model.ListAuditSuppressionsRequest)
operation.default ListAuditSuppressionsPublisher
listAuditSuppressionsPaginator
(ListAuditSuppressionsRequest listAuditSuppressionsRequest) This is a variant oflistAuditSuppressions(software.amazon.awssdk.services.iot.model.ListAuditSuppressionsRequest)
operation.default CompletableFuture
<ListAuditTasksResponse> listAuditTasks
(Consumer<ListAuditTasksRequest.Builder> listAuditTasksRequest) Lists the Device Defender audits that have been performed during a given time period.default CompletableFuture
<ListAuditTasksResponse> listAuditTasks
(ListAuditTasksRequest listAuditTasksRequest) Lists the Device Defender audits that have been performed during a given time period.default ListAuditTasksPublisher
listAuditTasksPaginator
(Consumer<ListAuditTasksRequest.Builder> listAuditTasksRequest) This is a variant oflistAuditTasks(software.amazon.awssdk.services.iot.model.ListAuditTasksRequest)
operation.default ListAuditTasksPublisher
listAuditTasksPaginator
(ListAuditTasksRequest listAuditTasksRequest) This is a variant oflistAuditTasks(software.amazon.awssdk.services.iot.model.ListAuditTasksRequest)
operation.default CompletableFuture
<ListAuthorizersResponse> Lists the authorizers registered in your account.default CompletableFuture
<ListAuthorizersResponse> listAuthorizers
(Consumer<ListAuthorizersRequest.Builder> listAuthorizersRequest) Lists the authorizers registered in your account.default CompletableFuture
<ListAuthorizersResponse> listAuthorizers
(ListAuthorizersRequest listAuthorizersRequest) Lists the authorizers registered in your account.default ListAuthorizersPublisher
This is a variant oflistAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation.default ListAuthorizersPublisher
listAuthorizersPaginator
(Consumer<ListAuthorizersRequest.Builder> listAuthorizersRequest) This is a variant oflistAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation.default ListAuthorizersPublisher
listAuthorizersPaginator
(ListAuthorizersRequest listAuthorizersRequest) This is a variant oflistAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation.Lists the billing groups you have created.listBillingGroups
(Consumer<ListBillingGroupsRequest.Builder> listBillingGroupsRequest) Lists the billing groups you have created.listBillingGroups
(ListBillingGroupsRequest listBillingGroupsRequest) Lists the billing groups you have created.default ListBillingGroupsPublisher
This is a variant oflistBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation.default ListBillingGroupsPublisher
listBillingGroupsPaginator
(Consumer<ListBillingGroupsRequest.Builder> listBillingGroupsRequest) This is a variant oflistBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation.default ListBillingGroupsPublisher
listBillingGroupsPaginator
(ListBillingGroupsRequest listBillingGroupsRequest) This is a variant oflistBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation.Lists the CA certificates registered for your Amazon Web Services account.listCACertificates
(Consumer<ListCaCertificatesRequest.Builder> listCaCertificatesRequest) Lists the CA certificates registered for your Amazon Web Services account.listCACertificates
(ListCaCertificatesRequest listCaCertificatesRequest) Lists the CA certificates registered for your Amazon Web Services account.default ListCACertificatesPublisher
This is a variant oflistCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation.default ListCACertificatesPublisher
listCACertificatesPaginator
(Consumer<ListCaCertificatesRequest.Builder> listCaCertificatesRequest) This is a variant oflistCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation.default ListCACertificatesPublisher
listCACertificatesPaginator
(ListCaCertificatesRequest listCaCertificatesRequest) This is a variant oflistCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation.listCertificateProviders
(Consumer<ListCertificateProvidersRequest.Builder> listCertificateProvidersRequest) Lists all your certificate providers in your Amazon Web Services account.listCertificateProviders
(ListCertificateProvidersRequest listCertificateProvidersRequest) Lists all your certificate providers in your Amazon Web Services account.Lists the certificates registered in your Amazon Web Services account.listCertificates
(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) Lists the certificates registered in your Amazon Web Services account.listCertificates
(ListCertificatesRequest listCertificatesRequest) Lists the certificates registered in your Amazon Web Services account.listCertificatesByCA
(Consumer<ListCertificatesByCaRequest.Builder> listCertificatesByCaRequest) List the device certificates signed by the specified CA certificate.listCertificatesByCA
(ListCertificatesByCaRequest listCertificatesByCaRequest) List the device certificates signed by the specified CA certificate.default ListCertificatesByCAPublisher
listCertificatesByCAPaginator
(Consumer<ListCertificatesByCaRequest.Builder> listCertificatesByCaRequest) This is a variant oflistCertificatesByCA(software.amazon.awssdk.services.iot.model.ListCertificatesByCaRequest)
operation.default ListCertificatesByCAPublisher
listCertificatesByCAPaginator
(ListCertificatesByCaRequest listCertificatesByCaRequest) This is a variant oflistCertificatesByCA(software.amazon.awssdk.services.iot.model.ListCertificatesByCaRequest)
operation.default ListCertificatesPublisher
This is a variant oflistCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation.default ListCertificatesPublisher
listCertificatesPaginator
(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) This is a variant oflistCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation.default ListCertificatesPublisher
listCertificatesPaginator
(ListCertificatesRequest listCertificatesRequest) This is a variant oflistCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation.listCustomMetrics
(Consumer<ListCustomMetricsRequest.Builder> listCustomMetricsRequest) Lists your Device Defender detect custom metrics.listCustomMetrics
(ListCustomMetricsRequest listCustomMetricsRequest) Lists your Device Defender detect custom metrics.default ListCustomMetricsPublisher
listCustomMetricsPaginator
(Consumer<ListCustomMetricsRequest.Builder> listCustomMetricsRequest) This is a variant oflistCustomMetrics(software.amazon.awssdk.services.iot.model.ListCustomMetricsRequest)
operation.default ListCustomMetricsPublisher
listCustomMetricsPaginator
(ListCustomMetricsRequest listCustomMetricsRequest) This is a variant oflistCustomMetrics(software.amazon.awssdk.services.iot.model.ListCustomMetricsRequest)
operation.listDetectMitigationActionsExecutions
(Consumer<ListDetectMitigationActionsExecutionsRequest.Builder> listDetectMitigationActionsExecutionsRequest) Lists mitigation actions executions for a Device Defender ML Detect Security Profile.listDetectMitigationActionsExecutions
(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest) Lists mitigation actions executions for a Device Defender ML Detect Security Profile.listDetectMitigationActionsExecutionsPaginator
(Consumer<ListDetectMitigationActionsExecutionsRequest.Builder> listDetectMitigationActionsExecutionsRequest) This is a variant oflistDetectMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsRequest)
operation.listDetectMitigationActionsExecutionsPaginator
(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest) This is a variant oflistDetectMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsRequest)
operation.listDetectMitigationActionsTasks
(Consumer<ListDetectMitigationActionsTasksRequest.Builder> listDetectMitigationActionsTasksRequest) List of Device Defender ML Detect mitigation actions tasks.listDetectMitigationActionsTasks
(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest) List of Device Defender ML Detect mitigation actions tasks.listDetectMitigationActionsTasksPaginator
(Consumer<ListDetectMitigationActionsTasksRequest.Builder> listDetectMitigationActionsTasksRequest) This is a variant oflistDetectMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksRequest)
operation.listDetectMitigationActionsTasksPaginator
(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest) This is a variant oflistDetectMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksRequest)
operation.default CompletableFuture
<ListDimensionsResponse> listDimensions
(Consumer<ListDimensionsRequest.Builder> listDimensionsRequest) List the set of dimensions that are defined for your Amazon Web Services accounts.default CompletableFuture
<ListDimensionsResponse> listDimensions
(ListDimensionsRequest listDimensionsRequest) List the set of dimensions that are defined for your Amazon Web Services accounts.default ListDimensionsPublisher
listDimensionsPaginator
(Consumer<ListDimensionsRequest.Builder> listDimensionsRequest) This is a variant oflistDimensions(software.amazon.awssdk.services.iot.model.ListDimensionsRequest)
operation.default ListDimensionsPublisher
listDimensionsPaginator
(ListDimensionsRequest listDimensionsRequest) This is a variant oflistDimensions(software.amazon.awssdk.services.iot.model.ListDimensionsRequest)
operation.listDomainConfigurations
(Consumer<ListDomainConfigurationsRequest.Builder> listDomainConfigurationsRequest) Gets a list of domain configurations for the user.listDomainConfigurations
(ListDomainConfigurationsRequest listDomainConfigurationsRequest) Gets a list of domain configurations for the user.listDomainConfigurationsPaginator
(Consumer<ListDomainConfigurationsRequest.Builder> listDomainConfigurationsRequest) This is a variant oflistDomainConfigurations(software.amazon.awssdk.services.iot.model.ListDomainConfigurationsRequest)
operation.listDomainConfigurationsPaginator
(ListDomainConfigurationsRequest listDomainConfigurationsRequest) This is a variant oflistDomainConfigurations(software.amazon.awssdk.services.iot.model.ListDomainConfigurationsRequest)
operation.listFleetMetrics
(Consumer<ListFleetMetricsRequest.Builder> listFleetMetricsRequest) Lists all your fleet metrics.listFleetMetrics
(ListFleetMetricsRequest listFleetMetricsRequest) Lists all your fleet metrics.default ListFleetMetricsPublisher
listFleetMetricsPaginator
(Consumer<ListFleetMetricsRequest.Builder> listFleetMetricsRequest) This is a variant oflistFleetMetrics(software.amazon.awssdk.services.iot.model.ListFleetMetricsRequest)
operation.default ListFleetMetricsPublisher
listFleetMetricsPaginator
(ListFleetMetricsRequest listFleetMetricsRequest) This is a variant oflistFleetMetrics(software.amazon.awssdk.services.iot.model.ListFleetMetricsRequest)
operation.default CompletableFuture
<ListIndicesResponse> Lists the search indices.default CompletableFuture
<ListIndicesResponse> listIndices
(Consumer<ListIndicesRequest.Builder> listIndicesRequest) Lists the search indices.default CompletableFuture
<ListIndicesResponse> listIndices
(ListIndicesRequest listIndicesRequest) Lists the search indices.default ListIndicesPublisher
This is a variant oflistIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation.default ListIndicesPublisher
listIndicesPaginator
(Consumer<ListIndicesRequest.Builder> listIndicesRequest) This is a variant oflistIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation.default ListIndicesPublisher
listIndicesPaginator
(ListIndicesRequest listIndicesRequest) This is a variant oflistIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation.listJobExecutionsForJob
(Consumer<ListJobExecutionsForJobRequest.Builder> listJobExecutionsForJobRequest) Lists the job executions for a job.listJobExecutionsForJob
(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest) Lists the job executions for a job.default ListJobExecutionsForJobPublisher
listJobExecutionsForJobPaginator
(Consumer<ListJobExecutionsForJobRequest.Builder> listJobExecutionsForJobRequest) This is a variant oflistJobExecutionsForJob(software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobRequest)
operation.default ListJobExecutionsForJobPublisher
listJobExecutionsForJobPaginator
(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest) This is a variant oflistJobExecutionsForJob(software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobRequest)
operation.listJobExecutionsForThing
(Consumer<ListJobExecutionsForThingRequest.Builder> listJobExecutionsForThingRequest) Lists the job executions for the specified thing.listJobExecutionsForThing
(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest) Lists the job executions for the specified thing.listJobExecutionsForThingPaginator
(Consumer<ListJobExecutionsForThingRequest.Builder> listJobExecutionsForThingRequest) This is a variant oflistJobExecutionsForThing(software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingRequest)
operation.listJobExecutionsForThingPaginator
(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest) This is a variant oflistJobExecutionsForThing(software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingRequest)
operation.default CompletableFuture
<ListJobsResponse> listJobs()
Lists jobs.default CompletableFuture
<ListJobsResponse> listJobs
(Consumer<ListJobsRequest.Builder> listJobsRequest) Lists jobs.default CompletableFuture
<ListJobsResponse> listJobs
(ListJobsRequest listJobsRequest) Lists jobs.default ListJobsPublisher
This is a variant oflistJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation.default ListJobsPublisher
listJobsPaginator
(Consumer<ListJobsRequest.Builder> listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation.default ListJobsPublisher
listJobsPaginator
(ListJobsRequest listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation.listJobTemplates
(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) Returns a list of job templates.listJobTemplates
(ListJobTemplatesRequest listJobTemplatesRequest) Returns a list of job templates.default ListJobTemplatesPublisher
listJobTemplatesPaginator
(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) This is a variant oflistJobTemplates(software.amazon.awssdk.services.iot.model.ListJobTemplatesRequest)
operation.default ListJobTemplatesPublisher
listJobTemplatesPaginator
(ListJobTemplatesRequest listJobTemplatesRequest) This is a variant oflistJobTemplates(software.amazon.awssdk.services.iot.model.ListJobTemplatesRequest)
operation.listManagedJobTemplates
(Consumer<ListManagedJobTemplatesRequest.Builder> listManagedJobTemplatesRequest) Returns a list of managed job templates.listManagedJobTemplates
(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest) Returns a list of managed job templates.default ListManagedJobTemplatesPublisher
listManagedJobTemplatesPaginator
(Consumer<ListManagedJobTemplatesRequest.Builder> listManagedJobTemplatesRequest) This is a variant oflistManagedJobTemplates(software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesRequest)
operation.default ListManagedJobTemplatesPublisher
listManagedJobTemplatesPaginator
(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest) This is a variant oflistManagedJobTemplates(software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesRequest)
operation.listMetricValues
(Consumer<ListMetricValuesRequest.Builder> 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.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.default ListMetricValuesPublisher
listMetricValuesPaginator
(Consumer<ListMetricValuesRequest.Builder> listMetricValuesRequest) This is a variant oflistMetricValues(software.amazon.awssdk.services.iot.model.ListMetricValuesRequest)
operation.default ListMetricValuesPublisher
listMetricValuesPaginator
(ListMetricValuesRequest listMetricValuesRequest) This is a variant oflistMetricValues(software.amazon.awssdk.services.iot.model.ListMetricValuesRequest)
operation.listMitigationActions
(Consumer<ListMitigationActionsRequest.Builder> listMitigationActionsRequest) Gets a list of all mitigation actions that match the specified filter criteria.listMitigationActions
(ListMitigationActionsRequest listMitigationActionsRequest) Gets a list of all mitigation actions that match the specified filter criteria.default ListMitigationActionsPublisher
listMitigationActionsPaginator
(Consumer<ListMitigationActionsRequest.Builder> listMitigationActionsRequest) This is a variant oflistMitigationActions(software.amazon.awssdk.services.iot.model.ListMitigationActionsRequest)
operation.default ListMitigationActionsPublisher
listMitigationActionsPaginator
(ListMitigationActionsRequest listMitigationActionsRequest) This is a variant oflistMitigationActions(software.amazon.awssdk.services.iot.model.ListMitigationActionsRequest)
operation.default CompletableFuture
<ListOtaUpdatesResponse> Lists OTA updates.default CompletableFuture
<ListOtaUpdatesResponse> listOTAUpdates
(Consumer<ListOtaUpdatesRequest.Builder> listOtaUpdatesRequest) Lists OTA updates.default CompletableFuture
<ListOtaUpdatesResponse> listOTAUpdates
(ListOtaUpdatesRequest listOtaUpdatesRequest) Lists OTA updates.default ListOTAUpdatesPublisher
This is a variant oflistOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation.default ListOTAUpdatesPublisher
listOTAUpdatesPaginator
(Consumer<ListOtaUpdatesRequest.Builder> listOtaUpdatesRequest) This is a variant oflistOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation.default ListOTAUpdatesPublisher
listOTAUpdatesPaginator
(ListOtaUpdatesRequest listOtaUpdatesRequest) This is a variant oflistOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation.Lists certificates that are being transferred but not yet accepted.listOutgoingCertificates
(Consumer<ListOutgoingCertificatesRequest.Builder> listOutgoingCertificatesRequest) Lists certificates that are being transferred but not yet accepted.listOutgoingCertificates
(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) Lists certificates that are being transferred but not yet accepted.This is a variant oflistOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation.listOutgoingCertificatesPaginator
(Consumer<ListOutgoingCertificatesRequest.Builder> listOutgoingCertificatesRequest) This is a variant oflistOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation.listOutgoingCertificatesPaginator
(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) This is a variant oflistOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation.default CompletableFuture
<ListPackagesResponse> listPackages
(Consumer<ListPackagesRequest.Builder> listPackagesRequest) Lists the software packages associated to the account.default CompletableFuture
<ListPackagesResponse> listPackages
(ListPackagesRequest listPackagesRequest) Lists the software packages associated to the account.default ListPackagesPublisher
listPackagesPaginator
(Consumer<ListPackagesRequest.Builder> listPackagesRequest) This is a variant oflistPackages(software.amazon.awssdk.services.iot.model.ListPackagesRequest)
operation.default ListPackagesPublisher
listPackagesPaginator
(ListPackagesRequest listPackagesRequest) This is a variant oflistPackages(software.amazon.awssdk.services.iot.model.ListPackagesRequest)
operation.listPackageVersions
(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest) Lists the software package versions associated to the account.listPackageVersions
(ListPackageVersionsRequest listPackageVersionsRequest) Lists the software package versions associated to the account.default ListPackageVersionsPublisher
listPackageVersionsPaginator
(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest) This is a variant oflistPackageVersions(software.amazon.awssdk.services.iot.model.ListPackageVersionsRequest)
operation.default ListPackageVersionsPublisher
listPackageVersionsPaginator
(ListPackageVersionsRequest listPackageVersionsRequest) This is a variant oflistPackageVersions(software.amazon.awssdk.services.iot.model.ListPackageVersionsRequest)
operation.default CompletableFuture
<ListPoliciesResponse> Lists your policies.default CompletableFuture
<ListPoliciesResponse> listPolicies
(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Lists your policies.default CompletableFuture
<ListPoliciesResponse> listPolicies
(ListPoliciesRequest listPoliciesRequest) Lists your policies.default ListPoliciesPublisher
This is a variant oflistPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation.default ListPoliciesPublisher
listPoliciesPaginator
(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation.default ListPoliciesPublisher
listPoliciesPaginator
(ListPoliciesRequest listPoliciesRequest) This is a variant oflistPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation.listPolicyVersions
(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) Lists the versions of the specified policy and identifies the default version.listPolicyVersions
(ListPolicyVersionsRequest listPolicyVersionsRequest) Lists the versions of the specified policy and identifies the default version.listPrincipalThings
(Consumer<ListPrincipalThingsRequest.Builder> listPrincipalThingsRequest) Lists the things associated with the specified principal.listPrincipalThings
(ListPrincipalThingsRequest listPrincipalThingsRequest) Lists the things associated with the specified principal.default ListPrincipalThingsPublisher
listPrincipalThingsPaginator
(Consumer<ListPrincipalThingsRequest.Builder> listPrincipalThingsRequest) This is a variant oflistPrincipalThings(software.amazon.awssdk.services.iot.model.ListPrincipalThingsRequest)
operation.default ListPrincipalThingsPublisher
listPrincipalThingsPaginator
(ListPrincipalThingsRequest listPrincipalThingsRequest) This is a variant oflistPrincipalThings(software.amazon.awssdk.services.iot.model.ListPrincipalThingsRequest)
operation.listProvisioningTemplates
(Consumer<ListProvisioningTemplatesRequest.Builder> listProvisioningTemplatesRequest) Lists the provisioning templates in your Amazon Web Services account.listProvisioningTemplates
(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest) Lists the provisioning templates in your Amazon Web Services account.listProvisioningTemplatesPaginator
(Consumer<ListProvisioningTemplatesRequest.Builder> listProvisioningTemplatesRequest) This is a variant oflistProvisioningTemplates(software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesRequest)
operation.listProvisioningTemplatesPaginator
(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest) This is a variant oflistProvisioningTemplates(software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesRequest)
operation.listProvisioningTemplateVersions
(Consumer<ListProvisioningTemplateVersionsRequest.Builder> listProvisioningTemplateVersionsRequest) A list of provisioning template versions.listProvisioningTemplateVersions
(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest) A list of provisioning template versions.listProvisioningTemplateVersionsPaginator
(Consumer<ListProvisioningTemplateVersionsRequest.Builder> listProvisioningTemplateVersionsRequest) This is a variant oflistProvisioningTemplateVersions(software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsRequest)
operation.listProvisioningTemplateVersionsPaginator
(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest) This is a variant oflistProvisioningTemplateVersions(software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsRequest)
operation.listRelatedResourcesForAuditFinding
(Consumer<ListRelatedResourcesForAuditFindingRequest.Builder> listRelatedResourcesForAuditFindingRequest) The related resources of an Audit finding.listRelatedResourcesForAuditFinding
(ListRelatedResourcesForAuditFindingRequest listRelatedResourcesForAuditFindingRequest) The related resources of an Audit finding.listRelatedResourcesForAuditFindingPaginator
(Consumer<ListRelatedResourcesForAuditFindingRequest.Builder> listRelatedResourcesForAuditFindingRequest) This is a variant oflistRelatedResourcesForAuditFinding(software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingRequest)
operation.listRelatedResourcesForAuditFindingPaginator
(ListRelatedResourcesForAuditFindingRequest listRelatedResourcesForAuditFindingRequest) This is a variant oflistRelatedResourcesForAuditFinding(software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingRequest)
operation.default CompletableFuture
<ListRoleAliasesResponse> Lists the role aliases registered in your account.default CompletableFuture
<ListRoleAliasesResponse> listRoleAliases
(Consumer<ListRoleAliasesRequest.Builder> listRoleAliasesRequest) Lists the role aliases registered in your account.default CompletableFuture
<ListRoleAliasesResponse> listRoleAliases
(ListRoleAliasesRequest listRoleAliasesRequest) Lists the role aliases registered in your account.default ListRoleAliasesPublisher
This is a variant oflistRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation.default ListRoleAliasesPublisher
listRoleAliasesPaginator
(Consumer<ListRoleAliasesRequest.Builder> listRoleAliasesRequest) This is a variant oflistRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation.default ListRoleAliasesPublisher
listRoleAliasesPaginator
(ListRoleAliasesRequest listRoleAliasesRequest) This is a variant oflistRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation.listSbomValidationResults
(Consumer<ListSbomValidationResultsRequest.Builder> listSbomValidationResultsRequest) The validation results for all software bill of materials (SBOM) attached to a specific software package version.listSbomValidationResults
(ListSbomValidationResultsRequest listSbomValidationResultsRequest) The validation results for all software bill of materials (SBOM) attached to a specific software package version.listSbomValidationResultsPaginator
(Consumer<ListSbomValidationResultsRequest.Builder> listSbomValidationResultsRequest) This is a variant oflistSbomValidationResults(software.amazon.awssdk.services.iot.model.ListSbomValidationResultsRequest)
operation.listSbomValidationResultsPaginator
(ListSbomValidationResultsRequest listSbomValidationResultsRequest) This is a variant oflistSbomValidationResults(software.amazon.awssdk.services.iot.model.ListSbomValidationResultsRequest)
operation.Lists all of your scheduled audits.listScheduledAudits
(Consumer<ListScheduledAuditsRequest.Builder> listScheduledAuditsRequest) Lists all of your scheduled audits.listScheduledAudits
(ListScheduledAuditsRequest listScheduledAuditsRequest) Lists all of your scheduled audits.default ListScheduledAuditsPublisher
This is a variant oflistScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation.default ListScheduledAuditsPublisher
listScheduledAuditsPaginator
(Consumer<ListScheduledAuditsRequest.Builder> listScheduledAuditsRequest) This is a variant oflistScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation.default ListScheduledAuditsPublisher
listScheduledAuditsPaginator
(ListScheduledAuditsRequest listScheduledAuditsRequest) This is a variant oflistScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation.Lists the Device Defender security profiles you've created.listSecurityProfiles
(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest) Lists the Device Defender security profiles you've created.listSecurityProfiles
(ListSecurityProfilesRequest listSecurityProfilesRequest) Lists the Device Defender security profiles you've created.listSecurityProfilesForTarget
(Consumer<ListSecurityProfilesForTargetRequest.Builder> listSecurityProfilesForTargetRequest) Lists the Device Defender security profiles attached to a target (thing group).listSecurityProfilesForTarget
(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest) Lists the Device Defender security profiles attached to a target (thing group).listSecurityProfilesForTargetPaginator
(Consumer<ListSecurityProfilesForTargetRequest.Builder> listSecurityProfilesForTargetRequest) This is a variant oflistSecurityProfilesForTarget(software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetRequest)
operation.listSecurityProfilesForTargetPaginator
(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest) This is a variant oflistSecurityProfilesForTarget(software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetRequest)
operation.default ListSecurityProfilesPublisher
This is a variant oflistSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation.default ListSecurityProfilesPublisher
listSecurityProfilesPaginator
(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest) This is a variant oflistSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation.default ListSecurityProfilesPublisher
listSecurityProfilesPaginator
(ListSecurityProfilesRequest listSecurityProfilesRequest) This is a variant oflistSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation.default CompletableFuture
<ListStreamsResponse> Lists all of the streams in your Amazon Web Services account.default CompletableFuture
<ListStreamsResponse> listStreams
(Consumer<ListStreamsRequest.Builder> listStreamsRequest) Lists all of the streams in your Amazon Web Services account.default CompletableFuture
<ListStreamsResponse> listStreams
(ListStreamsRequest listStreamsRequest) Lists all of the streams in your Amazon Web Services account.default ListStreamsPublisher
This is a variant oflistStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation.default ListStreamsPublisher
listStreamsPaginator
(Consumer<ListStreamsRequest.Builder> listStreamsRequest) This is a variant oflistStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation.default ListStreamsPublisher
listStreamsPaginator
(ListStreamsRequest listStreamsRequest) This is a variant oflistStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.iot.model.ListTagsForResourceRequest)
operation.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.iot.model.ListTagsForResourceRequest)
operation.listTargetsForPolicy
(Consumer<ListTargetsForPolicyRequest.Builder> listTargetsForPolicyRequest) List targets for the specified policy.listTargetsForPolicy
(ListTargetsForPolicyRequest listTargetsForPolicyRequest) List targets for the specified policy.default ListTargetsForPolicyPublisher
listTargetsForPolicyPaginator
(Consumer<ListTargetsForPolicyRequest.Builder> listTargetsForPolicyRequest) This is a variant oflistTargetsForPolicy(software.amazon.awssdk.services.iot.model.ListTargetsForPolicyRequest)
operation.default ListTargetsForPolicyPublisher
listTargetsForPolicyPaginator
(ListTargetsForPolicyRequest listTargetsForPolicyRequest) This is a variant oflistTargetsForPolicy(software.amazon.awssdk.services.iot.model.ListTargetsForPolicyRequest)
operation.listTargetsForSecurityProfile
(Consumer<ListTargetsForSecurityProfileRequest.Builder> listTargetsForSecurityProfileRequest) Lists the targets (thing groups) associated with a given Device Defender security profile.listTargetsForSecurityProfile
(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest) Lists the targets (thing groups) associated with a given Device Defender security profile.listTargetsForSecurityProfilePaginator
(Consumer<ListTargetsForSecurityProfileRequest.Builder> listTargetsForSecurityProfileRequest) This is a variant oflistTargetsForSecurityProfile(software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileRequest)
operation.listTargetsForSecurityProfilePaginator
(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest) This is a variant oflistTargetsForSecurityProfile(software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileRequest)
operation.default CompletableFuture
<ListThingGroupsResponse> List the thing groups in your account.default CompletableFuture
<ListThingGroupsResponse> listThingGroups
(Consumer<ListThingGroupsRequest.Builder> listThingGroupsRequest) List the thing groups in your account.default CompletableFuture
<ListThingGroupsResponse> listThingGroups
(ListThingGroupsRequest listThingGroupsRequest) List the thing groups in your account.listThingGroupsForThing
(Consumer<ListThingGroupsForThingRequest.Builder> listThingGroupsForThingRequest) List the thing groups to which the specified thing belongs.listThingGroupsForThing
(ListThingGroupsForThingRequest listThingGroupsForThingRequest) List the thing groups to which the specified thing belongs.default ListThingGroupsForThingPublisher
listThingGroupsForThingPaginator
(Consumer<ListThingGroupsForThingRequest.Builder> listThingGroupsForThingRequest) This is a variant oflistThingGroupsForThing(software.amazon.awssdk.services.iot.model.ListThingGroupsForThingRequest)
operation.default ListThingGroupsForThingPublisher
listThingGroupsForThingPaginator
(ListThingGroupsForThingRequest listThingGroupsForThingRequest) This is a variant oflistThingGroupsForThing(software.amazon.awssdk.services.iot.model.ListThingGroupsForThingRequest)
operation.default ListThingGroupsPublisher
This is a variant oflistThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation.default ListThingGroupsPublisher
listThingGroupsPaginator
(Consumer<ListThingGroupsRequest.Builder> listThingGroupsRequest) This is a variant oflistThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation.default ListThingGroupsPublisher
listThingGroupsPaginator
(ListThingGroupsRequest listThingGroupsRequest) This is a variant oflistThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation.listThingPrincipals
(Consumer<ListThingPrincipalsRequest.Builder> listThingPrincipalsRequest) Lists the principals associated with the specified thing.listThingPrincipals
(ListThingPrincipalsRequest listThingPrincipalsRequest) Lists the principals associated with the specified thing.default ListThingPrincipalsPublisher
listThingPrincipalsPaginator
(Consumer<ListThingPrincipalsRequest.Builder> listThingPrincipalsRequest) This is a variant oflistThingPrincipals(software.amazon.awssdk.services.iot.model.ListThingPrincipalsRequest)
operation.default ListThingPrincipalsPublisher
listThingPrincipalsPaginator
(ListThingPrincipalsRequest listThingPrincipalsRequest) This is a variant oflistThingPrincipals(software.amazon.awssdk.services.iot.model.ListThingPrincipalsRequest)
operation.listThingRegistrationTaskReports
(Consumer<ListThingRegistrationTaskReportsRequest.Builder> listThingRegistrationTaskReportsRequest) Information about the thing registration tasks.listThingRegistrationTaskReports
(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest) Information about the thing registration tasks.listThingRegistrationTaskReportsPaginator
(Consumer<ListThingRegistrationTaskReportsRequest.Builder> listThingRegistrationTaskReportsRequest) This is a variant oflistThingRegistrationTaskReports(software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsRequest)
operation.listThingRegistrationTaskReportsPaginator
(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest) This is a variant oflistThingRegistrationTaskReports(software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsRequest)
operation.List bulk thing provisioning tasks.listThingRegistrationTasks
(Consumer<ListThingRegistrationTasksRequest.Builder> listThingRegistrationTasksRequest) List bulk thing provisioning tasks.listThingRegistrationTasks
(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest) List bulk thing provisioning tasks.This is a variant oflistThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation.listThingRegistrationTasksPaginator
(Consumer<ListThingRegistrationTasksRequest.Builder> listThingRegistrationTasksRequest) This is a variant oflistThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation.listThingRegistrationTasksPaginator
(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest) This is a variant oflistThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation.default CompletableFuture
<ListThingsResponse> Lists your things.default CompletableFuture
<ListThingsResponse> listThings
(Consumer<ListThingsRequest.Builder> listThingsRequest) Lists your things.default CompletableFuture
<ListThingsResponse> listThings
(ListThingsRequest listThingsRequest) Lists your things.listThingsInBillingGroup
(Consumer<ListThingsInBillingGroupRequest.Builder> listThingsInBillingGroupRequest) Lists the things you have added to the given billing group.listThingsInBillingGroup
(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest) Lists the things you have added to the given billing group.listThingsInBillingGroupPaginator
(Consumer<ListThingsInBillingGroupRequest.Builder> listThingsInBillingGroupRequest) This is a variant oflistThingsInBillingGroup(software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupRequest)
operation.listThingsInBillingGroupPaginator
(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest) This is a variant oflistThingsInBillingGroup(software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupRequest)
operation.listThingsInThingGroup
(Consumer<ListThingsInThingGroupRequest.Builder> listThingsInThingGroupRequest) Lists the things in the specified group.listThingsInThingGroup
(ListThingsInThingGroupRequest listThingsInThingGroupRequest) Lists the things in the specified group.default ListThingsInThingGroupPublisher
listThingsInThingGroupPaginator
(Consumer<ListThingsInThingGroupRequest.Builder> listThingsInThingGroupRequest) This is a variant oflistThingsInThingGroup(software.amazon.awssdk.services.iot.model.ListThingsInThingGroupRequest)
operation.default ListThingsInThingGroupPublisher
listThingsInThingGroupPaginator
(ListThingsInThingGroupRequest listThingsInThingGroupRequest) This is a variant oflistThingsInThingGroup(software.amazon.awssdk.services.iot.model.ListThingsInThingGroupRequest)
operation.default ListThingsPublisher
This is a variant oflistThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation.default ListThingsPublisher
listThingsPaginator
(Consumer<ListThingsRequest.Builder> listThingsRequest) This is a variant oflistThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation.default ListThingsPublisher
listThingsPaginator
(ListThingsRequest listThingsRequest) This is a variant oflistThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation.default CompletableFuture
<ListThingTypesResponse> Lists the existing thing types.default CompletableFuture
<ListThingTypesResponse> listThingTypes
(Consumer<ListThingTypesRequest.Builder> listThingTypesRequest) Lists the existing thing types.default CompletableFuture
<ListThingTypesResponse> listThingTypes
(ListThingTypesRequest listThingTypesRequest) Lists the existing thing types.default ListThingTypesPublisher
This is a variant oflistThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation.default ListThingTypesPublisher
listThingTypesPaginator
(Consumer<ListThingTypesRequest.Builder> listThingTypesRequest) This is a variant oflistThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation.default ListThingTypesPublisher
listThingTypesPaginator
(ListThingTypesRequest listThingTypesRequest) This is a variant oflistThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation.listTopicRuleDestinations
(Consumer<ListTopicRuleDestinationsRequest.Builder> listTopicRuleDestinationsRequest) Lists all the topic rule destinations in your Amazon Web Services account.listTopicRuleDestinations
(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest) Lists all the topic rule destinations in your Amazon Web Services account.listTopicRuleDestinationsPaginator
(Consumer<ListTopicRuleDestinationsRequest.Builder> listTopicRuleDestinationsRequest) This is a variant oflistTopicRuleDestinations(software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsRequest)
operation.listTopicRuleDestinationsPaginator
(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest) This is a variant oflistTopicRuleDestinations(software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsRequest)
operation.default CompletableFuture
<ListTopicRulesResponse> Lists the rules for the specific topic.default CompletableFuture
<ListTopicRulesResponse> listTopicRules
(Consumer<ListTopicRulesRequest.Builder> listTopicRulesRequest) Lists the rules for the specific topic.default CompletableFuture
<ListTopicRulesResponse> listTopicRules
(ListTopicRulesRequest listTopicRulesRequest) Lists the rules for the specific topic.default ListTopicRulesPublisher
This is a variant oflistTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation.default ListTopicRulesPublisher
listTopicRulesPaginator
(Consumer<ListTopicRulesRequest.Builder> listTopicRulesRequest) This is a variant oflistTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation.default ListTopicRulesPublisher
listTopicRulesPaginator
(ListTopicRulesRequest listTopicRulesRequest) This is a variant oflistTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation.listV2LoggingLevels
(Consumer<ListV2LoggingLevelsRequest.Builder> listV2LoggingLevelsRequest) Lists logging levels.listV2LoggingLevels
(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest) Lists logging levels.default ListV2LoggingLevelsPublisher
listV2LoggingLevelsPaginator
(Consumer<ListV2LoggingLevelsRequest.Builder> listV2LoggingLevelsRequest) This is a variant oflistV2LoggingLevels(software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsRequest)
operation.default ListV2LoggingLevelsPublisher
listV2LoggingLevelsPaginator
(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest) This is a variant oflistV2LoggingLevels(software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsRequest)
operation.listViolationEvents
(Consumer<ListViolationEventsRequest.Builder> listViolationEventsRequest) Lists the Device Defender security profile violations discovered during the given time period.listViolationEvents
(ListViolationEventsRequest listViolationEventsRequest) Lists the Device Defender security profile violations discovered during the given time period.default ListViolationEventsPublisher
listViolationEventsPaginator
(Consumer<ListViolationEventsRequest.Builder> listViolationEventsRequest) This is a variant oflistViolationEvents(software.amazon.awssdk.services.iot.model.ListViolationEventsRequest)
operation.default ListViolationEventsPublisher
listViolationEventsPaginator
(ListViolationEventsRequest listViolationEventsRequest) This is a variant oflistViolationEvents(software.amazon.awssdk.services.iot.model.ListViolationEventsRequest)
operation.putVerificationStateOnViolation
(Consumer<PutVerificationStateOnViolationRequest.Builder> putVerificationStateOnViolationRequest) Set a verification state and provide a description of that verification state on a violation (detect alarm).putVerificationStateOnViolation
(PutVerificationStateOnViolationRequest putVerificationStateOnViolationRequest) Set a verification state and provide a description of that verification state on a violation (detect alarm).registerCACertificate
(Consumer<RegisterCaCertificateRequest.Builder> registerCaCertificateRequest) Registers a CA certificate with Amazon Web Services IoT Core.registerCACertificate
(RegisterCaCertificateRequest registerCaCertificateRequest) Registers a CA certificate with Amazon Web Services IoT Core.registerCertificate
(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest) Registers a device certificate with IoT in the same certificate mode as the signing CA.registerCertificate
(RegisterCertificateRequest registerCertificateRequest) Registers a device certificate with IoT in the same certificate mode as the signing CA.registerCertificateWithoutCA
(Consumer<RegisterCertificateWithoutCaRequest.Builder> registerCertificateWithoutCaRequest) Register a certificate that does not have a certificate authority (CA).registerCertificateWithoutCA
(RegisterCertificateWithoutCaRequest registerCertificateWithoutCaRequest) Register a certificate that does not have a certificate authority (CA).default CompletableFuture
<RegisterThingResponse> registerThing
(Consumer<RegisterThingRequest.Builder> registerThingRequest) Provisions a thing in the device registry.default CompletableFuture
<RegisterThingResponse> registerThing
(RegisterThingRequest registerThingRequest) Provisions a thing in the device registry.rejectCertificateTransfer
(Consumer<RejectCertificateTransferRequest.Builder> rejectCertificateTransferRequest) Rejects a pending certificate transfer.rejectCertificateTransfer
(RejectCertificateTransferRequest rejectCertificateTransferRequest) Rejects a pending certificate transfer.removeThingFromBillingGroup
(Consumer<RemoveThingFromBillingGroupRequest.Builder> removeThingFromBillingGroupRequest) Removes the given thing from the billing group.removeThingFromBillingGroup
(RemoveThingFromBillingGroupRequest removeThingFromBillingGroupRequest) Removes the given thing from the billing group.removeThingFromThingGroup
(Consumer<RemoveThingFromThingGroupRequest.Builder> removeThingFromThingGroupRequest) Remove the specified thing from the specified group.removeThingFromThingGroup
(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest) Remove the specified thing from the specified group.replaceTopicRule
(Consumer<ReplaceTopicRuleRequest.Builder> replaceTopicRuleRequest) Replaces the rule.replaceTopicRule
(ReplaceTopicRuleRequest replaceTopicRuleRequest) Replaces the rule.default CompletableFuture
<SearchIndexResponse> searchIndex
(Consumer<SearchIndexRequest.Builder> searchIndexRequest) The query search index.default CompletableFuture
<SearchIndexResponse> searchIndex
(SearchIndexRequest searchIndexRequest) The query search index.default IotServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationsetDefaultAuthorizer
(Consumer<SetDefaultAuthorizerRequest.Builder> setDefaultAuthorizerRequest) Sets the default authorizer.setDefaultAuthorizer
(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest) Sets the default authorizer.setDefaultPolicyVersion
(Consumer<SetDefaultPolicyVersionRequest.Builder> setDefaultPolicyVersionRequest) Sets the specified version of the specified policy as the policy's default (operative) version.setDefaultPolicyVersion
(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) Sets the specified version of the specified policy as the policy's default (operative) version.setLoggingOptions
(Consumer<SetLoggingOptionsRequest.Builder> setLoggingOptionsRequest) Sets the logging options.setLoggingOptions
(SetLoggingOptionsRequest setLoggingOptionsRequest) Sets the logging options.setV2LoggingLevel
(Consumer<SetV2LoggingLevelRequest.Builder> setV2LoggingLevelRequest) Sets the logging level.setV2LoggingLevel
(SetV2LoggingLevelRequest setV2LoggingLevelRequest) Sets the logging level.setV2LoggingOptions
(Consumer<SetV2LoggingOptionsRequest.Builder> setV2LoggingOptionsRequest) Sets the logging options for the V2 logging service.setV2LoggingOptions
(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest) Sets the logging options for the V2 logging service.startAuditMitigationActionsTask
(Consumer<StartAuditMitigationActionsTaskRequest.Builder> startAuditMitigationActionsTaskRequest) Starts a task that applies a set of mitigation actions to the specified target.startAuditMitigationActionsTask
(StartAuditMitigationActionsTaskRequest startAuditMitigationActionsTaskRequest) Starts a task that applies a set of mitigation actions to the specified target.startDetectMitigationActionsTask
(Consumer<StartDetectMitigationActionsTaskRequest.Builder> startDetectMitigationActionsTaskRequest) Starts a Device Defender ML Detect mitigation actions task.startDetectMitigationActionsTask
(StartDetectMitigationActionsTaskRequest startDetectMitigationActionsTaskRequest) Starts a Device Defender ML Detect mitigation actions task.startOnDemandAuditTask
(Consumer<StartOnDemandAuditTaskRequest.Builder> startOnDemandAuditTaskRequest) Starts an on-demand Device Defender audit.startOnDemandAuditTask
(StartOnDemandAuditTaskRequest startOnDemandAuditTaskRequest) Starts an on-demand Device Defender audit.startThingRegistrationTask
(Consumer<StartThingRegistrationTaskRequest.Builder> startThingRegistrationTaskRequest) Creates a bulk thing provisioning task.startThingRegistrationTask
(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest) Creates a bulk thing provisioning task.stopThingRegistrationTask
(Consumer<StopThingRegistrationTaskRequest.Builder> stopThingRegistrationTaskRequest) Cancels a bulk thing provisioning task.stopThingRegistrationTask
(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest) Cancels a bulk thing provisioning task.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds to or modifies the tags of the given resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds to or modifies the tags of the given resource.testAuthorization
(Consumer<TestAuthorizationRequest.Builder> testAuthorizationRequest) Tests if a specified principal is authorized to perform an IoT action on a specified resource.testAuthorization
(TestAuthorizationRequest testAuthorizationRequest) Tests if a specified principal is authorized to perform an IoT action on a specified resource.testInvokeAuthorizer
(Consumer<TestInvokeAuthorizerRequest.Builder> testInvokeAuthorizerRequest) Tests a custom authorization behavior by invoking a specified custom authorizer.testInvokeAuthorizer
(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest) Tests a custom authorization behavior by invoking a specified custom authorizer.transferCertificate
(Consumer<TransferCertificateRequest.Builder> transferCertificateRequest) Transfers the specified certificate to the specified Amazon Web Services account.transferCertificate
(TransferCertificateRequest transferCertificateRequest) Transfers the specified certificate to the specified Amazon Web Services account.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the given tags (metadata) from the resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the given tags (metadata) from the resource.updateAccountAuditConfiguration
(Consumer<UpdateAccountAuditConfigurationRequest.Builder> updateAccountAuditConfigurationRequest) Configures or reconfigures the Device Defender audit settings for this account.updateAccountAuditConfiguration
(UpdateAccountAuditConfigurationRequest updateAccountAuditConfigurationRequest) Configures or reconfigures the Device Defender audit settings for this account.updateAuditSuppression
(Consumer<UpdateAuditSuppressionRequest.Builder> updateAuditSuppressionRequest) Updates a Device Defender audit suppression.updateAuditSuppression
(UpdateAuditSuppressionRequest updateAuditSuppressionRequest) Updates a Device Defender audit suppression.updateAuthorizer
(Consumer<UpdateAuthorizerRequest.Builder> updateAuthorizerRequest) Updates an authorizer.updateAuthorizer
(UpdateAuthorizerRequest updateAuthorizerRequest) Updates an authorizer.updateBillingGroup
(Consumer<UpdateBillingGroupRequest.Builder> updateBillingGroupRequest) Updates information about the billing group.updateBillingGroup
(UpdateBillingGroupRequest updateBillingGroupRequest) Updates information about the billing group.updateCACertificate
(Consumer<UpdateCaCertificateRequest.Builder> updateCaCertificateRequest) Updates a registered CA certificate.updateCACertificate
(UpdateCaCertificateRequest updateCaCertificateRequest) Updates a registered CA certificate.updateCertificate
(Consumer<UpdateCertificateRequest.Builder> updateCertificateRequest) Updates the status of the specified certificate.updateCertificate
(UpdateCertificateRequest updateCertificateRequest) Updates the status of the specified certificate.updateCertificateProvider
(Consumer<UpdateCertificateProviderRequest.Builder> updateCertificateProviderRequest) Updates a certificate provider.updateCertificateProvider
(UpdateCertificateProviderRequest updateCertificateProviderRequest) Updates a certificate provider.updateCustomMetric
(Consumer<UpdateCustomMetricRequest.Builder> updateCustomMetricRequest) Updates a Device Defender detect custom metric.updateCustomMetric
(UpdateCustomMetricRequest updateCustomMetricRequest) Updates a Device Defender detect custom metric.default CompletableFuture
<UpdateDimensionResponse> updateDimension
(Consumer<UpdateDimensionRequest.Builder> updateDimensionRequest) Updates the definition for a dimension.default CompletableFuture
<UpdateDimensionResponse> updateDimension
(UpdateDimensionRequest updateDimensionRequest) Updates the definition for a dimension.updateDomainConfiguration
(Consumer<UpdateDomainConfigurationRequest.Builder> updateDomainConfigurationRequest) Updates values stored in the domain configuration.updateDomainConfiguration
(UpdateDomainConfigurationRequest updateDomainConfigurationRequest) Updates values stored in the domain configuration.updateDynamicThingGroup
(Consumer<UpdateDynamicThingGroupRequest.Builder> updateDynamicThingGroupRequest) Updates a dynamic thing group.updateDynamicThingGroup
(UpdateDynamicThingGroupRequest updateDynamicThingGroupRequest) Updates a dynamic thing group.updateEventConfigurations
(Consumer<UpdateEventConfigurationsRequest.Builder> updateEventConfigurationsRequest) Updates the event configurations.updateEventConfigurations
(UpdateEventConfigurationsRequest updateEventConfigurationsRequest) Updates the event configurations.updateFleetMetric
(Consumer<UpdateFleetMetricRequest.Builder> updateFleetMetricRequest) Updates the data for a fleet metric.updateFleetMetric
(UpdateFleetMetricRequest updateFleetMetricRequest) Updates the data for a fleet metric.updateIndexingConfiguration
(Consumer<UpdateIndexingConfigurationRequest.Builder> updateIndexingConfigurationRequest) Updates the search configuration.updateIndexingConfiguration
(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest) Updates the search configuration.default CompletableFuture
<UpdateJobResponse> updateJob
(Consumer<UpdateJobRequest.Builder> updateJobRequest) Updates supported fields of the specified job.default CompletableFuture
<UpdateJobResponse> updateJob
(UpdateJobRequest updateJobRequest) Updates supported fields of the specified job.updateMitigationAction
(Consumer<UpdateMitigationActionRequest.Builder> updateMitigationActionRequest) Updates the definition for the specified mitigation action.updateMitigationAction
(UpdateMitigationActionRequest updateMitigationActionRequest) Updates the definition for the specified mitigation action.default CompletableFuture
<UpdatePackageResponse> updatePackage
(Consumer<UpdatePackageRequest.Builder> updatePackageRequest) Updates the supported fields for a specific software package.default CompletableFuture
<UpdatePackageResponse> updatePackage
(UpdatePackageRequest updatePackageRequest) Updates the supported fields for a specific software package.updatePackageConfiguration
(Consumer<UpdatePackageConfigurationRequest.Builder> updatePackageConfigurationRequest) Updates the software package configuration.updatePackageConfiguration
(UpdatePackageConfigurationRequest updatePackageConfigurationRequest) Updates the software package configuration.updatePackageVersion
(Consumer<UpdatePackageVersionRequest.Builder> updatePackageVersionRequest) Updates the supported fields for a specific package version.updatePackageVersion
(UpdatePackageVersionRequest updatePackageVersionRequest) Updates the supported fields for a specific package version.updateProvisioningTemplate
(Consumer<UpdateProvisioningTemplateRequest.Builder> updateProvisioningTemplateRequest) Updates a provisioning template.updateProvisioningTemplate
(UpdateProvisioningTemplateRequest updateProvisioningTemplateRequest) Updates a provisioning template.default CompletableFuture
<UpdateRoleAliasResponse> updateRoleAlias
(Consumer<UpdateRoleAliasRequest.Builder> updateRoleAliasRequest) Updates a role alias.default CompletableFuture
<UpdateRoleAliasResponse> updateRoleAlias
(UpdateRoleAliasRequest updateRoleAliasRequest) Updates a role alias.updateScheduledAudit
(Consumer<UpdateScheduledAuditRequest.Builder> updateScheduledAuditRequest) Updates a scheduled audit, including which checks are performed and how often the audit takes place.updateScheduledAudit
(UpdateScheduledAuditRequest updateScheduledAuditRequest) Updates a scheduled audit, including which checks are performed and how often the audit takes place.updateSecurityProfile
(Consumer<UpdateSecurityProfileRequest.Builder> updateSecurityProfileRequest) Updates a Device Defender security profile.updateSecurityProfile
(UpdateSecurityProfileRequest updateSecurityProfileRequest) Updates a Device Defender security profile.default CompletableFuture
<UpdateStreamResponse> updateStream
(Consumer<UpdateStreamRequest.Builder> updateStreamRequest) Updates an existing stream.default CompletableFuture
<UpdateStreamResponse> updateStream
(UpdateStreamRequest updateStreamRequest) Updates an existing stream.default CompletableFuture
<UpdateThingResponse> updateThing
(Consumer<UpdateThingRequest.Builder> updateThingRequest) Updates the data for a thing.default CompletableFuture
<UpdateThingResponse> updateThing
(UpdateThingRequest updateThingRequest) Updates the data for a thing.updateThingGroup
(Consumer<UpdateThingGroupRequest.Builder> updateThingGroupRequest) Update a thing group.updateThingGroup
(UpdateThingGroupRequest updateThingGroupRequest) Update a thing group.updateThingGroupsForThing
(Consumer<UpdateThingGroupsForThingRequest.Builder> updateThingGroupsForThingRequest) Updates the groups to which the thing belongs.updateThingGroupsForThing
(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest) Updates the groups to which the thing belongs.updateTopicRuleDestination
(Consumer<UpdateTopicRuleDestinationRequest.Builder> updateTopicRuleDestinationRequest) Updates a topic rule destination.updateTopicRuleDestination
(UpdateTopicRuleDestinationRequest updateTopicRuleDestinationRequest) Updates a topic rule destination.validateSecurityProfileBehaviors
(Consumer<ValidateSecurityProfileBehaviorsRequest.Builder> validateSecurityProfileBehaviorsRequest) Validates a Device Defender security profile behaviors specification.validateSecurityProfileBehaviors
(ValidateSecurityProfileBehaviorsRequest validateSecurityProfileBehaviorsRequest) Validates a Device Defender security profile behaviors specification.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
acceptCertificateTransfer
default CompletableFuture<AcceptCertificateTransferResponse> 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.
- Parameters:
acceptCertificateTransferRequest
- The input for the AcceptCertificateTransfer operation.- Returns:
- A Java Future containing the result of the AcceptCertificateTransfer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
acceptCertificateTransfer
default CompletableFuture<AcceptCertificateTransferResponse> acceptCertificateTransfer(Consumer<AcceptCertificateTransferRequest.Builder> 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.
This is a convenience which creates an instance of the
AcceptCertificateTransferRequest.Builder
avoiding the need to create one manually viaAcceptCertificateTransferRequest.builder()
- Parameters:
acceptCertificateTransferRequest
- AConsumer
that will call methods onAcceptCertificateTransferRequest.Builder
to create a request. The input for the AcceptCertificateTransfer operation.- Returns:
- A Java Future containing the result of the AcceptCertificateTransfer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
addThingToBillingGroup
default CompletableFuture<AddThingToBillingGroupResponse> addThingToBillingGroup(AddThingToBillingGroupRequest addThingToBillingGroupRequest) Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
- Parameters:
addThingToBillingGroupRequest
-- Returns:
- A Java Future containing the result of the AddThingToBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
addThingToBillingGroup
default CompletableFuture<AddThingToBillingGroupResponse> addThingToBillingGroup(Consumer<AddThingToBillingGroupRequest.Builder> addThingToBillingGroupRequest) Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
This is a convenience which creates an instance of the
AddThingToBillingGroupRequest.Builder
avoiding the need to create one manually viaAddThingToBillingGroupRequest.builder()
- Parameters:
addThingToBillingGroupRequest
- AConsumer
that will call methods onAddThingToBillingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddThingToBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
addThingToThingGroup
default CompletableFuture<AddThingToThingGroupResponse> addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest) Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
- Parameters:
addThingToThingGroupRequest
-- Returns:
- A Java Future containing the result of the AddThingToThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
addThingToThingGroup
default CompletableFuture<AddThingToThingGroupResponse> addThingToThingGroup(Consumer<AddThingToThingGroupRequest.Builder> addThingToThingGroupRequest) Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
This is a convenience which creates an instance of the
AddThingToThingGroupRequest.Builder
avoiding the need to create one manually viaAddThingToThingGroupRequest.builder()
- Parameters:
addThingToThingGroupRequest
- AConsumer
that will call methods onAddThingToThingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AddThingToThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
associateSbomWithPackageVersion
default CompletableFuture<AssociateSbomWithPackageVersionResponse> associateSbomWithPackageVersion(AssociateSbomWithPackageVersionRequest associateSbomWithPackageVersionRequest) Associates the selected software bill of materials (SBOM) with a specific software package version.
Requires permission to access the AssociateSbomWithPackageVersion action.
- Parameters:
associateSbomWithPackageVersionRequest
-- Returns:
- A Java Future containing the result of the AssociateSbomWithPackageVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
associateSbomWithPackageVersion
default CompletableFuture<AssociateSbomWithPackageVersionResponse> associateSbomWithPackageVersion(Consumer<AssociateSbomWithPackageVersionRequest.Builder> associateSbomWithPackageVersionRequest) Associates the selected software bill of materials (SBOM) with a specific software package version.
Requires permission to access the AssociateSbomWithPackageVersion action.
This is a convenience which creates an instance of the
AssociateSbomWithPackageVersionRequest.Builder
avoiding the need to create one manually viaAssociateSbomWithPackageVersionRequest.builder()
- Parameters:
associateSbomWithPackageVersionRequest
- AConsumer
that will call methods onAssociateSbomWithPackageVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateSbomWithPackageVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
associateTargetsWithJob
default CompletableFuture<AssociateTargetsWithJobResponse> 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.
- Parameters:
associateTargetsWithJobRequest
-- Returns:
- A Java Future containing the result of the AssociateTargetsWithJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
associateTargetsWithJob
default CompletableFuture<AssociateTargetsWithJobResponse> associateTargetsWithJob(Consumer<AssociateTargetsWithJobRequest.Builder> 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.
This is a convenience which creates an instance of the
AssociateTargetsWithJobRequest.Builder
avoiding the need to create one manually viaAssociateTargetsWithJobRequest.builder()
- Parameters:
associateTargetsWithJobRequest
- AConsumer
that will call methods onAssociateTargetsWithJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateTargetsWithJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
attachPolicy
default CompletableFuture<AttachPolicyResponse> attachPolicy(AttachPolicyRequest attachPolicyRequest) Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
- Parameters:
attachPolicyRequest
-- Returns:
- A Java Future containing the result of the AttachPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
attachPolicy
default CompletableFuture<AttachPolicyResponse> attachPolicy(Consumer<AttachPolicyRequest.Builder> attachPolicyRequest) Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
This is a convenience which creates an instance of the
AttachPolicyRequest.Builder
avoiding the need to create one manually viaAttachPolicyRequest.builder()
- Parameters:
attachPolicyRequest
- AConsumer
that will call methods onAttachPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AttachPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
attachSecurityProfile
default CompletableFuture<AttachSecurityProfileResponse> 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.
- Parameters:
attachSecurityProfileRequest
-- Returns:
- A Java Future containing the result of the AttachSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
attachSecurityProfile
default CompletableFuture<AttachSecurityProfileResponse> attachSecurityProfile(Consumer<AttachSecurityProfileRequest.Builder> 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.
This is a convenience which creates an instance of the
AttachSecurityProfileRequest.Builder
avoiding the need to create one manually viaAttachSecurityProfileRequest.builder()
- Parameters:
attachSecurityProfileRequest
- AConsumer
that will call methods onAttachSecurityProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AttachSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
attachThingPrincipal
default CompletableFuture<AttachThingPrincipalResponse> 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.
- Parameters:
attachThingPrincipalRequest
- The input for the AttachThingPrincipal operation.- Returns:
- A Java Future containing the result of the AttachThingPrincipal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
attachThingPrincipal
default CompletableFuture<AttachThingPrincipalResponse> attachThingPrincipal(Consumer<AttachThingPrincipalRequest.Builder> 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.
This is a convenience which creates an instance of the
AttachThingPrincipalRequest.Builder
avoiding the need to create one manually viaAttachThingPrincipalRequest.builder()
- Parameters:
attachThingPrincipalRequest
- AConsumer
that will call methods onAttachThingPrincipalRequest.Builder
to create a request. The input for the AttachThingPrincipal operation.- Returns:
- A Java Future containing the result of the AttachThingPrincipal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelAuditMitigationActionsTask
default CompletableFuture<CancelAuditMitigationActionsTaskResponse> 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.
- Parameters:
cancelAuditMitigationActionsTaskRequest
-- Returns:
- A Java Future containing the result of the CancelAuditMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelAuditMitigationActionsTask
default CompletableFuture<CancelAuditMitigationActionsTaskResponse> cancelAuditMitigationActionsTask(Consumer<CancelAuditMitigationActionsTaskRequest.Builder> 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.
This is a convenience which creates an instance of the
CancelAuditMitigationActionsTaskRequest.Builder
avoiding the need to create one manually viaCancelAuditMitigationActionsTaskRequest.builder()
- Parameters:
cancelAuditMitigationActionsTaskRequest
- AConsumer
that will call methods onCancelAuditMitigationActionsTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelAuditMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelAuditTask
default CompletableFuture<CancelAuditTaskResponse> 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.
- Parameters:
cancelAuditTaskRequest
-- Returns:
- A Java Future containing the result of the CancelAuditTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelAuditTask
default CompletableFuture<CancelAuditTaskResponse> cancelAuditTask(Consumer<CancelAuditTaskRequest.Builder> 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.
This is a convenience which creates an instance of the
CancelAuditTaskRequest.Builder
avoiding the need to create one manually viaCancelAuditTaskRequest.builder()
- Parameters:
cancelAuditTaskRequest
- AConsumer
that will call methods onCancelAuditTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelAuditTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelCertificateTransfer
default CompletableFuture<CancelCertificateTransferResponse> 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.
- Parameters:
cancelCertificateTransferRequest
- The input for the CancelCertificateTransfer operation.- Returns:
- A Java Future containing the result of the CancelCertificateTransfer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelCertificateTransfer
default CompletableFuture<CancelCertificateTransferResponse> cancelCertificateTransfer(Consumer<CancelCertificateTransferRequest.Builder> 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.
This is a convenience which creates an instance of the
CancelCertificateTransferRequest.Builder
avoiding the need to create one manually viaCancelCertificateTransferRequest.builder()
- Parameters:
cancelCertificateTransferRequest
- AConsumer
that will call methods onCancelCertificateTransferRequest.Builder
to create a request. The input for the CancelCertificateTransfer operation.- Returns:
- A Java Future containing the result of the CancelCertificateTransfer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelDetectMitigationActionsTask
default CompletableFuture<CancelDetectMitigationActionsTaskResponse> cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest) Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
- Parameters:
cancelDetectMitigationActionsTaskRequest
-- Returns:
- A Java Future containing the result of the CancelDetectMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelDetectMitigationActionsTask
default CompletableFuture<CancelDetectMitigationActionsTaskResponse> cancelDetectMitigationActionsTask(Consumer<CancelDetectMitigationActionsTaskRequest.Builder> cancelDetectMitigationActionsTaskRequest) Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
This is a convenience which creates an instance of the
CancelDetectMitigationActionsTaskRequest.Builder
avoiding the need to create one manually viaCancelDetectMitigationActionsTaskRequest.builder()
- Parameters:
cancelDetectMitigationActionsTaskRequest
- AConsumer
that will call methods onCancelDetectMitigationActionsTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelDetectMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelJob
Cancels a job.
Requires permission to access the CancelJob action.
- Parameters:
cancelJobRequest
-- Returns:
- A Java Future containing the result of the CancelJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelJob
default CompletableFuture<CancelJobResponse> cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest) Cancels a job.
Requires permission to access the CancelJob action.
This is a convenience which creates an instance of the
CancelJobRequest.Builder
avoiding the need to create one manually viaCancelJobRequest.builder()
- Parameters:
cancelJobRequest
- AConsumer
that will call methods onCancelJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelJobExecution
default CompletableFuture<CancelJobExecutionResponse> cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest) Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
- Parameters:
cancelJobExecutionRequest
-- Returns:
- A Java Future containing the result of the CancelJobExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelJobExecution
default CompletableFuture<CancelJobExecutionResponse> cancelJobExecution(Consumer<CancelJobExecutionRequest.Builder> cancelJobExecutionRequest) Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
This is a convenience which creates an instance of the
CancelJobExecutionRequest.Builder
avoiding the need to create one manually viaCancelJobExecutionRequest.builder()
- Parameters:
cancelJobExecutionRequest
- AConsumer
that will call methods onCancelJobExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelJobExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
clearDefaultAuthorizer
default CompletableFuture<ClearDefaultAuthorizerResponse> clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest) Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
- Parameters:
clearDefaultAuthorizerRequest
-- Returns:
- A Java Future containing the result of the ClearDefaultAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
clearDefaultAuthorizer
default CompletableFuture<ClearDefaultAuthorizerResponse> clearDefaultAuthorizer(Consumer<ClearDefaultAuthorizerRequest.Builder> clearDefaultAuthorizerRequest) Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
This is a convenience which creates an instance of the
ClearDefaultAuthorizerRequest.Builder
avoiding the need to create one manually viaClearDefaultAuthorizerRequest.builder()
- Parameters:
clearDefaultAuthorizerRequest
- AConsumer
that will call methods onClearDefaultAuthorizerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ClearDefaultAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
clearDefaultAuthorizer
Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
- Returns:
- A Java Future containing the result of the ClearDefaultAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
confirmTopicRuleDestination
default CompletableFuture<ConfirmTopicRuleDestinationResponse> 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.
- Parameters:
confirmTopicRuleDestinationRequest
-- Returns:
- A Java Future containing the result of the ConfirmTopicRuleDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
confirmTopicRuleDestination
default CompletableFuture<ConfirmTopicRuleDestinationResponse> confirmTopicRuleDestination(Consumer<ConfirmTopicRuleDestinationRequest.Builder> 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.
This is a convenience which creates an instance of the
ConfirmTopicRuleDestinationRequest.Builder
avoiding the need to create one manually viaConfirmTopicRuleDestinationRequest.builder()
- Parameters:
confirmTopicRuleDestinationRequest
- AConsumer
that will call methods onConfirmTopicRuleDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ConfirmTopicRuleDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createAuditSuppression
default CompletableFuture<CreateAuditSuppressionResponse> createAuditSuppression(CreateAuditSuppressionRequest createAuditSuppressionRequest) Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
- Parameters:
createAuditSuppressionRequest
-- Returns:
- A Java Future containing the result of the CreateAuditSuppression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createAuditSuppression
default CompletableFuture<CreateAuditSuppressionResponse> createAuditSuppression(Consumer<CreateAuditSuppressionRequest.Builder> createAuditSuppressionRequest) Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
This is a convenience which creates an instance of the
CreateAuditSuppressionRequest.Builder
avoiding the need to create one manually viaCreateAuditSuppressionRequest.builder()
- Parameters:
createAuditSuppressionRequest
- AConsumer
that will call methods onCreateAuditSuppressionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAuditSuppression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createAuthorizer
default CompletableFuture<CreateAuthorizerResponse> createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest) Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
- Parameters:
createAuthorizerRequest
-- Returns:
- A Java Future containing the result of the CreateAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createAuthorizer
default CompletableFuture<CreateAuthorizerResponse> createAuthorizer(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest) Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
This is a convenience which creates an instance of the
CreateAuthorizerRequest.Builder
avoiding the need to create one manually viaCreateAuthorizerRequest.builder()
- Parameters:
createAuthorizerRequest
- AConsumer
that will call methods onCreateAuthorizerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createBillingGroup
default CompletableFuture<CreateBillingGroupResponse> createBillingGroup(CreateBillingGroupRequest createBillingGroupRequest) Creates a billing group. If this call is made multiple times using the same billing group name and configuration, the call will succeed. If this call is made with the same billing group name but different configuration a
ResourceAlreadyExistsException
is thrown.Requires permission to access the CreateBillingGroup action.
- Parameters:
createBillingGroupRequest
-- Returns:
- A Java Future containing the result of the CreateBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ResourceAlreadyExistsException The resource already exists.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createBillingGroup
default CompletableFuture<CreateBillingGroupResponse> createBillingGroup(Consumer<CreateBillingGroupRequest.Builder> createBillingGroupRequest) Creates a billing group. If this call is made multiple times using the same billing group name and configuration, the call will succeed. If this call is made with the same billing group name but different configuration a
ResourceAlreadyExistsException
is thrown.Requires permission to access the CreateBillingGroup action.
This is a convenience which creates an instance of the
CreateBillingGroupRequest.Builder
avoiding the need to create one manually viaCreateBillingGroupRequest.builder()
- Parameters:
createBillingGroupRequest
- AConsumer
that will call methods onCreateBillingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ResourceAlreadyExistsException The resource already exists.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createCertificateFromCsr
default CompletableFuture<CreateCertificateFromCsrResponse> 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:
invalid input: '$' 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:invalid input: '$' 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/invalid input: '$'_}
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"
- Parameters:
createCertificateFromCsrRequest
- The input for the CreateCertificateFromCsr operation.- Returns:
- A Java Future containing the result of the CreateCertificateFromCsr operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createCertificateFromCsr
default CompletableFuture<CreateCertificateFromCsrResponse> createCertificateFromCsr(Consumer<CreateCertificateFromCsrRequest.Builder> 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:
invalid input: '$' 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:invalid input: '$' 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/invalid input: '$'_}
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"
This is a convenience which creates an instance of the
CreateCertificateFromCsrRequest.Builder
avoiding the need to create one manually viaCreateCertificateFromCsrRequest.builder()
- Parameters:
createCertificateFromCsrRequest
- AConsumer
that will call methods onCreateCertificateFromCsrRequest.Builder
to create a request. The input for the CreateCertificateFromCsr operation.- Returns:
- A Java Future containing the result of the CreateCertificateFromCsr operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createCertificateProvider
default CompletableFuture<CreateCertificateProviderResponse> 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 toCreateCertificateFromCsr
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.- Parameters:
createCertificateProviderRequest
-- Returns:
- A Java Future containing the result of the CreateCertificateProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createCertificateProvider
default CompletableFuture<CreateCertificateProviderResponse> createCertificateProvider(Consumer<CreateCertificateProviderRequest.Builder> 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 toCreateCertificateFromCsr
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.
This is a convenience which creates an instance of the
CreateCertificateProviderRequest.Builder
avoiding the need to create one manually viaCreateCertificateProviderRequest.builder()
- Parameters:
createCertificateProviderRequest
- AConsumer
that will call methods onCreateCertificateProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCertificateProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createCustomMetric
default CompletableFuture<CreateCustomMetricResponse> 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.
- Parameters:
createCustomMetricRequest
-- Returns:
- A Java Future containing the result of the CreateCustomMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createCustomMetric
default CompletableFuture<CreateCustomMetricResponse> createCustomMetric(Consumer<CreateCustomMetricRequest.Builder> createCustomMetricRequest) Use this API to define a Custom Metric published by your devices to Device Defender.
Requires permission to access the CreateCustomMetric action.
This is a convenience which creates an instance of the
CreateCustomMetricRequest.Builder
avoiding the need to create one manually viaCreateCustomMetricRequest.builder()
- Parameters:
createCustomMetricRequest
- AConsumer
that will call methods onCreateCustomMetricRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCustomMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createDimension
default CompletableFuture<CreateDimensionResponse> 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.
- Parameters:
createDimensionRequest
-- Returns:
- A Java Future containing the result of the CreateDimension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createDimension
default CompletableFuture<CreateDimensionResponse> createDimension(Consumer<CreateDimensionRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateDimensionRequest.Builder
avoiding the need to create one manually viaCreateDimensionRequest.builder()
- Parameters:
createDimensionRequest
- AConsumer
that will call methods onCreateDimensionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDimension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createDomainConfiguration
default CompletableFuture<CreateDomainConfigurationResponse> createDomainConfiguration(CreateDomainConfigurationRequest createDomainConfigurationRequest) Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
- Parameters:
createDomainConfigurationRequest
-- Returns:
- A Java Future containing the result of the CreateDomainConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createDomainConfiguration
default CompletableFuture<CreateDomainConfigurationResponse> createDomainConfiguration(Consumer<CreateDomainConfigurationRequest.Builder> createDomainConfigurationRequest) Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
This is a convenience which creates an instance of the
CreateDomainConfigurationRequest.Builder
avoiding the need to create one manually viaCreateDomainConfigurationRequest.builder()
- Parameters:
createDomainConfigurationRequest
- AConsumer
that will call methods onCreateDomainConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDomainConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createDynamicThingGroup
default CompletableFuture<CreateDynamicThingGroupResponse> createDynamicThingGroup(CreateDynamicThingGroupRequest createDynamicThingGroupRequest) Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
- Parameters:
createDynamicThingGroupRequest
-- Returns:
- A Java Future containing the result of the CreateDynamicThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createDynamicThingGroup
default CompletableFuture<CreateDynamicThingGroupResponse> createDynamicThingGroup(Consumer<CreateDynamicThingGroupRequest.Builder> createDynamicThingGroupRequest) Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
This is a convenience which creates an instance of the
CreateDynamicThingGroupRequest.Builder
avoiding the need to create one manually viaCreateDynamicThingGroupRequest.builder()
- Parameters:
createDynamicThingGroupRequest
- AConsumer
that will call methods onCreateDynamicThingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDynamicThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createFleetMetric
default CompletableFuture<CreateFleetMetricResponse> createFleetMetric(CreateFleetMetricRequest createFleetMetricRequest) Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
- Parameters:
createFleetMetricRequest
-- Returns:
- A Java Future containing the result of the CreateFleetMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createFleetMetric
default CompletableFuture<CreateFleetMetricResponse> createFleetMetric(Consumer<CreateFleetMetricRequest.Builder> createFleetMetricRequest) Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
This is a convenience which creates an instance of the
CreateFleetMetricRequest.Builder
avoiding the need to create one manually viaCreateFleetMetricRequest.builder()
- Parameters:
createFleetMetricRequest
- AConsumer
that will call methods onCreateFleetMetricRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateFleetMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createJob
Creates a job.
Requires permission to access the CreateJob action.
- Parameters:
createJobRequest
-- Returns:
- A Java Future containing the result of the CreateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createJob
default CompletableFuture<CreateJobResponse> createJob(Consumer<CreateJobRequest.Builder> createJobRequest) Creates a job.
Requires permission to access the CreateJob action.
This is a convenience which creates an instance of the
CreateJobRequest.Builder
avoiding the need to create one manually viaCreateJobRequest.builder()
- Parameters:
createJobRequest
- AConsumer
that will call methods onCreateJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createJobTemplate
default CompletableFuture<CreateJobTemplateResponse> createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest) Creates a job template.
Requires permission to access the CreateJobTemplate action.
- Parameters:
createJobTemplateRequest
-- Returns:
- A Java Future containing the result of the CreateJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createJobTemplate
default CompletableFuture<CreateJobTemplateResponse> createJobTemplate(Consumer<CreateJobTemplateRequest.Builder> createJobTemplateRequest) Creates a job template.
Requires permission to access the CreateJobTemplate action.
This is a convenience which creates an instance of the
CreateJobTemplateRequest.Builder
avoiding the need to create one manually viaCreateJobTemplateRequest.builder()
- Parameters:
createJobTemplateRequest
- AConsumer
that will call methods onCreateJobTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createKeysAndCertificate
default CompletableFuture<CreateKeysAndCertificateResponse> 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.
- Parameters:
createKeysAndCertificateRequest
- The input for the CreateKeysAndCertificate operation.Requires permission to access the CreateKeysAndCertificateRequest action.
- Returns:
- A Java Future containing the result of the CreateKeysAndCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createKeysAndCertificate
default CompletableFuture<CreateKeysAndCertificateResponse> createKeysAndCertificate(Consumer<CreateKeysAndCertificateRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateKeysAndCertificateRequest.Builder
avoiding the need to create one manually viaCreateKeysAndCertificateRequest.builder()
- Parameters:
createKeysAndCertificateRequest
- AConsumer
that will call methods onCreateKeysAndCertificateRequest.Builder
to create a request. The input for the CreateKeysAndCertificate operation.Requires permission to access the CreateKeysAndCertificateRequest action.
- Returns:
- A Java Future containing the result of the CreateKeysAndCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createKeysAndCertificate
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.
- Returns:
- A Java Future containing the result of the CreateKeysAndCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createMitigationAction
default CompletableFuture<CreateMitigationActionResponse> 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.
- Parameters:
createMitigationActionRequest
-- Returns:
- A Java Future containing the result of the CreateMitigationAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createMitigationAction
default CompletableFuture<CreateMitigationActionResponse> createMitigationAction(Consumer<CreateMitigationActionRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateMitigationActionRequest.Builder
avoiding the need to create one manually viaCreateMitigationActionRequest.builder()
- Parameters:
createMitigationActionRequest
- AConsumer
that will call methods onCreateMitigationActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMitigationAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createOTAUpdate
default CompletableFuture<CreateOtaUpdateResponse> createOTAUpdate(CreateOtaUpdateRequest createOtaUpdateRequest) Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
- Parameters:
createOtaUpdateRequest
-- Returns:
- A Java Future containing the result of the CreateOTAUpdate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createOTAUpdate
default CompletableFuture<CreateOtaUpdateResponse> createOTAUpdate(Consumer<CreateOtaUpdateRequest.Builder> createOtaUpdateRequest) Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
This is a convenience which creates an instance of the
CreateOtaUpdateRequest.Builder
avoiding the need to create one manually viaCreateOtaUpdateRequest.builder()
- Parameters:
createOtaUpdateRequest
- AConsumer
that will call methods onCreateOtaUpdateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateOTAUpdate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createPackage
default CompletableFuture<CreatePackageResponse> createPackage(CreatePackageRequest createPackageRequest) Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
- Parameters:
createPackageRequest
-- Returns:
- A Java Future containing the result of the CreatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createPackage
default CompletableFuture<CreatePackageResponse> createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest) Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
This is a convenience which creates an instance of the
CreatePackageRequest.Builder
avoiding the need to create one manually viaCreatePackageRequest.builder()
- Parameters:
createPackageRequest
- AConsumer
that will call methods onCreatePackageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createPackageVersion
default CompletableFuture<CreatePackageVersionResponse> createPackageVersion(CreatePackageVersionRequest createPackageVersionRequest) Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
- Parameters:
createPackageVersionRequest
-- Returns:
- A Java Future containing the result of the CreatePackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createPackageVersion
default CompletableFuture<CreatePackageVersionResponse> createPackageVersion(Consumer<CreatePackageVersionRequest.Builder> createPackageVersionRequest) Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
This is a convenience which creates an instance of the
CreatePackageVersionRequest.Builder
avoiding the need to create one manually viaCreatePackageVersionRequest.builder()
- Parameters:
createPackageVersionRequest
- AConsumer
that will call methods onCreatePackageVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createPolicy
default CompletableFuture<CreatePolicyResponse> 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.
- Parameters:
createPolicyRequest
- The input for the CreatePolicy operation.- Returns:
- A Java Future containing the result of the CreatePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createPolicy
default CompletableFuture<CreatePolicyResponse> createPolicy(Consumer<CreatePolicyRequest.Builder> 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.
This is a convenience which creates an instance of the
CreatePolicyRequest.Builder
avoiding the need to create one manually viaCreatePolicyRequest.builder()
- Parameters:
createPolicyRequest
- AConsumer
that will call methods onCreatePolicyRequest.Builder
to create a request. The input for the CreatePolicy operation.- Returns:
- A Java Future containing the result of the CreatePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createPolicyVersion
default CompletableFuture<CreatePolicyVersionResponse> 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.
- Parameters:
createPolicyVersionRequest
- The input for the CreatePolicyVersion operation.- Returns:
- A Java Future containing the result of the CreatePolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createPolicyVersion
default CompletableFuture<CreatePolicyVersionResponse> createPolicyVersion(Consumer<CreatePolicyVersionRequest.Builder> 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.
This is a convenience which creates an instance of the
CreatePolicyVersionRequest.Builder
avoiding the need to create one manually viaCreatePolicyVersionRequest.builder()
- Parameters:
createPolicyVersionRequest
- AConsumer
that will call methods onCreatePolicyVersionRequest.Builder
to create a request. The input for the CreatePolicyVersion operation.- Returns:
- A Java Future containing the result of the CreatePolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createProvisioningClaim
default CompletableFuture<CreateProvisioningClaimResponse> createProvisioningClaim(CreateProvisioningClaimRequest createProvisioningClaimRequest) Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
- Parameters:
createProvisioningClaimRequest
-- Returns:
- A Java Future containing the result of the CreateProvisioningClaim operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createProvisioningClaim
default CompletableFuture<CreateProvisioningClaimResponse> createProvisioningClaim(Consumer<CreateProvisioningClaimRequest.Builder> createProvisioningClaimRequest) Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
This is a convenience which creates an instance of the
CreateProvisioningClaimRequest.Builder
avoiding the need to create one manually viaCreateProvisioningClaimRequest.builder()
- Parameters:
createProvisioningClaimRequest
- AConsumer
that will call methods onCreateProvisioningClaimRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProvisioningClaim operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createProvisioningTemplate
default CompletableFuture<CreateProvisioningTemplateResponse> createProvisioningTemplate(CreateProvisioningTemplateRequest createProvisioningTemplateRequest) Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
- Parameters:
createProvisioningTemplateRequest
-- Returns:
- A Java Future containing the result of the CreateProvisioningTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createProvisioningTemplate
default CompletableFuture<CreateProvisioningTemplateResponse> createProvisioningTemplate(Consumer<CreateProvisioningTemplateRequest.Builder> createProvisioningTemplateRequest) Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
This is a convenience which creates an instance of the
CreateProvisioningTemplateRequest.Builder
avoiding the need to create one manually viaCreateProvisioningTemplateRequest.builder()
- Parameters:
createProvisioningTemplateRequest
- AConsumer
that will call methods onCreateProvisioningTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProvisioningTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createProvisioningTemplateVersion
default CompletableFuture<CreateProvisioningTemplateVersionResponse> createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest) Creates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
- Parameters:
createProvisioningTemplateVersionRequest
-- Returns:
- A Java Future containing the result of the CreateProvisioningTemplateVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createProvisioningTemplateVersion
default CompletableFuture<CreateProvisioningTemplateVersionResponse> createProvisioningTemplateVersion(Consumer<CreateProvisioningTemplateVersionRequest.Builder> createProvisioningTemplateVersionRequest) Creates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
This is a convenience which creates an instance of the
CreateProvisioningTemplateVersionRequest.Builder
avoiding the need to create one manually viaCreateProvisioningTemplateVersionRequest.builder()
- Parameters:
createProvisioningTemplateVersionRequest
- AConsumer
that will call methods onCreateProvisioningTemplateVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProvisioningTemplateVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createRoleAlias
default CompletableFuture<CreateRoleAliasResponse> createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest) Creates a role alias.
Requires permission to access the CreateRoleAlias action.
The value of
credentialDurationSeconds
must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.- Parameters:
createRoleAliasRequest
-- Returns:
- A Java Future containing the result of the CreateRoleAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createRoleAlias
default CompletableFuture<CreateRoleAliasResponse> createRoleAlias(Consumer<CreateRoleAliasRequest.Builder> createRoleAliasRequest) Creates a role alias.
Requires permission to access the CreateRoleAlias action.
The value of
credentialDurationSeconds
must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.
This is a convenience which creates an instance of the
CreateRoleAliasRequest.Builder
avoiding the need to create one manually viaCreateRoleAliasRequest.builder()
- Parameters:
createRoleAliasRequest
- AConsumer
that will call methods onCreateRoleAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRoleAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createScheduledAudit
default CompletableFuture<CreateScheduledAuditResponse> createScheduledAudit(CreateScheduledAuditRequest createScheduledAuditRequest) Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
- Parameters:
createScheduledAuditRequest
-- Returns:
- A Java Future containing the result of the CreateScheduledAudit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createScheduledAudit
default CompletableFuture<CreateScheduledAuditResponse> createScheduledAudit(Consumer<CreateScheduledAuditRequest.Builder> createScheduledAuditRequest) Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
This is a convenience which creates an instance of the
CreateScheduledAuditRequest.Builder
avoiding the need to create one manually viaCreateScheduledAuditRequest.builder()
- Parameters:
createScheduledAuditRequest
- AConsumer
that will call methods onCreateScheduledAuditRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateScheduledAudit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createSecurityProfile
default CompletableFuture<CreateSecurityProfileResponse> createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest) Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
- Parameters:
createSecurityProfileRequest
-- Returns:
- A Java Future containing the result of the CreateSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ResourceAlreadyExistsException The resource already exists.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createSecurityProfile
default CompletableFuture<CreateSecurityProfileResponse> createSecurityProfile(Consumer<CreateSecurityProfileRequest.Builder> createSecurityProfileRequest) Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
This is a convenience which creates an instance of the
CreateSecurityProfileRequest.Builder
avoiding the need to create one manually viaCreateSecurityProfileRequest.builder()
- Parameters:
createSecurityProfileRequest
- AConsumer
that will call methods onCreateSecurityProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ResourceAlreadyExistsException The resource already exists.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createStream
default CompletableFuture<CreateStreamResponse> 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.
- Parameters:
createStreamRequest
-- Returns:
- A Java Future containing the result of the CreateStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createStream
default CompletableFuture<CreateStreamResponse> createStream(Consumer<CreateStreamRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateStreamRequest.Builder
avoiding the need to create one manually viaCreateStreamRequest.builder()
- Parameters:
createStreamRequest
- AConsumer
that will call methods onCreateStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createThing
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.
- Parameters:
createThingRequest
- The input for the CreateThing operation.- Returns:
- A Java Future containing the result of the CreateThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createThing
default CompletableFuture<CreateThingResponse> createThing(Consumer<CreateThingRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateThingRequest.Builder
avoiding the need to create one manually viaCreateThingRequest.builder()
- Parameters:
createThingRequest
- AConsumer
that will call methods onCreateThingRequest.Builder
to create a request. The input for the CreateThing operation.- Returns:
- A Java Future containing the result of the CreateThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createThingGroup
default CompletableFuture<CreateThingGroupResponse> 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 existingThingGroup
, you will get a 200 success response.Requires permission to access the CreateThingGroup action.
- Parameters:
createThingGroupRequest
-- Returns:
- A Java Future containing the result of the CreateThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ResourceAlreadyExistsException The resource already exists.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createThingGroup
default CompletableFuture<CreateThingGroupResponse> createThingGroup(Consumer<CreateThingGroupRequest.Builder> 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 existingThingGroup
, you will get a 200 success response.Requires permission to access the CreateThingGroup action.
This is a convenience which creates an instance of the
CreateThingGroupRequest.Builder
avoiding the need to create one manually viaCreateThingGroupRequest.builder()
- Parameters:
createThingGroupRequest
- AConsumer
that will call methods onCreateThingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ResourceAlreadyExistsException The resource already exists.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createThingType
default CompletableFuture<CreateThingTypeResponse> createThingType(CreateThingTypeRequest createThingTypeRequest) Creates a new thing type. If this call is made multiple times using the same thing type name and configuration, the call will succeed. If this call is made with the same thing type name but different configuration a
ResourceAlreadyExistsException
is thrown.Requires permission to access the CreateThingType action.
- Parameters:
createThingTypeRequest
- The input for the CreateThingType operation.- Returns:
- A Java Future containing the result of the CreateThingType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createThingType
default CompletableFuture<CreateThingTypeResponse> createThingType(Consumer<CreateThingTypeRequest.Builder> createThingTypeRequest) Creates a new thing type. If this call is made multiple times using the same thing type name and configuration, the call will succeed. If this call is made with the same thing type name but different configuration a
ResourceAlreadyExistsException
is thrown.Requires permission to access the CreateThingType action.
This is a convenience which creates an instance of the
CreateThingTypeRequest.Builder
avoiding the need to create one manually viaCreateThingTypeRequest.builder()
- Parameters:
createThingTypeRequest
- AConsumer
that will call methods onCreateThingTypeRequest.Builder
to create a request. The input for the CreateThingType operation.- Returns:
- A Java Future containing the result of the CreateThingType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createTopicRule
default CompletableFuture<CreateTopicRuleResponse> 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.
- Parameters:
createTopicRuleRequest
- The input for the CreateTopicRule operation.- Returns:
- A Java Future containing the result of the CreateTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createTopicRule
default CompletableFuture<CreateTopicRuleResponse> createTopicRule(Consumer<CreateTopicRuleRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateTopicRuleRequest.Builder
avoiding the need to create one manually viaCreateTopicRuleRequest.builder()
- Parameters:
createTopicRuleRequest
- AConsumer
that will call methods onCreateTopicRuleRequest.Builder
to create a request. The input for the CreateTopicRule operation.- Returns:
- A Java Future containing the result of the CreateTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createTopicRuleDestination
default CompletableFuture<CreateTopicRuleDestinationResponse> createTopicRuleDestination(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest) Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
- Parameters:
createTopicRuleDestinationRequest
-- Returns:
- A Java Future containing the result of the CreateTopicRuleDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createTopicRuleDestination
default CompletableFuture<CreateTopicRuleDestinationResponse> createTopicRuleDestination(Consumer<CreateTopicRuleDestinationRequest.Builder> createTopicRuleDestinationRequest) Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
This is a convenience which creates an instance of the
CreateTopicRuleDestinationRequest.Builder
avoiding the need to create one manually viaCreateTopicRuleDestinationRequest.builder()
- Parameters:
createTopicRuleDestinationRequest
- AConsumer
that will call methods onCreateTopicRuleDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateTopicRuleDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteAccountAuditConfiguration
default CompletableFuture<DeleteAccountAuditConfigurationResponse> 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.
- Parameters:
deleteAccountAuditConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteAccountAuditConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteAccountAuditConfiguration
default CompletableFuture<DeleteAccountAuditConfigurationResponse> deleteAccountAuditConfiguration(Consumer<DeleteAccountAuditConfigurationRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteAccountAuditConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteAccountAuditConfigurationRequest.builder()
- Parameters:
deleteAccountAuditConfigurationRequest
- AConsumer
that will call methods onDeleteAccountAuditConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccountAuditConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteAccountAuditConfiguration
default CompletableFuture<DeleteAccountAuditConfigurationResponse> deleteAccountAuditConfiguration()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.
- Returns:
- A Java Future containing the result of the DeleteAccountAuditConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteAuditSuppression
default CompletableFuture<DeleteAuditSuppressionResponse> deleteAuditSuppression(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest) Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
- Parameters:
deleteAuditSuppressionRequest
-- Returns:
- A Java Future containing the result of the DeleteAuditSuppression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteAuditSuppression
default CompletableFuture<DeleteAuditSuppressionResponse> deleteAuditSuppression(Consumer<DeleteAuditSuppressionRequest.Builder> deleteAuditSuppressionRequest) Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
This is a convenience which creates an instance of the
DeleteAuditSuppressionRequest.Builder
avoiding the need to create one manually viaDeleteAuditSuppressionRequest.builder()
- Parameters:
deleteAuditSuppressionRequest
- AConsumer
that will call methods onDeleteAuditSuppressionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAuditSuppression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteAuthorizer
default CompletableFuture<DeleteAuthorizerResponse> deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest) Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
- Parameters:
deleteAuthorizerRequest
-- Returns:
- A Java Future containing the result of the DeleteAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteAuthorizer
default CompletableFuture<DeleteAuthorizerResponse> deleteAuthorizer(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest) Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
This is a convenience which creates an instance of the
DeleteAuthorizerRequest.Builder
avoiding the need to create one manually viaDeleteAuthorizerRequest.builder()
- Parameters:
deleteAuthorizerRequest
- AConsumer
that will call methods onDeleteAuthorizerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteBillingGroup
default CompletableFuture<DeleteBillingGroupResponse> deleteBillingGroup(DeleteBillingGroupRequest deleteBillingGroupRequest) Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
- Parameters:
deleteBillingGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteBillingGroup
default CompletableFuture<DeleteBillingGroupResponse> deleteBillingGroup(Consumer<DeleteBillingGroupRequest.Builder> deleteBillingGroupRequest) Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
This is a convenience which creates an instance of the
DeleteBillingGroupRequest.Builder
avoiding the need to create one manually viaDeleteBillingGroupRequest.builder()
- Parameters:
deleteBillingGroupRequest
- AConsumer
that will call methods onDeleteBillingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteCACertificate
default CompletableFuture<DeleteCaCertificateResponse> deleteCACertificate(DeleteCaCertificateRequest deleteCaCertificateRequest) Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
- Parameters:
deleteCaCertificateRequest
- Input for the DeleteCACertificate operation.- Returns:
- A Java Future containing the result of the DeleteCACertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteCACertificate
default CompletableFuture<DeleteCaCertificateResponse> deleteCACertificate(Consumer<DeleteCaCertificateRequest.Builder> deleteCaCertificateRequest) Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
This is a convenience which creates an instance of the
DeleteCaCertificateRequest.Builder
avoiding the need to create one manually viaDeleteCaCertificateRequest.builder()
- Parameters:
deleteCaCertificateRequest
- AConsumer
that will call methods onDeleteCaCertificateRequest.Builder
to create a request. Input for the DeleteCACertificate operation.- Returns:
- A Java Future containing the result of the DeleteCACertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteCertificate
default CompletableFuture<DeleteCertificateResponse> 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.
- Parameters:
deleteCertificateRequest
- The input for the DeleteCertificate operation.- Returns:
- A Java Future containing the result of the DeleteCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteCertificate
default CompletableFuture<DeleteCertificateResponse> deleteCertificate(Consumer<DeleteCertificateRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteCertificateRequest.Builder
avoiding the need to create one manually viaDeleteCertificateRequest.builder()
- Parameters:
deleteCertificateRequest
- AConsumer
that will call methods onDeleteCertificateRequest.Builder
to create a request. The input for the DeleteCertificate operation.- Returns:
- A Java Future containing the result of the DeleteCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteCertificateProvider
default CompletableFuture<DeleteCertificateProviderResponse> 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).- Parameters:
deleteCertificateProviderRequest
-- Returns:
- A Java Future containing the result of the DeleteCertificateProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteCertificateProvider
default CompletableFuture<DeleteCertificateProviderResponse> deleteCertificateProvider(Consumer<DeleteCertificateProviderRequest.Builder> 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).
This is a convenience which creates an instance of the
DeleteCertificateProviderRequest.Builder
avoiding the need to create one manually viaDeleteCertificateProviderRequest.builder()
- Parameters:
deleteCertificateProviderRequest
- AConsumer
that will call methods onDeleteCertificateProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCertificateProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteCustomMetric
default CompletableFuture<DeleteCustomMetricResponse> 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.- Parameters:
deleteCustomMetricRequest
-- Returns:
- A Java Future containing the result of the DeleteCustomMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteCustomMetric
default CompletableFuture<DeleteCustomMetricResponse> deleteCustomMetric(Consumer<DeleteCustomMetricRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteCustomMetricRequest.Builder
avoiding the need to create one manually viaDeleteCustomMetricRequest.builder()
- Parameters:
deleteCustomMetricRequest
- AConsumer
that will call methods onDeleteCustomMetricRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCustomMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteDimension
default CompletableFuture<DeleteDimensionResponse> deleteDimension(DeleteDimensionRequest deleteDimensionRequest) Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
- Parameters:
deleteDimensionRequest
-- Returns:
- A Java Future containing the result of the DeleteDimension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalFailureException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteDimension
default CompletableFuture<DeleteDimensionResponse> deleteDimension(Consumer<DeleteDimensionRequest.Builder> deleteDimensionRequest) Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
This is a convenience which creates an instance of the
DeleteDimensionRequest.Builder
avoiding the need to create one manually viaDeleteDimensionRequest.builder()
- Parameters:
deleteDimensionRequest
- AConsumer
that will call methods onDeleteDimensionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDimension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalFailureException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteDomainConfiguration
default CompletableFuture<DeleteDomainConfigurationResponse> deleteDomainConfiguration(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest) Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
- Parameters:
deleteDomainConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteDomainConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteDomainConfiguration
default CompletableFuture<DeleteDomainConfigurationResponse> deleteDomainConfiguration(Consumer<DeleteDomainConfigurationRequest.Builder> deleteDomainConfigurationRequest) Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
This is a convenience which creates an instance of the
DeleteDomainConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteDomainConfigurationRequest.builder()
- Parameters:
deleteDomainConfigurationRequest
- AConsumer
that will call methods onDeleteDomainConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDomainConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteDynamicThingGroup
default CompletableFuture<DeleteDynamicThingGroupResponse> deleteDynamicThingGroup(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest) Deletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
- Parameters:
deleteDynamicThingGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteDynamicThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteDynamicThingGroup
default CompletableFuture<DeleteDynamicThingGroupResponse> deleteDynamicThingGroup(Consumer<DeleteDynamicThingGroupRequest.Builder> deleteDynamicThingGroupRequest) Deletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
This is a convenience which creates an instance of the
DeleteDynamicThingGroupRequest.Builder
avoiding the need to create one manually viaDeleteDynamicThingGroupRequest.builder()
- Parameters:
deleteDynamicThingGroupRequest
- AConsumer
that will call methods onDeleteDynamicThingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDynamicThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteFleetMetric
default CompletableFuture<DeleteFleetMetricResponse> 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.
- Parameters:
deleteFleetMetricRequest
-- Returns:
- A Java Future containing the result of the DeleteFleetMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteFleetMetric
default CompletableFuture<DeleteFleetMetricResponse> deleteFleetMetric(Consumer<DeleteFleetMetricRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteFleetMetricRequest.Builder
avoiding the need to create one manually viaDeleteFleetMetricRequest.builder()
- Parameters:
deleteFleetMetricRequest
- AConsumer
that will call methods onDeleteFleetMetricRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteFleetMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteJob
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.
- Parameters:
deleteJobRequest
-- Returns:
- A Java Future containing the result of the DeleteJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteJob
default CompletableFuture<DeleteJobResponse> deleteJob(Consumer<DeleteJobRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteJobRequest.Builder
avoiding the need to create one manually viaDeleteJobRequest.builder()
- Parameters:
deleteJobRequest
- AConsumer
that will call methods onDeleteJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteJobExecution
default CompletableFuture<DeleteJobExecutionResponse> deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest) Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
- Parameters:
deleteJobExecutionRequest
-- Returns:
- A Java Future containing the result of the DeleteJobExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteJobExecution
default CompletableFuture<DeleteJobExecutionResponse> deleteJobExecution(Consumer<DeleteJobExecutionRequest.Builder> deleteJobExecutionRequest) Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
This is a convenience which creates an instance of the
DeleteJobExecutionRequest.Builder
avoiding the need to create one manually viaDeleteJobExecutionRequest.builder()
- Parameters:
deleteJobExecutionRequest
- AConsumer
that will call methods onDeleteJobExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteJobExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteJobTemplate
default CompletableFuture<DeleteJobTemplateResponse> deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest) Deletes the specified job template.
- Parameters:
deleteJobTemplateRequest
-- Returns:
- A Java Future containing the result of the DeleteJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteJobTemplate
default CompletableFuture<DeleteJobTemplateResponse> deleteJobTemplate(Consumer<DeleteJobTemplateRequest.Builder> deleteJobTemplateRequest) Deletes the specified job template.
This is a convenience which creates an instance of the
DeleteJobTemplateRequest.Builder
avoiding the need to create one manually viaDeleteJobTemplateRequest.builder()
- Parameters:
deleteJobTemplateRequest
- AConsumer
that will call methods onDeleteJobTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteMitigationAction
default CompletableFuture<DeleteMitigationActionResponse> deleteMitigationAction(DeleteMitigationActionRequest deleteMitigationActionRequest) Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
- Parameters:
deleteMitigationActionRequest
-- Returns:
- A Java Future containing the result of the DeleteMitigationAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteMitigationAction
default CompletableFuture<DeleteMitigationActionResponse> deleteMitigationAction(Consumer<DeleteMitigationActionRequest.Builder> deleteMitigationActionRequest) Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
This is a convenience which creates an instance of the
DeleteMitigationActionRequest.Builder
avoiding the need to create one manually viaDeleteMitigationActionRequest.builder()
- Parameters:
deleteMitigationActionRequest
- AConsumer
that will call methods onDeleteMitigationActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMitigationAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteOTAUpdate
default CompletableFuture<DeleteOtaUpdateResponse> deleteOTAUpdate(DeleteOtaUpdateRequest deleteOtaUpdateRequest) Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
- Parameters:
deleteOtaUpdateRequest
-- Returns:
- A Java Future containing the result of the DeleteOTAUpdate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteOTAUpdate
default CompletableFuture<DeleteOtaUpdateResponse> deleteOTAUpdate(Consumer<DeleteOtaUpdateRequest.Builder> deleteOtaUpdateRequest) Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
This is a convenience which creates an instance of the
DeleteOtaUpdateRequest.Builder
avoiding the need to create one manually viaDeleteOtaUpdateRequest.builder()
- Parameters:
deleteOtaUpdateRequest
- AConsumer
that will call methods onDeleteOtaUpdateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOTAUpdate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deletePackage
default CompletableFuture<DeletePackageResponse> 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.
- Parameters:
deletePackageRequest
-- Returns:
- A Java Future containing the result of the DeletePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deletePackage
default CompletableFuture<DeletePackageResponse> deletePackage(Consumer<DeletePackageRequest.Builder> 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.
This is a convenience which creates an instance of the
DeletePackageRequest.Builder
avoiding the need to create one manually viaDeletePackageRequest.builder()
- Parameters:
deletePackageRequest
- AConsumer
that will call methods onDeletePackageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deletePackageVersion
default CompletableFuture<DeletePackageVersionResponse> 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.
- Parameters:
deletePackageVersionRequest
-- Returns:
- A Java Future containing the result of the DeletePackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deletePackageVersion
default CompletableFuture<DeletePackageVersionResponse> deletePackageVersion(Consumer<DeletePackageVersionRequest.Builder> 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.
This is a convenience which creates an instance of the
DeletePackageVersionRequest.Builder
avoiding the need to create one manually viaDeletePackageVersionRequest.builder()
- Parameters:
deletePackageVersionRequest
- AConsumer
that will call methods onDeletePackageVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deletePolicy
default CompletableFuture<DeletePolicyResponse> 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.
- Parameters:
deletePolicyRequest
- The input for the DeletePolicy operation.- Returns:
- A Java Future containing the result of the DeletePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deletePolicy
default CompletableFuture<DeletePolicyResponse> deletePolicy(Consumer<DeletePolicyRequest.Builder> 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.
This is a convenience which creates an instance of the
DeletePolicyRequest.Builder
avoiding the need to create one manually viaDeletePolicyRequest.builder()
- Parameters:
deletePolicyRequest
- AConsumer
that will call methods onDeletePolicyRequest.Builder
to create a request. The input for the DeletePolicy operation.- Returns:
- A Java Future containing the result of the DeletePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deletePolicyVersion
default CompletableFuture<DeletePolicyVersionResponse> 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.
- Parameters:
deletePolicyVersionRequest
- The input for the DeletePolicyVersion operation.- Returns:
- A Java Future containing the result of the DeletePolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deletePolicyVersion
default CompletableFuture<DeletePolicyVersionResponse> deletePolicyVersion(Consumer<DeletePolicyVersionRequest.Builder> 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.
This is a convenience which creates an instance of the
DeletePolicyVersionRequest.Builder
avoiding the need to create one manually viaDeletePolicyVersionRequest.builder()
- Parameters:
deletePolicyVersionRequest
- AConsumer
that will call methods onDeletePolicyVersionRequest.Builder
to create a request. The input for the DeletePolicyVersion operation.- Returns:
- A Java Future containing the result of the DeletePolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteProvisioningTemplate
default CompletableFuture<DeleteProvisioningTemplateResponse> deleteProvisioningTemplate(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest) Deletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
- Parameters:
deleteProvisioningTemplateRequest
-- Returns:
- A Java Future containing the result of the DeleteProvisioningTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteProvisioningTemplate
default CompletableFuture<DeleteProvisioningTemplateResponse> deleteProvisioningTemplate(Consumer<DeleteProvisioningTemplateRequest.Builder> deleteProvisioningTemplateRequest) Deletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
This is a convenience which creates an instance of the
DeleteProvisioningTemplateRequest.Builder
avoiding the need to create one manually viaDeleteProvisioningTemplateRequest.builder()
- Parameters:
deleteProvisioningTemplateRequest
- AConsumer
that will call methods onDeleteProvisioningTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProvisioningTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteProvisioningTemplateVersion
default CompletableFuture<DeleteProvisioningTemplateVersionResponse> deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest) Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
- Parameters:
deleteProvisioningTemplateVersionRequest
-- Returns:
- A Java Future containing the result of the DeleteProvisioningTemplateVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteProvisioningTemplateVersion
default CompletableFuture<DeleteProvisioningTemplateVersionResponse> deleteProvisioningTemplateVersion(Consumer<DeleteProvisioningTemplateVersionRequest.Builder> deleteProvisioningTemplateVersionRequest) Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
This is a convenience which creates an instance of the
DeleteProvisioningTemplateVersionRequest.Builder
avoiding the need to create one manually viaDeleteProvisioningTemplateVersionRequest.builder()
- Parameters:
deleteProvisioningTemplateVersionRequest
- AConsumer
that will call methods onDeleteProvisioningTemplateVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProvisioningTemplateVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteRegistrationCode
default CompletableFuture<DeleteRegistrationCodeResponse> deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
- Parameters:
deleteRegistrationCodeRequest
- The input for the DeleteRegistrationCode operation.- Returns:
- A Java Future containing the result of the DeleteRegistrationCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteRegistrationCode
default CompletableFuture<DeleteRegistrationCodeResponse> deleteRegistrationCode(Consumer<DeleteRegistrationCodeRequest.Builder> deleteRegistrationCodeRequest) Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
This is a convenience which creates an instance of the
DeleteRegistrationCodeRequest.Builder
avoiding the need to create one manually viaDeleteRegistrationCodeRequest.builder()
- Parameters:
deleteRegistrationCodeRequest
- AConsumer
that will call methods onDeleteRegistrationCodeRequest.Builder
to create a request. The input for the DeleteRegistrationCode operation.- Returns:
- A Java Future containing the result of the DeleteRegistrationCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteRegistrationCode
Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
- Returns:
- A Java Future containing the result of the DeleteRegistrationCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteRoleAlias
default CompletableFuture<DeleteRoleAliasResponse> deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest) Deletes a role alias
Requires permission to access the DeleteRoleAlias action.
- Parameters:
deleteRoleAliasRequest
-- Returns:
- A Java Future containing the result of the DeleteRoleAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteRoleAlias
default CompletableFuture<DeleteRoleAliasResponse> deleteRoleAlias(Consumer<DeleteRoleAliasRequest.Builder> deleteRoleAliasRequest) Deletes a role alias
Requires permission to access the DeleteRoleAlias action.
This is a convenience which creates an instance of the
DeleteRoleAliasRequest.Builder
avoiding the need to create one manually viaDeleteRoleAliasRequest.builder()
- Parameters:
deleteRoleAliasRequest
- AConsumer
that will call methods onDeleteRoleAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRoleAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteScheduledAudit
default CompletableFuture<DeleteScheduledAuditResponse> deleteScheduledAudit(DeleteScheduledAuditRequest deleteScheduledAuditRequest) Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
- Parameters:
deleteScheduledAuditRequest
-- Returns:
- A Java Future containing the result of the DeleteScheduledAudit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteScheduledAudit
default CompletableFuture<DeleteScheduledAuditResponse> deleteScheduledAudit(Consumer<DeleteScheduledAuditRequest.Builder> deleteScheduledAuditRequest) Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
This is a convenience which creates an instance of the
DeleteScheduledAuditRequest.Builder
avoiding the need to create one manually viaDeleteScheduledAuditRequest.builder()
- Parameters:
deleteScheduledAuditRequest
- AConsumer
that will call methods onDeleteScheduledAuditRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteScheduledAudit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteSecurityProfile
default CompletableFuture<DeleteSecurityProfileResponse> deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest) Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
- Parameters:
deleteSecurityProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteSecurityProfile
default CompletableFuture<DeleteSecurityProfileResponse> deleteSecurityProfile(Consumer<DeleteSecurityProfileRequest.Builder> deleteSecurityProfileRequest) Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
This is a convenience which creates an instance of the
DeleteSecurityProfileRequest.Builder
avoiding the need to create one manually viaDeleteSecurityProfileRequest.builder()
- Parameters:
deleteSecurityProfileRequest
- AConsumer
that will call methods onDeleteSecurityProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteStream
default CompletableFuture<DeleteStreamResponse> deleteStream(DeleteStreamRequest deleteStreamRequest) Deletes a stream.
Requires permission to access the DeleteStream action.
- Parameters:
deleteStreamRequest
-- Returns:
- A Java Future containing the result of the DeleteStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteStream
default CompletableFuture<DeleteStreamResponse> deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest) Deletes a stream.
Requires permission to access the DeleteStream action.
This is a convenience which creates an instance of the
DeleteStreamRequest.Builder
avoiding the need to create one manually viaDeleteStreamRequest.builder()
- Parameters:
deleteStreamRequest
- AConsumer
that will call methods onDeleteStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteThing
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.
- Parameters:
deleteThingRequest
- The input for the DeleteThing operation.- Returns:
- A Java Future containing the result of the DeleteThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteThing
default CompletableFuture<DeleteThingResponse> deleteThing(Consumer<DeleteThingRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteThingRequest.Builder
avoiding the need to create one manually viaDeleteThingRequest.builder()
- Parameters:
deleteThingRequest
- AConsumer
that will call methods onDeleteThingRequest.Builder
to create a request. The input for the DeleteThing operation.- Returns:
- A Java Future containing the result of the DeleteThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteThingGroup
default CompletableFuture<DeleteThingGroupResponse> deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest) Deletes a thing group.
Requires permission to access the DeleteThingGroup action.
- Parameters:
deleteThingGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteThingGroup
default CompletableFuture<DeleteThingGroupResponse> deleteThingGroup(Consumer<DeleteThingGroupRequest.Builder> deleteThingGroupRequest) Deletes a thing group.
Requires permission to access the DeleteThingGroup action.
This is a convenience which creates an instance of the
DeleteThingGroupRequest.Builder
avoiding the need to create one manually viaDeleteThingGroupRequest.builder()
- Parameters:
deleteThingGroupRequest
- AConsumer
that will call methods onDeleteThingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteThingType
default CompletableFuture<DeleteThingTypeResponse> 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.
- Parameters:
deleteThingTypeRequest
- The input for the DeleteThingType operation.- Returns:
- A Java Future containing the result of the DeleteThingType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteThingType
default CompletableFuture<DeleteThingTypeResponse> deleteThingType(Consumer<DeleteThingTypeRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteThingTypeRequest.Builder
avoiding the need to create one manually viaDeleteThingTypeRequest.builder()
- Parameters:
deleteThingTypeRequest
- AConsumer
that will call methods onDeleteThingTypeRequest.Builder
to create a request. The input for the DeleteThingType operation.- Returns:
- A Java Future containing the result of the DeleteThingType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteTopicRule
default CompletableFuture<DeleteTopicRuleResponse> deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) Deletes the rule.
Requires permission to access the DeleteTopicRule action.
- Parameters:
deleteTopicRuleRequest
- The input for the DeleteTopicRule operation.- Returns:
- A Java Future containing the result of the DeleteTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteTopicRule
default CompletableFuture<DeleteTopicRuleResponse> deleteTopicRule(Consumer<DeleteTopicRuleRequest.Builder> deleteTopicRuleRequest) Deletes the rule.
Requires permission to access the DeleteTopicRule action.
This is a convenience which creates an instance of the
DeleteTopicRuleRequest.Builder
avoiding the need to create one manually viaDeleteTopicRuleRequest.builder()
- Parameters:
deleteTopicRuleRequest
- AConsumer
that will call methods onDeleteTopicRuleRequest.Builder
to create a request. The input for the DeleteTopicRule operation.- Returns:
- A Java Future containing the result of the DeleteTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteTopicRuleDestination
default CompletableFuture<DeleteTopicRuleDestinationResponse> deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest) Deletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
- Parameters:
deleteTopicRuleDestinationRequest
-- Returns:
- A Java Future containing the result of the DeleteTopicRuleDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteTopicRuleDestination
default CompletableFuture<DeleteTopicRuleDestinationResponse> deleteTopicRuleDestination(Consumer<DeleteTopicRuleDestinationRequest.Builder> deleteTopicRuleDestinationRequest) Deletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
This is a convenience which creates an instance of the
DeleteTopicRuleDestinationRequest.Builder
avoiding the need to create one manually viaDeleteTopicRuleDestinationRequest.builder()
- Parameters:
deleteTopicRuleDestinationRequest
- AConsumer
that will call methods onDeleteTopicRuleDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTopicRuleDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteV2LoggingLevel
default CompletableFuture<DeleteV2LoggingLevelResponse> deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest) Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
- Parameters:
deleteV2LoggingLevelRequest
-- Returns:
- A Java Future containing the result of the DeleteV2LoggingLevel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteV2LoggingLevel
default CompletableFuture<DeleteV2LoggingLevelResponse> deleteV2LoggingLevel(Consumer<DeleteV2LoggingLevelRequest.Builder> deleteV2LoggingLevelRequest) Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
This is a convenience which creates an instance of the
DeleteV2LoggingLevelRequest.Builder
avoiding the need to create one manually viaDeleteV2LoggingLevelRequest.builder()
- Parameters:
deleteV2LoggingLevelRequest
- AConsumer
that will call methods onDeleteV2LoggingLevelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteV2LoggingLevel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deprecateThingType
default CompletableFuture<DeprecateThingTypeResponse> deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest) Deprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
- Parameters:
deprecateThingTypeRequest
- The input for the DeprecateThingType operation.- Returns:
- A Java Future containing the result of the DeprecateThingType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deprecateThingType
default CompletableFuture<DeprecateThingTypeResponse> deprecateThingType(Consumer<DeprecateThingTypeRequest.Builder> deprecateThingTypeRequest) Deprecates a thing type. You can not associate new things with deprecated thing type.
Requires permission to access the DeprecateThingType action.
This is a convenience which creates an instance of the
DeprecateThingTypeRequest.Builder
avoiding the need to create one manually viaDeprecateThingTypeRequest.builder()
- Parameters:
deprecateThingTypeRequest
- AConsumer
that will call methods onDeprecateThingTypeRequest.Builder
to create a request. The input for the DeprecateThingType operation.- Returns:
- A Java Future containing the result of the DeprecateThingType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAccountAuditConfiguration
default CompletableFuture<DescribeAccountAuditConfigurationResponse> 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.
- Parameters:
describeAccountAuditConfigurationRequest
-- Returns:
- A Java Future containing the result of the DescribeAccountAuditConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAccountAuditConfiguration
default CompletableFuture<DescribeAccountAuditConfigurationResponse> describeAccountAuditConfiguration(Consumer<DescribeAccountAuditConfigurationRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeAccountAuditConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeAccountAuditConfigurationRequest.builder()
- Parameters:
describeAccountAuditConfigurationRequest
- AConsumer
that will call methods onDescribeAccountAuditConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAccountAuditConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAccountAuditConfiguration
default CompletableFuture<DescribeAccountAuditConfigurationResponse> describeAccountAuditConfiguration()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.
- Returns:
- A Java Future containing the result of the DescribeAccountAuditConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAuditFinding
default CompletableFuture<DescribeAuditFindingResponse> 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.
- Parameters:
describeAuditFindingRequest
-- Returns:
- A Java Future containing the result of the DescribeAuditFinding operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAuditFinding
default CompletableFuture<DescribeAuditFindingResponse> describeAuditFinding(Consumer<DescribeAuditFindingRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeAuditFindingRequest.Builder
avoiding the need to create one manually viaDescribeAuditFindingRequest.builder()
- Parameters:
describeAuditFindingRequest
- AConsumer
that will call methods onDescribeAuditFindingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAuditFinding operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAuditMitigationActionsTask
default CompletableFuture<DescribeAuditMitigationActionsTaskResponse> 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.
- Parameters:
describeAuditMitigationActionsTaskRequest
-- Returns:
- A Java Future containing the result of the DescribeAuditMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAuditMitigationActionsTask
default CompletableFuture<DescribeAuditMitigationActionsTaskResponse> describeAuditMitigationActionsTask(Consumer<DescribeAuditMitigationActionsTaskRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeAuditMitigationActionsTaskRequest.Builder
avoiding the need to create one manually viaDescribeAuditMitigationActionsTaskRequest.builder()
- Parameters:
describeAuditMitigationActionsTaskRequest
- AConsumer
that will call methods onDescribeAuditMitigationActionsTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAuditMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAuditSuppression
default CompletableFuture<DescribeAuditSuppressionResponse> describeAuditSuppression(DescribeAuditSuppressionRequest describeAuditSuppressionRequest) Gets information about a Device Defender audit suppression.
- Parameters:
describeAuditSuppressionRequest
-- Returns:
- A Java Future containing the result of the DescribeAuditSuppression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAuditSuppression
default CompletableFuture<DescribeAuditSuppressionResponse> describeAuditSuppression(Consumer<DescribeAuditSuppressionRequest.Builder> describeAuditSuppressionRequest) Gets information about a Device Defender audit suppression.
This is a convenience which creates an instance of the
DescribeAuditSuppressionRequest.Builder
avoiding the need to create one manually viaDescribeAuditSuppressionRequest.builder()
- Parameters:
describeAuditSuppressionRequest
- AConsumer
that will call methods onDescribeAuditSuppressionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAuditSuppression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAuditTask
default CompletableFuture<DescribeAuditTaskResponse> describeAuditTask(DescribeAuditTaskRequest describeAuditTaskRequest) Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
- Parameters:
describeAuditTaskRequest
-- Returns:
- A Java Future containing the result of the DescribeAuditTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAuditTask
default CompletableFuture<DescribeAuditTaskResponse> describeAuditTask(Consumer<DescribeAuditTaskRequest.Builder> describeAuditTaskRequest) Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
This is a convenience which creates an instance of the
DescribeAuditTaskRequest.Builder
avoiding the need to create one manually viaDescribeAuditTaskRequest.builder()
- Parameters:
describeAuditTaskRequest
- AConsumer
that will call methods onDescribeAuditTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAuditTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAuthorizer
default CompletableFuture<DescribeAuthorizerResponse> describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest) Describes an authorizer.
Requires permission to access the DescribeAuthorizer action.
- Parameters:
describeAuthorizerRequest
-- Returns:
- A Java Future containing the result of the DescribeAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeAuthorizer
default CompletableFuture<DescribeAuthorizerResponse> describeAuthorizer(Consumer<DescribeAuthorizerRequest.Builder> describeAuthorizerRequest) Describes an authorizer.
Requires permission to access the DescribeAuthorizer action.
This is a convenience which creates an instance of the
DescribeAuthorizerRequest.Builder
avoiding the need to create one manually viaDescribeAuthorizerRequest.builder()
- Parameters:
describeAuthorizerRequest
- AConsumer
that will call methods onDescribeAuthorizerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBillingGroup
default CompletableFuture<DescribeBillingGroupResponse> describeBillingGroup(DescribeBillingGroupRequest describeBillingGroupRequest) Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
- Parameters:
describeBillingGroupRequest
-- Returns:
- A Java Future containing the result of the DescribeBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeBillingGroup
default CompletableFuture<DescribeBillingGroupResponse> describeBillingGroup(Consumer<DescribeBillingGroupRequest.Builder> describeBillingGroupRequest) Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
This is a convenience which creates an instance of the
DescribeBillingGroupRequest.Builder
avoiding the need to create one manually viaDescribeBillingGroupRequest.builder()
- Parameters:
describeBillingGroupRequest
- AConsumer
that will call methods onDescribeBillingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeCACertificate
default CompletableFuture<DescribeCaCertificateResponse> describeCACertificate(DescribeCaCertificateRequest describeCaCertificateRequest) Describes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
- Parameters:
describeCaCertificateRequest
- The input for the DescribeCACertificate operation.- Returns:
- A Java Future containing the result of the DescribeCACertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeCACertificate
default CompletableFuture<DescribeCaCertificateResponse> describeCACertificate(Consumer<DescribeCaCertificateRequest.Builder> describeCaCertificateRequest) Describes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
This is a convenience which creates an instance of the
DescribeCaCertificateRequest.Builder
avoiding the need to create one manually viaDescribeCaCertificateRequest.builder()
- Parameters:
describeCaCertificateRequest
- AConsumer
that will call methods onDescribeCaCertificateRequest.Builder
to create a request. The input for the DescribeCACertificate operation.- Returns:
- A Java Future containing the result of the DescribeCACertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeCertificate
default CompletableFuture<DescribeCertificateResponse> describeCertificate(DescribeCertificateRequest describeCertificateRequest) Gets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
- Parameters:
describeCertificateRequest
- The input for the DescribeCertificate operation.- Returns:
- A Java Future containing the result of the DescribeCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeCertificate
default CompletableFuture<DescribeCertificateResponse> describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) Gets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
This is a convenience which creates an instance of the
DescribeCertificateRequest.Builder
avoiding the need to create one manually viaDescribeCertificateRequest.builder()
- Parameters:
describeCertificateRequest
- AConsumer
that will call methods onDescribeCertificateRequest.Builder
to create a request. The input for the DescribeCertificate operation.- Returns:
- A Java Future containing the result of the DescribeCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeCertificateProvider
default CompletableFuture<DescribeCertificateProviderResponse> describeCertificateProvider(DescribeCertificateProviderRequest describeCertificateProviderRequest) Describes a certificate provider.
Requires permission to access the DescribeCertificateProvider action.
- Parameters:
describeCertificateProviderRequest
-- Returns:
- A Java Future containing the result of the DescribeCertificateProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeCertificateProvider
default CompletableFuture<DescribeCertificateProviderResponse> describeCertificateProvider(Consumer<DescribeCertificateProviderRequest.Builder> describeCertificateProviderRequest) Describes a certificate provider.
Requires permission to access the DescribeCertificateProvider action.
This is a convenience which creates an instance of the
DescribeCertificateProviderRequest.Builder
avoiding the need to create one manually viaDescribeCertificateProviderRequest.builder()
- Parameters:
describeCertificateProviderRequest
- AConsumer
that will call methods onDescribeCertificateProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCertificateProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeCustomMetric
default CompletableFuture<DescribeCustomMetricResponse> describeCustomMetric(DescribeCustomMetricRequest describeCustomMetricRequest) Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
- Parameters:
describeCustomMetricRequest
-- Returns:
- A Java Future containing the result of the DescribeCustomMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeCustomMetric
default CompletableFuture<DescribeCustomMetricResponse> describeCustomMetric(Consumer<DescribeCustomMetricRequest.Builder> describeCustomMetricRequest) Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
This is a convenience which creates an instance of the
DescribeCustomMetricRequest.Builder
avoiding the need to create one manually viaDescribeCustomMetricRequest.builder()
- Parameters:
describeCustomMetricRequest
- AConsumer
that will call methods onDescribeCustomMetricRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeCustomMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDefaultAuthorizer
default CompletableFuture<DescribeDefaultAuthorizerResponse> describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest) Describes the default authorizer.
Requires permission to access the DescribeDefaultAuthorizer action.
- Parameters:
describeDefaultAuthorizerRequest
-- Returns:
- A Java Future containing the result of the DescribeDefaultAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDefaultAuthorizer
default CompletableFuture<DescribeDefaultAuthorizerResponse> describeDefaultAuthorizer(Consumer<DescribeDefaultAuthorizerRequest.Builder> describeDefaultAuthorizerRequest) Describes the default authorizer.
Requires permission to access the DescribeDefaultAuthorizer action.
This is a convenience which creates an instance of the
DescribeDefaultAuthorizerRequest.Builder
avoiding the need to create one manually viaDescribeDefaultAuthorizerRequest.builder()
- Parameters:
describeDefaultAuthorizerRequest
- AConsumer
that will call methods onDescribeDefaultAuthorizerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDefaultAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDetectMitigationActionsTask
default CompletableFuture<DescribeDetectMitigationActionsTaskResponse> describeDetectMitigationActionsTask(DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest) Gets information about a Device Defender ML Detect mitigation action.
Requires permission to access the DescribeDetectMitigationActionsTask action.
- Parameters:
describeDetectMitigationActionsTaskRequest
-- Returns:
- A Java Future containing the result of the DescribeDetectMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDetectMitigationActionsTask
default CompletableFuture<DescribeDetectMitigationActionsTaskResponse> describeDetectMitigationActionsTask(Consumer<DescribeDetectMitigationActionsTaskRequest.Builder> describeDetectMitigationActionsTaskRequest) Gets information about a Device Defender ML Detect mitigation action.
Requires permission to access the DescribeDetectMitigationActionsTask action.
This is a convenience which creates an instance of the
DescribeDetectMitigationActionsTaskRequest.Builder
avoiding the need to create one manually viaDescribeDetectMitigationActionsTaskRequest.builder()
- Parameters:
describeDetectMitigationActionsTaskRequest
- AConsumer
that will call methods onDescribeDetectMitigationActionsTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDetectMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDimension
default CompletableFuture<DescribeDimensionResponse> describeDimension(DescribeDimensionRequest describeDimensionRequest) Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
- Parameters:
describeDimensionRequest
-- Returns:
- A Java Future containing the result of the DescribeDimension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDimension
default CompletableFuture<DescribeDimensionResponse> describeDimension(Consumer<DescribeDimensionRequest.Builder> describeDimensionRequest) Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
This is a convenience which creates an instance of the
DescribeDimensionRequest.Builder
avoiding the need to create one manually viaDescribeDimensionRequest.builder()
- Parameters:
describeDimensionRequest
- AConsumer
that will call methods onDescribeDimensionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDimension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDomainConfiguration
default CompletableFuture<DescribeDomainConfigurationResponse> describeDomainConfiguration(DescribeDomainConfigurationRequest describeDomainConfigurationRequest) Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
- Parameters:
describeDomainConfigurationRequest
-- Returns:
- A Java Future containing the result of the DescribeDomainConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDomainConfiguration
default CompletableFuture<DescribeDomainConfigurationResponse> describeDomainConfiguration(Consumer<DescribeDomainConfigurationRequest.Builder> describeDomainConfigurationRequest) Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
This is a convenience which creates an instance of the
DescribeDomainConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeDomainConfigurationRequest.builder()
- Parameters:
describeDomainConfigurationRequest
- AConsumer
that will call methods onDescribeDomainConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDomainConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeEndpoint
default CompletableFuture<DescribeEndpointResponse> 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 toDescribeEndpoint
return the same endpoint.Requires permission to access the DescribeEndpoint action.
- Parameters:
describeEndpointRequest
- The input for the DescribeEndpoint operation.- Returns:
- A Java Future containing the result of the DescribeEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeEndpoint
default CompletableFuture<DescribeEndpointResponse> describeEndpoint(Consumer<DescribeEndpointRequest.Builder> 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 toDescribeEndpoint
return the same endpoint.Requires permission to access the DescribeEndpoint action.
This is a convenience which creates an instance of the
DescribeEndpointRequest.Builder
avoiding the need to create one manually viaDescribeEndpointRequest.builder()
- Parameters:
describeEndpointRequest
- AConsumer
that will call methods onDescribeEndpointRequest.Builder
to create a request. The input for the DescribeEndpoint operation.- Returns:
- A Java Future containing the result of the DescribeEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeEndpoint
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 toDescribeEndpoint
return the same endpoint.Requires permission to access the DescribeEndpoint action.
- Returns:
- A Java Future containing the result of the DescribeEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeEventConfigurations
default CompletableFuture<DescribeEventConfigurationsResponse> describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest) Describes event configurations.
Requires permission to access the DescribeEventConfigurations action.
- Parameters:
describeEventConfigurationsRequest
-- Returns:
- A Java Future containing the result of the DescribeEventConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalFailureException An unexpected error has occurred.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeEventConfigurations
default CompletableFuture<DescribeEventConfigurationsResponse> describeEventConfigurations(Consumer<DescribeEventConfigurationsRequest.Builder> describeEventConfigurationsRequest) Describes event configurations.
Requires permission to access the DescribeEventConfigurations action.
This is a convenience which creates an instance of the
DescribeEventConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeEventConfigurationsRequest.builder()
- Parameters:
describeEventConfigurationsRequest
- AConsumer
that will call methods onDescribeEventConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEventConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalFailureException An unexpected error has occurred.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeEventConfigurations
Describes event configurations.
Requires permission to access the DescribeEventConfigurations action.
- Returns:
- A Java Future containing the result of the DescribeEventConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalFailureException An unexpected error has occurred.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeFleetMetric
default CompletableFuture<DescribeFleetMetricResponse> describeFleetMetric(DescribeFleetMetricRequest describeFleetMetricRequest) Gets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
- Parameters:
describeFleetMetricRequest
-- Returns:
- A Java Future containing the result of the DescribeFleetMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeFleetMetric
default CompletableFuture<DescribeFleetMetricResponse> describeFleetMetric(Consumer<DescribeFleetMetricRequest.Builder> describeFleetMetricRequest) Gets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
This is a convenience which creates an instance of the
DescribeFleetMetricRequest.Builder
avoiding the need to create one manually viaDescribeFleetMetricRequest.builder()
- Parameters:
describeFleetMetricRequest
- AConsumer
that will call methods onDescribeFleetMetricRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFleetMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeIndex
default CompletableFuture<DescribeIndexResponse> describeIndex(DescribeIndexRequest describeIndexRequest) Describes a search index.
Requires permission to access the DescribeIndex action.
- Parameters:
describeIndexRequest
-- Returns:
- A Java Future containing the result of the DescribeIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeIndex
default CompletableFuture<DescribeIndexResponse> describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest) Describes a search index.
Requires permission to access the DescribeIndex action.
This is a convenience which creates an instance of the
DescribeIndexRequest.Builder
avoiding the need to create one manually viaDescribeIndexRequest.builder()
- Parameters:
describeIndexRequest
- AConsumer
that will call methods onDescribeIndexRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeJob
Describes a job.
Requires permission to access the DescribeJob action.
- Parameters:
describeJobRequest
-- Returns:
- A Java Future containing the result of the DescribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeJob
default CompletableFuture<DescribeJobResponse> describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest) Describes a job.
Requires permission to access the DescribeJob action.
This is a convenience which creates an instance of the
DescribeJobRequest.Builder
avoiding the need to create one manually viaDescribeJobRequest.builder()
- Parameters:
describeJobRequest
- AConsumer
that will call methods onDescribeJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeJobExecution
default CompletableFuture<DescribeJobExecutionResponse> describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest) Describes a job execution.
Requires permission to access the DescribeJobExecution action.
- Parameters:
describeJobExecutionRequest
-- Returns:
- A Java Future containing the result of the DescribeJobExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeJobExecution
default CompletableFuture<DescribeJobExecutionResponse> describeJobExecution(Consumer<DescribeJobExecutionRequest.Builder> describeJobExecutionRequest) Describes a job execution.
Requires permission to access the DescribeJobExecution action.
This is a convenience which creates an instance of the
DescribeJobExecutionRequest.Builder
avoiding the need to create one manually viaDescribeJobExecutionRequest.builder()
- Parameters:
describeJobExecutionRequest
- AConsumer
that will call methods onDescribeJobExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeJobExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeJobTemplate
default CompletableFuture<DescribeJobTemplateResponse> describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest) Returns information about a job template.
- Parameters:
describeJobTemplateRequest
-- Returns:
- A Java Future containing the result of the DescribeJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeJobTemplate
default CompletableFuture<DescribeJobTemplateResponse> describeJobTemplate(Consumer<DescribeJobTemplateRequest.Builder> describeJobTemplateRequest) Returns information about a job template.
This is a convenience which creates an instance of the
DescribeJobTemplateRequest.Builder
avoiding the need to create one manually viaDescribeJobTemplateRequest.builder()
- Parameters:
describeJobTemplateRequest
- AConsumer
that will call methods onDescribeJobTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeManagedJobTemplate
default CompletableFuture<DescribeManagedJobTemplateResponse> describeManagedJobTemplate(DescribeManagedJobTemplateRequest describeManagedJobTemplateRequest) View details of a managed job template.
- Parameters:
describeManagedJobTemplateRequest
-- Returns:
- A Java Future containing the result of the DescribeManagedJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeManagedJobTemplate
default CompletableFuture<DescribeManagedJobTemplateResponse> describeManagedJobTemplate(Consumer<DescribeManagedJobTemplateRequest.Builder> describeManagedJobTemplateRequest) View details of a managed job template.
This is a convenience which creates an instance of the
DescribeManagedJobTemplateRequest.Builder
avoiding the need to create one manually viaDescribeManagedJobTemplateRequest.builder()
- Parameters:
describeManagedJobTemplateRequest
- AConsumer
that will call methods onDescribeManagedJobTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeManagedJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeMitigationAction
default CompletableFuture<DescribeMitigationActionResponse> describeMitigationAction(DescribeMitigationActionRequest describeMitigationActionRequest) Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
- Parameters:
describeMitigationActionRequest
-- Returns:
- A Java Future containing the result of the DescribeMitigationAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeMitigationAction
default CompletableFuture<DescribeMitigationActionResponse> describeMitigationAction(Consumer<DescribeMitigationActionRequest.Builder> describeMitigationActionRequest) Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
This is a convenience which creates an instance of the
DescribeMitigationActionRequest.Builder
avoiding the need to create one manually viaDescribeMitigationActionRequest.builder()
- Parameters:
describeMitigationActionRequest
- AConsumer
that will call methods onDescribeMitigationActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeMitigationAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeProvisioningTemplate
default CompletableFuture<DescribeProvisioningTemplateResponse> describeProvisioningTemplate(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest) Returns information about a provisioning template.
Requires permission to access the DescribeProvisioningTemplate action.
- Parameters:
describeProvisioningTemplateRequest
-- Returns:
- A Java Future containing the result of the DescribeProvisioningTemplate operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeProvisioningTemplate
default CompletableFuture<DescribeProvisioningTemplateResponse> describeProvisioningTemplate(Consumer<DescribeProvisioningTemplateRequest.Builder> describeProvisioningTemplateRequest) Returns information about a provisioning template.
Requires permission to access the DescribeProvisioningTemplate action.
This is a convenience which creates an instance of the
DescribeProvisioningTemplateRequest.Builder
avoiding the need to create one manually viaDescribeProvisioningTemplateRequest.builder()
- Parameters:
describeProvisioningTemplateRequest
- AConsumer
that will call methods onDescribeProvisioningTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProvisioningTemplate operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeProvisioningTemplateVersion
default CompletableFuture<DescribeProvisioningTemplateVersionResponse> describeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest) Returns information about a provisioning template version.
Requires permission to access the DescribeProvisioningTemplateVersion action.
- Parameters:
describeProvisioningTemplateVersionRequest
-- Returns:
- A Java Future containing the result of the DescribeProvisioningTemplateVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeProvisioningTemplateVersion
default CompletableFuture<DescribeProvisioningTemplateVersionResponse> describeProvisioningTemplateVersion(Consumer<DescribeProvisioningTemplateVersionRequest.Builder> describeProvisioningTemplateVersionRequest) Returns information about a provisioning template version.
Requires permission to access the DescribeProvisioningTemplateVersion action.
This is a convenience which creates an instance of the
DescribeProvisioningTemplateVersionRequest.Builder
avoiding the need to create one manually viaDescribeProvisioningTemplateVersionRequest.builder()
- Parameters:
describeProvisioningTemplateVersionRequest
- AConsumer
that will call methods onDescribeProvisioningTemplateVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeProvisioningTemplateVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeRoleAlias
default CompletableFuture<DescribeRoleAliasResponse> describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest) Describes a role alias.
Requires permission to access the DescribeRoleAlias action.
- Parameters:
describeRoleAliasRequest
-- Returns:
- A Java Future containing the result of the DescribeRoleAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeRoleAlias
default CompletableFuture<DescribeRoleAliasResponse> describeRoleAlias(Consumer<DescribeRoleAliasRequest.Builder> describeRoleAliasRequest) Describes a role alias.
Requires permission to access the DescribeRoleAlias action.
This is a convenience which creates an instance of the
DescribeRoleAliasRequest.Builder
avoiding the need to create one manually viaDescribeRoleAliasRequest.builder()
- Parameters:
describeRoleAliasRequest
- AConsumer
that will call methods onDescribeRoleAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRoleAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeScheduledAudit
default CompletableFuture<DescribeScheduledAuditResponse> describeScheduledAudit(DescribeScheduledAuditRequest describeScheduledAuditRequest) Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
- Parameters:
describeScheduledAuditRequest
-- Returns:
- A Java Future containing the result of the DescribeScheduledAudit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeScheduledAudit
default CompletableFuture<DescribeScheduledAuditResponse> describeScheduledAudit(Consumer<DescribeScheduledAuditRequest.Builder> describeScheduledAuditRequest) Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
This is a convenience which creates an instance of the
DescribeScheduledAuditRequest.Builder
avoiding the need to create one manually viaDescribeScheduledAuditRequest.builder()
- Parameters:
describeScheduledAuditRequest
- AConsumer
that will call methods onDescribeScheduledAuditRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeScheduledAudit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeSecurityProfile
default CompletableFuture<DescribeSecurityProfileResponse> describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest) Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
- Parameters:
describeSecurityProfileRequest
-- Returns:
- A Java Future containing the result of the DescribeSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeSecurityProfile
default CompletableFuture<DescribeSecurityProfileResponse> describeSecurityProfile(Consumer<DescribeSecurityProfileRequest.Builder> describeSecurityProfileRequest) Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
This is a convenience which creates an instance of the
DescribeSecurityProfileRequest.Builder
avoiding the need to create one manually viaDescribeSecurityProfileRequest.builder()
- Parameters:
describeSecurityProfileRequest
- AConsumer
that will call methods onDescribeSecurityProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeStream
default CompletableFuture<DescribeStreamResponse> describeStream(DescribeStreamRequest describeStreamRequest) Gets information about a stream.
Requires permission to access the DescribeStream action.
- Parameters:
describeStreamRequest
-- Returns:
- A Java Future containing the result of the DescribeStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeStream
default CompletableFuture<DescribeStreamResponse> describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest) Gets information about a stream.
Requires permission to access the DescribeStream action.
This is a convenience which creates an instance of the
DescribeStreamRequest.Builder
avoiding the need to create one manually viaDescribeStreamRequest.builder()
- Parameters:
describeStreamRequest
- AConsumer
that will call methods onDescribeStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeThing
default CompletableFuture<DescribeThingResponse> describeThing(DescribeThingRequest describeThingRequest) Gets information about the specified thing.
Requires permission to access the DescribeThing action.
- Parameters:
describeThingRequest
- The input for the DescribeThing operation.- Returns:
- A Java Future containing the result of the DescribeThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeThing
default CompletableFuture<DescribeThingResponse> describeThing(Consumer<DescribeThingRequest.Builder> describeThingRequest) Gets information about the specified thing.
Requires permission to access the DescribeThing action.
This is a convenience which creates an instance of the
DescribeThingRequest.Builder
avoiding the need to create one manually viaDescribeThingRequest.builder()
- Parameters:
describeThingRequest
- AConsumer
that will call methods onDescribeThingRequest.Builder
to create a request. The input for the DescribeThing operation.- Returns:
- A Java Future containing the result of the DescribeThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeThingGroup
default CompletableFuture<DescribeThingGroupResponse> describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest) Describe a thing group.
Requires permission to access the DescribeThingGroup action.
- Parameters:
describeThingGroupRequest
-- Returns:
- A Java Future containing the result of the DescribeThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeThingGroup
default CompletableFuture<DescribeThingGroupResponse> describeThingGroup(Consumer<DescribeThingGroupRequest.Builder> describeThingGroupRequest) Describe a thing group.
Requires permission to access the DescribeThingGroup action.
This is a convenience which creates an instance of the
DescribeThingGroupRequest.Builder
avoiding the need to create one manually viaDescribeThingGroupRequest.builder()
- Parameters:
describeThingGroupRequest
- AConsumer
that will call methods onDescribeThingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeThingRegistrationTask
default CompletableFuture<DescribeThingRegistrationTaskResponse> describeThingRegistrationTask(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest) Describes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
- Parameters:
describeThingRegistrationTaskRequest
-- Returns:
- A Java Future containing the result of the DescribeThingRegistrationTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeThingRegistrationTask
default CompletableFuture<DescribeThingRegistrationTaskResponse> describeThingRegistrationTask(Consumer<DescribeThingRegistrationTaskRequest.Builder> describeThingRegistrationTaskRequest) Describes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
This is a convenience which creates an instance of the
DescribeThingRegistrationTaskRequest.Builder
avoiding the need to create one manually viaDescribeThingRegistrationTaskRequest.builder()
- Parameters:
describeThingRegistrationTaskRequest
- AConsumer
that will call methods onDescribeThingRegistrationTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeThingRegistrationTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeThingType
default CompletableFuture<DescribeThingTypeResponse> describeThingType(DescribeThingTypeRequest describeThingTypeRequest) Gets information about the specified thing type.
Requires permission to access the DescribeThingType action.
- Parameters:
describeThingTypeRequest
- The input for the DescribeThingType operation.- Returns:
- A Java Future containing the result of the DescribeThingType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeThingType
default CompletableFuture<DescribeThingTypeResponse> describeThingType(Consumer<DescribeThingTypeRequest.Builder> describeThingTypeRequest) Gets information about the specified thing type.
Requires permission to access the DescribeThingType action.
This is a convenience which creates an instance of the
DescribeThingTypeRequest.Builder
avoiding the need to create one manually viaDescribeThingTypeRequest.builder()
- Parameters:
describeThingTypeRequest
- AConsumer
that will call methods onDescribeThingTypeRequest.Builder
to create a request. The input for the DescribeThingType operation.- Returns:
- A Java Future containing the result of the DescribeThingType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
detachPolicy
default CompletableFuture<DetachPolicyResponse> 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.
- Parameters:
detachPolicyRequest
-- Returns:
- A Java Future containing the result of the DetachPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
detachPolicy
default CompletableFuture<DetachPolicyResponse> detachPolicy(Consumer<DetachPolicyRequest.Builder> 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.
This is a convenience which creates an instance of the
DetachPolicyRequest.Builder
avoiding the need to create one manually viaDetachPolicyRequest.builder()
- Parameters:
detachPolicyRequest
- AConsumer
that will call methods onDetachPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetachPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
detachSecurityProfile
default CompletableFuture<DetachSecurityProfileResponse> detachSecurityProfile(DetachSecurityProfileRequest detachSecurityProfileRequest) Disassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
- Parameters:
detachSecurityProfileRequest
-- Returns:
- A Java Future containing the result of the DetachSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
detachSecurityProfile
default CompletableFuture<DetachSecurityProfileResponse> detachSecurityProfile(Consumer<DetachSecurityProfileRequest.Builder> detachSecurityProfileRequest) Disassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
This is a convenience which creates an instance of the
DetachSecurityProfileRequest.Builder
avoiding the need to create one manually viaDetachSecurityProfileRequest.builder()
- Parameters:
detachSecurityProfileRequest
- AConsumer
that will call methods onDetachSecurityProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DetachSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
detachThingPrincipal
default CompletableFuture<DetachThingPrincipalResponse> 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.
- Parameters:
detachThingPrincipalRequest
- The input for the DetachThingPrincipal operation.- Returns:
- A Java Future containing the result of the DetachThingPrincipal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
detachThingPrincipal
default CompletableFuture<DetachThingPrincipalResponse> detachThingPrincipal(Consumer<DetachThingPrincipalRequest.Builder> 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.
This is a convenience which creates an instance of the
DetachThingPrincipalRequest.Builder
avoiding the need to create one manually viaDetachThingPrincipalRequest.builder()
- Parameters:
detachThingPrincipalRequest
- AConsumer
that will call methods onDetachThingPrincipalRequest.Builder
to create a request. The input for the DetachThingPrincipal operation.- Returns:
- A Java Future containing the result of the DetachThingPrincipal operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
disableTopicRule
default CompletableFuture<DisableTopicRuleResponse> disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) Disables the rule.
Requires permission to access the DisableTopicRule action.
- Parameters:
disableTopicRuleRequest
- The input for the DisableTopicRuleRequest operation.- Returns:
- A Java Future containing the result of the DisableTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
disableTopicRule
default CompletableFuture<DisableTopicRuleResponse> disableTopicRule(Consumer<DisableTopicRuleRequest.Builder> disableTopicRuleRequest) Disables the rule.
Requires permission to access the DisableTopicRule action.
This is a convenience which creates an instance of the
DisableTopicRuleRequest.Builder
avoiding the need to create one manually viaDisableTopicRuleRequest.builder()
- Parameters:
disableTopicRuleRequest
- AConsumer
that will call methods onDisableTopicRuleRequest.Builder
to create a request. The input for the DisableTopicRuleRequest operation.- Returns:
- A Java Future containing the result of the DisableTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
disassociateSbomFromPackageVersion
default CompletableFuture<DisassociateSbomFromPackageVersionResponse> disassociateSbomFromPackageVersion(DisassociateSbomFromPackageVersionRequest disassociateSbomFromPackageVersionRequest) Disassociates the selected software bill of materials (SBOM) from a specific software package version.
Requires permission to access the DisassociateSbomWithPackageVersion action.
- Parameters:
disassociateSbomFromPackageVersionRequest
-- Returns:
- A Java Future containing the result of the DisassociateSbomFromPackageVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
disassociateSbomFromPackageVersion
default CompletableFuture<DisassociateSbomFromPackageVersionResponse> disassociateSbomFromPackageVersion(Consumer<DisassociateSbomFromPackageVersionRequest.Builder> disassociateSbomFromPackageVersionRequest) Disassociates the selected software bill of materials (SBOM) from a specific software package version.
Requires permission to access the DisassociateSbomWithPackageVersion action.
This is a convenience which creates an instance of the
DisassociateSbomFromPackageVersionRequest.Builder
avoiding the need to create one manually viaDisassociateSbomFromPackageVersionRequest.builder()
- Parameters:
disassociateSbomFromPackageVersionRequest
- AConsumer
that will call methods onDisassociateSbomFromPackageVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateSbomFromPackageVersion operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
enableTopicRule
default CompletableFuture<EnableTopicRuleResponse> enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) Enables the rule.
Requires permission to access the EnableTopicRule action.
- Parameters:
enableTopicRuleRequest
- The input for the EnableTopicRuleRequest operation.- Returns:
- A Java Future containing the result of the EnableTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
enableTopicRule
default CompletableFuture<EnableTopicRuleResponse> enableTopicRule(Consumer<EnableTopicRuleRequest.Builder> enableTopicRuleRequest) Enables the rule.
Requires permission to access the EnableTopicRule action.
This is a convenience which creates an instance of the
EnableTopicRuleRequest.Builder
avoiding the need to create one manually viaEnableTopicRuleRequest.builder()
- Parameters:
enableTopicRuleRequest
- AConsumer
that will call methods onEnableTopicRuleRequest.Builder
to create a request. The input for the EnableTopicRuleRequest operation.- Returns:
- A Java Future containing the result of the EnableTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getBehaviorModelTrainingSummaries
default CompletableFuture<GetBehaviorModelTrainingSummariesResponse> getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest) Returns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
- Parameters:
getBehaviorModelTrainingSummariesRequest
-- Returns:
- A Java Future containing the result of the GetBehaviorModelTrainingSummaries operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getBehaviorModelTrainingSummaries
default CompletableFuture<GetBehaviorModelTrainingSummariesResponse> getBehaviorModelTrainingSummaries(Consumer<GetBehaviorModelTrainingSummariesRequest.Builder> getBehaviorModelTrainingSummariesRequest) Returns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
This is a convenience which creates an instance of the
GetBehaviorModelTrainingSummariesRequest.Builder
avoiding the need to create one manually viaGetBehaviorModelTrainingSummariesRequest.builder()
- Parameters:
getBehaviorModelTrainingSummariesRequest
- AConsumer
that will call methods onGetBehaviorModelTrainingSummariesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBehaviorModelTrainingSummaries operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getBehaviorModelTrainingSummariesPaginator
default GetBehaviorModelTrainingSummariesPublisher getBehaviorModelTrainingSummariesPaginator(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest) This is a variant of
getBehaviorModelTrainingSummaries(software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.GetBehaviorModelTrainingSummariesPublisher publisher = client.getBehaviorModelTrainingSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.GetBehaviorModelTrainingSummariesPublisher publisher = client.getBehaviorModelTrainingSummariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBehaviorModelTrainingSummaries(software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesRequest)
operation.- Parameters:
getBehaviorModelTrainingSummariesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getBehaviorModelTrainingSummariesPaginator
default GetBehaviorModelTrainingSummariesPublisher getBehaviorModelTrainingSummariesPaginator(Consumer<GetBehaviorModelTrainingSummariesRequest.Builder> getBehaviorModelTrainingSummariesRequest) This is a variant of
getBehaviorModelTrainingSummaries(software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.GetBehaviorModelTrainingSummariesPublisher publisher = client.getBehaviorModelTrainingSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.GetBehaviorModelTrainingSummariesPublisher publisher = client.getBehaviorModelTrainingSummariesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getBehaviorModelTrainingSummaries(software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesRequest)
operation.
This is a convenience which creates an instance of the
GetBehaviorModelTrainingSummariesRequest.Builder
avoiding the need to create one manually viaGetBehaviorModelTrainingSummariesRequest.builder()
- Parameters:
getBehaviorModelTrainingSummariesRequest
- AConsumer
that will call methods onGetBehaviorModelTrainingSummariesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getBucketsAggregation
default CompletableFuture<GetBucketsAggregationResponse> getBucketsAggregation(GetBucketsAggregationRequest getBucketsAggregationRequest) Aggregates on indexed data with search queries pertaining to particular fields.
Requires permission to access the GetBucketsAggregation action.
- Parameters:
getBucketsAggregationRequest
-- Returns:
- A Java Future containing the result of the GetBucketsAggregation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getBucketsAggregation
default CompletableFuture<GetBucketsAggregationResponse> getBucketsAggregation(Consumer<GetBucketsAggregationRequest.Builder> getBucketsAggregationRequest) Aggregates on indexed data with search queries pertaining to particular fields.
Requires permission to access the GetBucketsAggregation action.
This is a convenience which creates an instance of the
GetBucketsAggregationRequest.Builder
avoiding the need to create one manually viaGetBucketsAggregationRequest.builder()
- Parameters:
getBucketsAggregationRequest
- AConsumer
that will call methods onGetBucketsAggregationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBucketsAggregation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getCardinality
default CompletableFuture<GetCardinalityResponse> getCardinality(GetCardinalityRequest getCardinalityRequest) Returns the approximate count of unique values that match the query.
Requires permission to access the GetCardinality action.
- Parameters:
getCardinalityRequest
-- Returns:
- A Java Future containing the result of the GetCardinality operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getCardinality
default CompletableFuture<GetCardinalityResponse> getCardinality(Consumer<GetCardinalityRequest.Builder> getCardinalityRequest) Returns the approximate count of unique values that match the query.
Requires permission to access the GetCardinality action.
This is a convenience which creates an instance of the
GetCardinalityRequest.Builder
avoiding the need to create one manually viaGetCardinalityRequest.builder()
- Parameters:
getCardinalityRequest
- AConsumer
that will call methods onGetCardinalityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCardinality operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getEffectivePolicies
default CompletableFuture<GetEffectivePoliciesResponse> 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.
- Parameters:
getEffectivePoliciesRequest
-- Returns:
- A Java Future containing the result of the GetEffectivePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getEffectivePolicies
default CompletableFuture<GetEffectivePoliciesResponse> getEffectivePolicies(Consumer<GetEffectivePoliciesRequest.Builder> 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.
This is a convenience which creates an instance of the
GetEffectivePoliciesRequest.Builder
avoiding the need to create one manually viaGetEffectivePoliciesRequest.builder()
- Parameters:
getEffectivePoliciesRequest
- AConsumer
that will call methods onGetEffectivePoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEffectivePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getIndexingConfiguration
default CompletableFuture<GetIndexingConfigurationResponse> getIndexingConfiguration(GetIndexingConfigurationRequest getIndexingConfigurationRequest) Gets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
- Parameters:
getIndexingConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetIndexingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getIndexingConfiguration
default CompletableFuture<GetIndexingConfigurationResponse> getIndexingConfiguration(Consumer<GetIndexingConfigurationRequest.Builder> getIndexingConfigurationRequest) Gets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
This is a convenience which creates an instance of the
GetIndexingConfigurationRequest.Builder
avoiding the need to create one manually viaGetIndexingConfigurationRequest.builder()
- Parameters:
getIndexingConfigurationRequest
- AConsumer
that will call methods onGetIndexingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetIndexingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getIndexingConfiguration
Gets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
- Returns:
- A Java Future containing the result of the GetIndexingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getJobDocument
default CompletableFuture<GetJobDocumentResponse> getJobDocument(GetJobDocumentRequest getJobDocumentRequest) Gets a job document.
Requires permission to access the GetJobDocument action.
- Parameters:
getJobDocumentRequest
-- Returns:
- A Java Future containing the result of the GetJobDocument operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getJobDocument
default CompletableFuture<GetJobDocumentResponse> getJobDocument(Consumer<GetJobDocumentRequest.Builder> getJobDocumentRequest) Gets a job document.
Requires permission to access the GetJobDocument action.
This is a convenience which creates an instance of the
GetJobDocumentRequest.Builder
avoiding the need to create one manually viaGetJobDocumentRequest.builder()
- Parameters:
getJobDocumentRequest
- AConsumer
that will call methods onGetJobDocumentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetJobDocument operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getLoggingOptions
default CompletableFuture<GetLoggingOptionsResponse> 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.
- Parameters:
getLoggingOptionsRequest
- The input for the GetLoggingOptions operation.- Returns:
- A Java Future containing the result of the GetLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getLoggingOptions
default CompletableFuture<GetLoggingOptionsResponse> getLoggingOptions(Consumer<GetLoggingOptionsRequest.Builder> getLoggingOptionsRequest) Gets the logging options.
NOTE: use of this command is not recommended. Use
GetV2LoggingOptions
instead.Requires permission to access the GetLoggingOptions action.
This is a convenience which creates an instance of the
GetLoggingOptionsRequest.Builder
avoiding the need to create one manually viaGetLoggingOptionsRequest.builder()
- Parameters:
getLoggingOptionsRequest
- AConsumer
that will call methods onGetLoggingOptionsRequest.Builder
to create a request. The input for the GetLoggingOptions operation.- Returns:
- A Java Future containing the result of the GetLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getLoggingOptions
Gets the logging options.
NOTE: use of this command is not recommended. Use
GetV2LoggingOptions
instead.Requires permission to access the GetLoggingOptions action.
- Returns:
- A Java Future containing the result of the GetLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getOTAUpdate
default CompletableFuture<GetOtaUpdateResponse> getOTAUpdate(GetOtaUpdateRequest getOtaUpdateRequest) Gets an OTA update.
Requires permission to access the GetOTAUpdate action.
- Parameters:
getOtaUpdateRequest
-- Returns:
- A Java Future containing the result of the GetOTAUpdate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getOTAUpdate
default CompletableFuture<GetOtaUpdateResponse> getOTAUpdate(Consumer<GetOtaUpdateRequest.Builder> getOtaUpdateRequest) Gets an OTA update.
Requires permission to access the GetOTAUpdate action.
This is a convenience which creates an instance of the
GetOtaUpdateRequest.Builder
avoiding the need to create one manually viaGetOtaUpdateRequest.builder()
- Parameters:
getOtaUpdateRequest
- AConsumer
that will call methods onGetOtaUpdateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOTAUpdate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPackage
Gets information about the specified software package.
Requires permission to access the GetPackage action.
- Parameters:
getPackageRequest
-- Returns:
- A Java Future containing the result of the GetPackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPackage
default CompletableFuture<GetPackageResponse> getPackage(Consumer<GetPackageRequest.Builder> getPackageRequest) Gets information about the specified software package.
Requires permission to access the GetPackage action.
This is a convenience which creates an instance of the
GetPackageRequest.Builder
avoiding the need to create one manually viaGetPackageRequest.builder()
- Parameters:
getPackageRequest
- AConsumer
that will call methods onGetPackageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPackageConfiguration
default CompletableFuture<GetPackageConfigurationResponse> getPackageConfiguration(GetPackageConfigurationRequest getPackageConfigurationRequest) Gets information about the specified software package's configuration.
Requires permission to access the GetPackageConfiguration action.
- Parameters:
getPackageConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetPackageConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The rate exceeds the limit.
- InternalServerException Internal error from the service that indicates an unexpected error or that the service is unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPackageConfiguration
default CompletableFuture<GetPackageConfigurationResponse> getPackageConfiguration(Consumer<GetPackageConfigurationRequest.Builder> getPackageConfigurationRequest) Gets information about the specified software package's configuration.
Requires permission to access the GetPackageConfiguration action.
This is a convenience which creates an instance of the
GetPackageConfigurationRequest.Builder
avoiding the need to create one manually viaGetPackageConfigurationRequest.builder()
- Parameters:
getPackageConfigurationRequest
- AConsumer
that will call methods onGetPackageConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPackageConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The rate exceeds the limit.
- InternalServerException Internal error from the service that indicates an unexpected error or that the service is unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPackageVersion
default CompletableFuture<GetPackageVersionResponse> getPackageVersion(GetPackageVersionRequest getPackageVersionRequest) Gets information about the specified package version.
Requires permission to access the GetPackageVersion action.
- Parameters:
getPackageVersionRequest
-- Returns:
- A Java Future containing the result of the GetPackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPackageVersion
default CompletableFuture<GetPackageVersionResponse> getPackageVersion(Consumer<GetPackageVersionRequest.Builder> getPackageVersionRequest) Gets information about the specified package version.
Requires permission to access the GetPackageVersion action.
This is a convenience which creates an instance of the
GetPackageVersionRequest.Builder
avoiding the need to create one manually viaGetPackageVersionRequest.builder()
- Parameters:
getPackageVersionRequest
- AConsumer
that will call methods onGetPackageVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPercentiles
default CompletableFuture<GetPercentilesResponse> 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.
- Parameters:
getPercentilesRequest
-- Returns:
- A Java Future containing the result of the GetPercentiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPercentiles
default CompletableFuture<GetPercentilesResponse> getPercentiles(Consumer<GetPercentilesRequest.Builder> 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.
This is a convenience which creates an instance of the
GetPercentilesRequest.Builder
avoiding the need to create one manually viaGetPercentilesRequest.builder()
- Parameters:
getPercentilesRequest
- AConsumer
that will call methods onGetPercentilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPercentiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPolicy
Gets information about the specified policy with the policy document of the default version.
Requires permission to access the GetPolicy action.
- Parameters:
getPolicyRequest
- The input for the GetPolicy operation.- Returns:
- A Java Future containing the result of the GetPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPolicy
default CompletableFuture<GetPolicyResponse> getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) Gets information about the specified policy with the policy document of the default version.
Requires permission to access the GetPolicy action.
This is a convenience which creates an instance of the
GetPolicyRequest.Builder
avoiding the need to create one manually viaGetPolicyRequest.builder()
- Parameters:
getPolicyRequest
- AConsumer
that will call methods onGetPolicyRequest.Builder
to create a request. The input for the GetPolicy operation.- Returns:
- A Java Future containing the result of the GetPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPolicyVersion
default CompletableFuture<GetPolicyVersionResponse> getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) Gets information about the specified policy version.
Requires permission to access the GetPolicyVersion action.
- Parameters:
getPolicyVersionRequest
- The input for the GetPolicyVersion operation.- Returns:
- A Java Future containing the result of the GetPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPolicyVersion
default CompletableFuture<GetPolicyVersionResponse> getPolicyVersion(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) Gets information about the specified policy version.
Requires permission to access the GetPolicyVersion action.
This is a convenience which creates an instance of the
GetPolicyVersionRequest.Builder
avoiding the need to create one manually viaGetPolicyVersionRequest.builder()
- Parameters:
getPolicyVersionRequest
- AConsumer
that will call methods onGetPolicyVersionRequest.Builder
to create a request. The input for the GetPolicyVersion operation.- Returns:
- A Java Future containing the result of the GetPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getRegistrationCode
default CompletableFuture<GetRegistrationCodeResponse> 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.
- Parameters:
getRegistrationCodeRequest
- The input to the GetRegistrationCode operation.- Returns:
- A Java Future containing the result of the GetRegistrationCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getRegistrationCode
default CompletableFuture<GetRegistrationCodeResponse> getRegistrationCode(Consumer<GetRegistrationCodeRequest.Builder> 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.
This is a convenience which creates an instance of the
GetRegistrationCodeRequest.Builder
avoiding the need to create one manually viaGetRegistrationCodeRequest.builder()
- Parameters:
getRegistrationCodeRequest
- AConsumer
that will call methods onGetRegistrationCodeRequest.Builder
to create a request. The input to the GetRegistrationCode operation.- Returns:
- A Java Future containing the result of the GetRegistrationCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getRegistrationCode
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.
- Returns:
- A Java Future containing the result of the GetRegistrationCode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getStatistics
default CompletableFuture<GetStatisticsResponse> 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.
- Parameters:
getStatisticsRequest
-- Returns:
- A Java Future containing the result of the GetStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getStatistics
default CompletableFuture<GetStatisticsResponse> getStatistics(Consumer<GetStatisticsRequest.Builder> 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.
This is a convenience which creates an instance of the
GetStatisticsRequest.Builder
avoiding the need to create one manually viaGetStatisticsRequest.builder()
- Parameters:
getStatisticsRequest
- AConsumer
that will call methods onGetStatisticsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStatistics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getTopicRule
default CompletableFuture<GetTopicRuleResponse> getTopicRule(GetTopicRuleRequest getTopicRuleRequest) Gets information about the rule.
Requires permission to access the GetTopicRule action.
- Parameters:
getTopicRuleRequest
- The input for the GetTopicRule operation.- Returns:
- A Java Future containing the result of the GetTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getTopicRule
default CompletableFuture<GetTopicRuleResponse> getTopicRule(Consumer<GetTopicRuleRequest.Builder> getTopicRuleRequest) Gets information about the rule.
Requires permission to access the GetTopicRule action.
This is a convenience which creates an instance of the
GetTopicRuleRequest.Builder
avoiding the need to create one manually viaGetTopicRuleRequest.builder()
- Parameters:
getTopicRuleRequest
- AConsumer
that will call methods onGetTopicRuleRequest.Builder
to create a request. The input for the GetTopicRule operation.- Returns:
- A Java Future containing the result of the GetTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getTopicRuleDestination
default CompletableFuture<GetTopicRuleDestinationResponse> getTopicRuleDestination(GetTopicRuleDestinationRequest getTopicRuleDestinationRequest) Gets information about a topic rule destination.
Requires permission to access the GetTopicRuleDestination action.
- Parameters:
getTopicRuleDestinationRequest
-- Returns:
- A Java Future containing the result of the GetTopicRuleDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getTopicRuleDestination
default CompletableFuture<GetTopicRuleDestinationResponse> getTopicRuleDestination(Consumer<GetTopicRuleDestinationRequest.Builder> getTopicRuleDestinationRequest) Gets information about a topic rule destination.
Requires permission to access the GetTopicRuleDestination action.
This is a convenience which creates an instance of the
GetTopicRuleDestinationRequest.Builder
avoiding the need to create one manually viaGetTopicRuleDestinationRequest.builder()
- Parameters:
getTopicRuleDestinationRequest
- AConsumer
that will call methods onGetTopicRuleDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTopicRuleDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getV2LoggingOptions
default CompletableFuture<GetV2LoggingOptionsResponse> getV2LoggingOptions(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest) Gets the fine grained logging options.
Requires permission to access the GetV2LoggingOptions action.
- Parameters:
getV2LoggingOptionsRequest
-- Returns:
- A Java Future containing the result of the GetV2LoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- NotConfiguredException The resource is not configured.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getV2LoggingOptions
default CompletableFuture<GetV2LoggingOptionsResponse> getV2LoggingOptions(Consumer<GetV2LoggingOptionsRequest.Builder> getV2LoggingOptionsRequest) Gets the fine grained logging options.
Requires permission to access the GetV2LoggingOptions action.
This is a convenience which creates an instance of the
GetV2LoggingOptionsRequest.Builder
avoiding the need to create one manually viaGetV2LoggingOptionsRequest.builder()
- Parameters:
getV2LoggingOptionsRequest
- AConsumer
that will call methods onGetV2LoggingOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetV2LoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- NotConfiguredException The resource is not configured.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listActiveViolations
default CompletableFuture<ListActiveViolationsResponse> listActiveViolations(ListActiveViolationsRequest listActiveViolationsRequest) Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
- Parameters:
listActiveViolationsRequest
-- Returns:
- A Java Future containing the result of the ListActiveViolations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listActiveViolations
default CompletableFuture<ListActiveViolationsResponse> listActiveViolations(Consumer<ListActiveViolationsRequest.Builder> listActiveViolationsRequest) Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
This is a convenience which creates an instance of the
ListActiveViolationsRequest.Builder
avoiding the need to create one manually viaListActiveViolationsRequest.builder()
- Parameters:
listActiveViolationsRequest
- AConsumer
that will call methods onListActiveViolationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListActiveViolations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listActiveViolations
Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
- Returns:
- A Java Future containing the result of the ListActiveViolations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listActiveViolationsPaginator
This is a variant of
listActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListActiveViolationsPublisher publisher = client.listActiveViolationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListActiveViolationsPublisher publisher = client.listActiveViolationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListActiveViolationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListActiveViolationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listActiveViolationsPaginator
default ListActiveViolationsPublisher listActiveViolationsPaginator(ListActiveViolationsRequest listActiveViolationsRequest) This is a variant of
listActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListActiveViolationsPublisher publisher = client.listActiveViolationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListActiveViolationsPublisher publisher = client.listActiveViolationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListActiveViolationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListActiveViolationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation.- Parameters:
listActiveViolationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listActiveViolationsPaginator
default ListActiveViolationsPublisher listActiveViolationsPaginator(Consumer<ListActiveViolationsRequest.Builder> listActiveViolationsRequest) This is a variant of
listActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListActiveViolationsPublisher publisher = client.listActiveViolationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListActiveViolationsPublisher publisher = client.listActiveViolationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListActiveViolationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListActiveViolationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation.
This is a convenience which creates an instance of the
ListActiveViolationsRequest.Builder
avoiding the need to create one manually viaListActiveViolationsRequest.builder()
- Parameters:
listActiveViolationsRequest
- AConsumer
that will call methods onListActiveViolationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAttachedPolicies
default CompletableFuture<ListAttachedPoliciesResponse> listAttachedPolicies(ListAttachedPoliciesRequest listAttachedPoliciesRequest) Lists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
- Parameters:
listAttachedPoliciesRequest
-- Returns:
- A Java Future containing the result of the ListAttachedPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAttachedPolicies
default CompletableFuture<ListAttachedPoliciesResponse> listAttachedPolicies(Consumer<ListAttachedPoliciesRequest.Builder> listAttachedPoliciesRequest) Lists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
This is a convenience which creates an instance of the
ListAttachedPoliciesRequest.Builder
avoiding the need to create one manually viaListAttachedPoliciesRequest.builder()
- Parameters:
listAttachedPoliciesRequest
- AConsumer
that will call methods onListAttachedPoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAttachedPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAttachedPoliciesPaginator
default ListAttachedPoliciesPublisher listAttachedPoliciesPaginator(ListAttachedPoliciesRequest listAttachedPoliciesRequest) This is a variant of
listAttachedPolicies(software.amazon.awssdk.services.iot.model.ListAttachedPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAttachedPoliciesPublisher publisher = client.listAttachedPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAttachedPoliciesPublisher publisher = client.listAttachedPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAttachedPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAttachedPoliciesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttachedPolicies(software.amazon.awssdk.services.iot.model.ListAttachedPoliciesRequest)
operation.- Parameters:
listAttachedPoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAttachedPoliciesPaginator
default ListAttachedPoliciesPublisher listAttachedPoliciesPaginator(Consumer<ListAttachedPoliciesRequest.Builder> listAttachedPoliciesRequest) This is a variant of
listAttachedPolicies(software.amazon.awssdk.services.iot.model.ListAttachedPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAttachedPoliciesPublisher publisher = client.listAttachedPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAttachedPoliciesPublisher publisher = client.listAttachedPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAttachedPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAttachedPoliciesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttachedPolicies(software.amazon.awssdk.services.iot.model.ListAttachedPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListAttachedPoliciesRequest.Builder
avoiding the need to create one manually viaListAttachedPoliciesRequest.builder()
- Parameters:
listAttachedPoliciesRequest
- AConsumer
that will call methods onListAttachedPoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditFindings
default CompletableFuture<ListAuditFindingsResponse> 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.
- Parameters:
listAuditFindingsRequest
-- Returns:
- A Java Future containing the result of the ListAuditFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditFindings
default CompletableFuture<ListAuditFindingsResponse> listAuditFindings(Consumer<ListAuditFindingsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListAuditFindingsRequest.Builder
avoiding the need to create one manually viaListAuditFindingsRequest.builder()
- Parameters:
listAuditFindingsRequest
- AConsumer
that will call methods onListAuditFindingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAuditFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditFindingsPaginator
default ListAuditFindingsPublisher listAuditFindingsPaginator(ListAuditFindingsRequest listAuditFindingsRequest) This is a variant of
listAuditFindings(software.amazon.awssdk.services.iot.model.ListAuditFindingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuditFindingsPublisher publisher = client.listAuditFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuditFindingsPublisher publisher = client.listAuditFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuditFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuditFindingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuditFindings(software.amazon.awssdk.services.iot.model.ListAuditFindingsRequest)
operation.- Parameters:
listAuditFindingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditFindingsPaginator
default ListAuditFindingsPublisher listAuditFindingsPaginator(Consumer<ListAuditFindingsRequest.Builder> listAuditFindingsRequest) This is a variant of
listAuditFindings(software.amazon.awssdk.services.iot.model.ListAuditFindingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuditFindingsPublisher publisher = client.listAuditFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuditFindingsPublisher publisher = client.listAuditFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuditFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuditFindingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuditFindings(software.amazon.awssdk.services.iot.model.ListAuditFindingsRequest)
operation.
This is a convenience which creates an instance of the
ListAuditFindingsRequest.Builder
avoiding the need to create one manually viaListAuditFindingsRequest.builder()
- Parameters:
listAuditFindingsRequest
- AConsumer
that will call methods onListAuditFindingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditMitigationActionsExecutions
default CompletableFuture<ListAuditMitigationActionsExecutionsResponse> listAuditMitigationActionsExecutions(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest) Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
- Parameters:
listAuditMitigationActionsExecutionsRequest
-- Returns:
- A Java Future containing the result of the ListAuditMitigationActionsExecutions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditMitigationActionsExecutions
default CompletableFuture<ListAuditMitigationActionsExecutionsResponse> listAuditMitigationActionsExecutions(Consumer<ListAuditMitigationActionsExecutionsRequest.Builder> listAuditMitigationActionsExecutionsRequest) Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
This is a convenience which creates an instance of the
ListAuditMitigationActionsExecutionsRequest.Builder
avoiding the need to create one manually viaListAuditMitigationActionsExecutionsRequest.builder()
- Parameters:
listAuditMitigationActionsExecutionsRequest
- AConsumer
that will call methods onListAuditMitigationActionsExecutionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAuditMitigationActionsExecutions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditMitigationActionsExecutionsPaginator
default ListAuditMitigationActionsExecutionsPublisher listAuditMitigationActionsExecutionsPaginator(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest) This is a variant of
listAuditMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsExecutionsPublisher publisher = client.listAuditMitigationActionsExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsExecutionsPublisher publisher = client.listAuditMitigationActionsExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuditMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsRequest)
operation.- Parameters:
listAuditMitigationActionsExecutionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditMitigationActionsExecutionsPaginator
default ListAuditMitigationActionsExecutionsPublisher listAuditMitigationActionsExecutionsPaginator(Consumer<ListAuditMitigationActionsExecutionsRequest.Builder> listAuditMitigationActionsExecutionsRequest) This is a variant of
listAuditMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsExecutionsPublisher publisher = client.listAuditMitigationActionsExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsExecutionsPublisher publisher = client.listAuditMitigationActionsExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuditMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsRequest)
operation.
This is a convenience which creates an instance of the
ListAuditMitigationActionsExecutionsRequest.Builder
avoiding the need to create one manually viaListAuditMitigationActionsExecutionsRequest.builder()
- Parameters:
listAuditMitigationActionsExecutionsRequest
- AConsumer
that will call methods onListAuditMitigationActionsExecutionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditMitigationActionsTasks
default CompletableFuture<ListAuditMitigationActionsTasksResponse> listAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest) Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
- Parameters:
listAuditMitigationActionsTasksRequest
-- Returns:
- A Java Future containing the result of the ListAuditMitigationActionsTasks operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditMitigationActionsTasks
default CompletableFuture<ListAuditMitigationActionsTasksResponse> listAuditMitigationActionsTasks(Consumer<ListAuditMitigationActionsTasksRequest.Builder> listAuditMitigationActionsTasksRequest) Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
This is a convenience which creates an instance of the
ListAuditMitigationActionsTasksRequest.Builder
avoiding the need to create one manually viaListAuditMitigationActionsTasksRequest.builder()
- Parameters:
listAuditMitigationActionsTasksRequest
- AConsumer
that will call methods onListAuditMitigationActionsTasksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAuditMitigationActionsTasks operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditMitigationActionsTasksPaginator
default ListAuditMitigationActionsTasksPublisher listAuditMitigationActionsTasksPaginator(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest) This is a variant of
listAuditMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsTasksPublisher publisher = client.listAuditMitigationActionsTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsTasksPublisher publisher = client.listAuditMitigationActionsTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuditMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksRequest)
operation.- Parameters:
listAuditMitigationActionsTasksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditMitigationActionsTasksPaginator
default ListAuditMitigationActionsTasksPublisher listAuditMitigationActionsTasksPaginator(Consumer<ListAuditMitigationActionsTasksRequest.Builder> listAuditMitigationActionsTasksRequest) This is a variant of
listAuditMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsTasksPublisher publisher = client.listAuditMitigationActionsTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsTasksPublisher publisher = client.listAuditMitigationActionsTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuditMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksRequest)
operation.
This is a convenience which creates an instance of the
ListAuditMitigationActionsTasksRequest.Builder
avoiding the need to create one manually viaListAuditMitigationActionsTasksRequest.builder()
- Parameters:
listAuditMitigationActionsTasksRequest
- AConsumer
that will call methods onListAuditMitigationActionsTasksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditSuppressions
default CompletableFuture<ListAuditSuppressionsResponse> listAuditSuppressions(ListAuditSuppressionsRequest listAuditSuppressionsRequest) Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
- Parameters:
listAuditSuppressionsRequest
-- Returns:
- A Java Future containing the result of the ListAuditSuppressions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditSuppressions
default CompletableFuture<ListAuditSuppressionsResponse> listAuditSuppressions(Consumer<ListAuditSuppressionsRequest.Builder> listAuditSuppressionsRequest) Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
This is a convenience which creates an instance of the
ListAuditSuppressionsRequest.Builder
avoiding the need to create one manually viaListAuditSuppressionsRequest.builder()
- Parameters:
listAuditSuppressionsRequest
- AConsumer
that will call methods onListAuditSuppressionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAuditSuppressions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditSuppressionsPaginator
default ListAuditSuppressionsPublisher listAuditSuppressionsPaginator(ListAuditSuppressionsRequest listAuditSuppressionsRequest) This is a variant of
listAuditSuppressions(software.amazon.awssdk.services.iot.model.ListAuditSuppressionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuditSuppressionsPublisher publisher = client.listAuditSuppressionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuditSuppressionsPublisher publisher = client.listAuditSuppressionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuditSuppressionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuditSuppressionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuditSuppressions(software.amazon.awssdk.services.iot.model.ListAuditSuppressionsRequest)
operation.- Parameters:
listAuditSuppressionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditSuppressionsPaginator
default ListAuditSuppressionsPublisher listAuditSuppressionsPaginator(Consumer<ListAuditSuppressionsRequest.Builder> listAuditSuppressionsRequest) This is a variant of
listAuditSuppressions(software.amazon.awssdk.services.iot.model.ListAuditSuppressionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuditSuppressionsPublisher publisher = client.listAuditSuppressionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuditSuppressionsPublisher publisher = client.listAuditSuppressionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuditSuppressionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuditSuppressionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuditSuppressions(software.amazon.awssdk.services.iot.model.ListAuditSuppressionsRequest)
operation.
This is a convenience which creates an instance of the
ListAuditSuppressionsRequest.Builder
avoiding the need to create one manually viaListAuditSuppressionsRequest.builder()
- Parameters:
listAuditSuppressionsRequest
- AConsumer
that will call methods onListAuditSuppressionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditTasks
default CompletableFuture<ListAuditTasksResponse> listAuditTasks(ListAuditTasksRequest listAuditTasksRequest) Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
- Parameters:
listAuditTasksRequest
-- Returns:
- A Java Future containing the result of the ListAuditTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditTasks
default CompletableFuture<ListAuditTasksResponse> listAuditTasks(Consumer<ListAuditTasksRequest.Builder> listAuditTasksRequest) Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
This is a convenience which creates an instance of the
ListAuditTasksRequest.Builder
avoiding the need to create one manually viaListAuditTasksRequest.builder()
- Parameters:
listAuditTasksRequest
- AConsumer
that will call methods onListAuditTasksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAuditTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditTasksPaginator
default ListAuditTasksPublisher listAuditTasksPaginator(ListAuditTasksRequest listAuditTasksRequest) This is a variant of
listAuditTasks(software.amazon.awssdk.services.iot.model.ListAuditTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuditTasksPublisher publisher = client.listAuditTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuditTasksPublisher publisher = client.listAuditTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuditTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuditTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuditTasks(software.amazon.awssdk.services.iot.model.ListAuditTasksRequest)
operation.- Parameters:
listAuditTasksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuditTasksPaginator
default ListAuditTasksPublisher listAuditTasksPaginator(Consumer<ListAuditTasksRequest.Builder> listAuditTasksRequest) This is a variant of
listAuditTasks(software.amazon.awssdk.services.iot.model.ListAuditTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuditTasksPublisher publisher = client.listAuditTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuditTasksPublisher publisher = client.listAuditTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuditTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuditTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuditTasks(software.amazon.awssdk.services.iot.model.ListAuditTasksRequest)
operation.
This is a convenience which creates an instance of the
ListAuditTasksRequest.Builder
avoiding the need to create one manually viaListAuditTasksRequest.builder()
- Parameters:
listAuditTasksRequest
- AConsumer
that will call methods onListAuditTasksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuthorizers
default CompletableFuture<ListAuthorizersResponse> listAuthorizers(ListAuthorizersRequest listAuthorizersRequest) Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
- Parameters:
listAuthorizersRequest
-- Returns:
- A Java Future containing the result of the ListAuthorizers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuthorizers
default CompletableFuture<ListAuthorizersResponse> listAuthorizers(Consumer<ListAuthorizersRequest.Builder> listAuthorizersRequest) Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
This is a convenience which creates an instance of the
ListAuthorizersRequest.Builder
avoiding the need to create one manually viaListAuthorizersRequest.builder()
- Parameters:
listAuthorizersRequest
- AConsumer
that will call methods onListAuthorizersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAuthorizers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuthorizers
Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
- Returns:
- A Java Future containing the result of the ListAuthorizers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuthorizersPaginator
This is a variant of
listAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuthorizersPublisher publisher = client.listAuthorizersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuthorizersPublisher publisher = client.listAuthorizersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuthorizersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuthorizersResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuthorizersPaginator
default ListAuthorizersPublisher listAuthorizersPaginator(ListAuthorizersRequest listAuthorizersRequest) This is a variant of
listAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuthorizersPublisher publisher = client.listAuthorizersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuthorizersPublisher publisher = client.listAuthorizersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuthorizersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuthorizersResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation.- Parameters:
listAuthorizersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listAuthorizersPaginator
default ListAuthorizersPublisher listAuthorizersPaginator(Consumer<ListAuthorizersRequest.Builder> listAuthorizersRequest) This is a variant of
listAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListAuthorizersPublisher publisher = client.listAuthorizersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListAuthorizersPublisher publisher = client.listAuthorizersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListAuthorizersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListAuthorizersResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation.
This is a convenience which creates an instance of the
ListAuthorizersRequest.Builder
avoiding the need to create one manually viaListAuthorizersRequest.builder()
- Parameters:
listAuthorizersRequest
- AConsumer
that will call methods onListAuthorizersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listBillingGroups
default CompletableFuture<ListBillingGroupsResponse> listBillingGroups(ListBillingGroupsRequest listBillingGroupsRequest) Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
- Parameters:
listBillingGroupsRequest
-- Returns:
- A Java Future containing the result of the ListBillingGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listBillingGroups
default CompletableFuture<ListBillingGroupsResponse> listBillingGroups(Consumer<ListBillingGroupsRequest.Builder> listBillingGroupsRequest) Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
This is a convenience which creates an instance of the
ListBillingGroupsRequest.Builder
avoiding the need to create one manually viaListBillingGroupsRequest.builder()
- Parameters:
listBillingGroupsRequest
- AConsumer
that will call methods onListBillingGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListBillingGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listBillingGroups
Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
- Returns:
- A Java Future containing the result of the ListBillingGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listBillingGroupsPaginator
This is a variant of
listBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListBillingGroupsPublisher publisher = client.listBillingGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListBillingGroupsPublisher publisher = client.listBillingGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListBillingGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListBillingGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listBillingGroupsPaginator
default ListBillingGroupsPublisher listBillingGroupsPaginator(ListBillingGroupsRequest listBillingGroupsRequest) This is a variant of
listBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListBillingGroupsPublisher publisher = client.listBillingGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListBillingGroupsPublisher publisher = client.listBillingGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListBillingGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListBillingGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation.- Parameters:
listBillingGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listBillingGroupsPaginator
default ListBillingGroupsPublisher listBillingGroupsPaginator(Consumer<ListBillingGroupsRequest.Builder> listBillingGroupsRequest) This is a variant of
listBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListBillingGroupsPublisher publisher = client.listBillingGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListBillingGroupsPublisher publisher = client.listBillingGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListBillingGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListBillingGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListBillingGroupsRequest.Builder
avoiding the need to create one manually viaListBillingGroupsRequest.builder()
- Parameters:
listBillingGroupsRequest
- AConsumer
that will call methods onListBillingGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCACertificates
default CompletableFuture<ListCaCertificatesResponse> 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.
- Parameters:
listCaCertificatesRequest
- Input for the ListCACertificates operation.- Returns:
- A Java Future containing the result of the ListCACertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCACertificates
default CompletableFuture<ListCaCertificatesResponse> listCACertificates(Consumer<ListCaCertificatesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListCaCertificatesRequest.Builder
avoiding the need to create one manually viaListCaCertificatesRequest.builder()
- Parameters:
listCaCertificatesRequest
- AConsumer
that will call methods onListCaCertificatesRequest.Builder
to create a request. Input for the ListCACertificates operation.- Returns:
- A Java Future containing the result of the ListCACertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCACertificates
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.
- Returns:
- A Java Future containing the result of the ListCACertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCACertificatesPaginator
This is a variant of
listCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListCACertificatesPublisher publisher = client.listCACertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListCACertificatesPublisher publisher = client.listCACertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListCaCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListCaCertificatesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCACertificatesPaginator
default ListCACertificatesPublisher listCACertificatesPaginator(ListCaCertificatesRequest listCaCertificatesRequest) This is a variant of
listCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListCACertificatesPublisher publisher = client.listCACertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListCACertificatesPublisher publisher = client.listCACertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListCaCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListCaCertificatesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation.- Parameters:
listCaCertificatesRequest
- Input for the ListCACertificates operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCACertificatesPaginator
default ListCACertificatesPublisher listCACertificatesPaginator(Consumer<ListCaCertificatesRequest.Builder> listCaCertificatesRequest) This is a variant of
listCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListCACertificatesPublisher publisher = client.listCACertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListCACertificatesPublisher publisher = client.listCACertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListCaCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListCaCertificatesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation.
This is a convenience which creates an instance of the
ListCaCertificatesRequest.Builder
avoiding the need to create one manually viaListCaCertificatesRequest.builder()
- Parameters:
listCaCertificatesRequest
- AConsumer
that will call methods onListCaCertificatesRequest.Builder
to create a request. Input for the ListCACertificates operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificateProviders
default CompletableFuture<ListCertificateProvidersResponse> listCertificateProviders(ListCertificateProvidersRequest listCertificateProvidersRequest) Lists all your certificate providers in your Amazon Web Services account.
Requires permission to access the ListCertificateProviders action.
- Parameters:
listCertificateProvidersRequest
-- Returns:
- A Java Future containing the result of the ListCertificateProviders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificateProviders
default CompletableFuture<ListCertificateProvidersResponse> listCertificateProviders(Consumer<ListCertificateProvidersRequest.Builder> listCertificateProvidersRequest) Lists all your certificate providers in your Amazon Web Services account.
Requires permission to access the ListCertificateProviders action.
This is a convenience which creates an instance of the
ListCertificateProvidersRequest.Builder
avoiding the need to create one manually viaListCertificateProvidersRequest.builder()
- Parameters:
listCertificateProvidersRequest
- AConsumer
that will call methods onListCertificateProvidersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCertificateProviders operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificates
default CompletableFuture<ListCertificatesResponse> 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.
- Parameters:
listCertificatesRequest
- The input for the ListCertificates operation.- Returns:
- A Java Future containing the result of the ListCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificates
default CompletableFuture<ListCertificatesResponse> listCertificates(Consumer<ListCertificatesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListCertificatesRequest.Builder
avoiding the need to create one manually viaListCertificatesRequest.builder()
- Parameters:
listCertificatesRequest
- AConsumer
that will call methods onListCertificatesRequest.Builder
to create a request. The input for the ListCertificates operation.- Returns:
- A Java Future containing the result of the ListCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificates
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.
- Returns:
- A Java Future containing the result of the ListCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificatesByCA
default CompletableFuture<ListCertificatesByCaResponse> listCertificatesByCA(ListCertificatesByCaRequest listCertificatesByCaRequest) List the device certificates signed by the specified CA certificate.
Requires permission to access the ListCertificatesByCA action.
- Parameters:
listCertificatesByCaRequest
- The input to the ListCertificatesByCA operation.- Returns:
- A Java Future containing the result of the ListCertificatesByCA operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificatesByCA
default CompletableFuture<ListCertificatesByCaResponse> listCertificatesByCA(Consumer<ListCertificatesByCaRequest.Builder> listCertificatesByCaRequest) List the device certificates signed by the specified CA certificate.
Requires permission to access the ListCertificatesByCA action.
This is a convenience which creates an instance of the
ListCertificatesByCaRequest.Builder
avoiding the need to create one manually viaListCertificatesByCaRequest.builder()
- Parameters:
listCertificatesByCaRequest
- AConsumer
that will call methods onListCertificatesByCaRequest.Builder
to create a request. The input to the ListCertificatesByCA operation.- Returns:
- A Java Future containing the result of the ListCertificatesByCA operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificatesByCAPaginator
default ListCertificatesByCAPublisher listCertificatesByCAPaginator(ListCertificatesByCaRequest listCertificatesByCaRequest) This is a variant of
listCertificatesByCA(software.amazon.awssdk.services.iot.model.ListCertificatesByCaRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListCertificatesByCAPublisher publisher = client.listCertificatesByCAPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListCertificatesByCAPublisher publisher = client.listCertificatesByCAPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListCertificatesByCaResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListCertificatesByCaResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificatesByCA(software.amazon.awssdk.services.iot.model.ListCertificatesByCaRequest)
operation.- Parameters:
listCertificatesByCaRequest
- The input to the ListCertificatesByCA operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificatesByCAPaginator
default ListCertificatesByCAPublisher listCertificatesByCAPaginator(Consumer<ListCertificatesByCaRequest.Builder> listCertificatesByCaRequest) This is a variant of
listCertificatesByCA(software.amazon.awssdk.services.iot.model.ListCertificatesByCaRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListCertificatesByCAPublisher publisher = client.listCertificatesByCAPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListCertificatesByCAPublisher publisher = client.listCertificatesByCAPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListCertificatesByCaResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListCertificatesByCaResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificatesByCA(software.amazon.awssdk.services.iot.model.ListCertificatesByCaRequest)
operation.
This is a convenience which creates an instance of the
ListCertificatesByCaRequest.Builder
avoiding the need to create one manually viaListCertificatesByCaRequest.builder()
- Parameters:
listCertificatesByCaRequest
- AConsumer
that will call methods onListCertificatesByCaRequest.Builder
to create a request. The input to the ListCertificatesByCA operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificatesPaginator
This is a variant of
listCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListCertificatesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificatesPaginator
default ListCertificatesPublisher listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) This is a variant of
listCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListCertificatesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation.- Parameters:
listCertificatesRequest
- The input for the ListCertificates operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCertificatesPaginator
default ListCertificatesPublisher listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) This is a variant of
listCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListCertificatesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation.
This is a convenience which creates an instance of the
ListCertificatesRequest.Builder
avoiding the need to create one manually viaListCertificatesRequest.builder()
- Parameters:
listCertificatesRequest
- AConsumer
that will call methods onListCertificatesRequest.Builder
to create a request. The input for the ListCertificates operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCustomMetrics
default CompletableFuture<ListCustomMetricsResponse> listCustomMetrics(ListCustomMetricsRequest listCustomMetricsRequest) Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
- Parameters:
listCustomMetricsRequest
-- Returns:
- A Java Future containing the result of the ListCustomMetrics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCustomMetrics
default CompletableFuture<ListCustomMetricsResponse> listCustomMetrics(Consumer<ListCustomMetricsRequest.Builder> listCustomMetricsRequest) Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
This is a convenience which creates an instance of the
ListCustomMetricsRequest.Builder
avoiding the need to create one manually viaListCustomMetricsRequest.builder()
- Parameters:
listCustomMetricsRequest
- AConsumer
that will call methods onListCustomMetricsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCustomMetrics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCustomMetricsPaginator
default ListCustomMetricsPublisher listCustomMetricsPaginator(ListCustomMetricsRequest listCustomMetricsRequest) This is a variant of
listCustomMetrics(software.amazon.awssdk.services.iot.model.ListCustomMetricsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListCustomMetricsPublisher publisher = client.listCustomMetricsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListCustomMetricsPublisher publisher = client.listCustomMetricsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListCustomMetricsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListCustomMetricsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomMetrics(software.amazon.awssdk.services.iot.model.ListCustomMetricsRequest)
operation.- Parameters:
listCustomMetricsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listCustomMetricsPaginator
default ListCustomMetricsPublisher listCustomMetricsPaginator(Consumer<ListCustomMetricsRequest.Builder> listCustomMetricsRequest) This is a variant of
listCustomMetrics(software.amazon.awssdk.services.iot.model.ListCustomMetricsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListCustomMetricsPublisher publisher = client.listCustomMetricsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListCustomMetricsPublisher publisher = client.listCustomMetricsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListCustomMetricsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListCustomMetricsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomMetrics(software.amazon.awssdk.services.iot.model.ListCustomMetricsRequest)
operation.
This is a convenience which creates an instance of the
ListCustomMetricsRequest.Builder
avoiding the need to create one manually viaListCustomMetricsRequest.builder()
- Parameters:
listCustomMetricsRequest
- AConsumer
that will call methods onListCustomMetricsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDetectMitigationActionsExecutions
default CompletableFuture<ListDetectMitigationActionsExecutionsResponse> listDetectMitigationActionsExecutions(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest) Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
- Parameters:
listDetectMitigationActionsExecutionsRequest
-- Returns:
- A Java Future containing the result of the ListDetectMitigationActionsExecutions operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDetectMitigationActionsExecutions
default CompletableFuture<ListDetectMitigationActionsExecutionsResponse> listDetectMitigationActionsExecutions(Consumer<ListDetectMitigationActionsExecutionsRequest.Builder> listDetectMitigationActionsExecutionsRequest) Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
This is a convenience which creates an instance of the
ListDetectMitigationActionsExecutionsRequest.Builder
avoiding the need to create one manually viaListDetectMitigationActionsExecutionsRequest.builder()
- Parameters:
listDetectMitigationActionsExecutionsRequest
- AConsumer
that will call methods onListDetectMitigationActionsExecutionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDetectMitigationActionsExecutions operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDetectMitigationActionsExecutionsPaginator
default ListDetectMitigationActionsExecutionsPublisher listDetectMitigationActionsExecutionsPaginator(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest) This is a variant of
listDetectMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsExecutionsPublisher publisher = client.listDetectMitigationActionsExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsExecutionsPublisher publisher = client.listDetectMitigationActionsExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDetectMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsRequest)
operation.- Parameters:
listDetectMitigationActionsExecutionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDetectMitigationActionsExecutionsPaginator
default ListDetectMitigationActionsExecutionsPublisher listDetectMitigationActionsExecutionsPaginator(Consumer<ListDetectMitigationActionsExecutionsRequest.Builder> listDetectMitigationActionsExecutionsRequest) This is a variant of
listDetectMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsExecutionsPublisher publisher = client.listDetectMitigationActionsExecutionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsExecutionsPublisher publisher = client.listDetectMitigationActionsExecutionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDetectMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsRequest)
operation.
This is a convenience which creates an instance of the
ListDetectMitigationActionsExecutionsRequest.Builder
avoiding the need to create one manually viaListDetectMitigationActionsExecutionsRequest.builder()
- Parameters:
listDetectMitigationActionsExecutionsRequest
- AConsumer
that will call methods onListDetectMitigationActionsExecutionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDetectMitigationActionsTasks
default CompletableFuture<ListDetectMitigationActionsTasksResponse> listDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest) List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
- Parameters:
listDetectMitigationActionsTasksRequest
-- Returns:
- A Java Future containing the result of the ListDetectMitigationActionsTasks operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDetectMitigationActionsTasks
default CompletableFuture<ListDetectMitigationActionsTasksResponse> listDetectMitigationActionsTasks(Consumer<ListDetectMitigationActionsTasksRequest.Builder> listDetectMitigationActionsTasksRequest) List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
This is a convenience which creates an instance of the
ListDetectMitigationActionsTasksRequest.Builder
avoiding the need to create one manually viaListDetectMitigationActionsTasksRequest.builder()
- Parameters:
listDetectMitigationActionsTasksRequest
- AConsumer
that will call methods onListDetectMitigationActionsTasksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDetectMitigationActionsTasks operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDetectMitigationActionsTasksPaginator
default ListDetectMitigationActionsTasksPublisher listDetectMitigationActionsTasksPaginator(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest) This is a variant of
listDetectMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsTasksPublisher publisher = client.listDetectMitigationActionsTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsTasksPublisher publisher = client.listDetectMitigationActionsTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDetectMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksRequest)
operation.- Parameters:
listDetectMitigationActionsTasksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDetectMitigationActionsTasksPaginator
default ListDetectMitigationActionsTasksPublisher listDetectMitigationActionsTasksPaginator(Consumer<ListDetectMitigationActionsTasksRequest.Builder> listDetectMitigationActionsTasksRequest) This is a variant of
listDetectMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsTasksPublisher publisher = client.listDetectMitigationActionsTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsTasksPublisher publisher = client.listDetectMitigationActionsTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDetectMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksRequest)
operation.
This is a convenience which creates an instance of the
ListDetectMitigationActionsTasksRequest.Builder
avoiding the need to create one manually viaListDetectMitigationActionsTasksRequest.builder()
- Parameters:
listDetectMitigationActionsTasksRequest
- AConsumer
that will call methods onListDetectMitigationActionsTasksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDimensions
default CompletableFuture<ListDimensionsResponse> listDimensions(ListDimensionsRequest listDimensionsRequest) List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
- Parameters:
listDimensionsRequest
-- Returns:
- A Java Future containing the result of the ListDimensions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalFailureException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDimensions
default CompletableFuture<ListDimensionsResponse> listDimensions(Consumer<ListDimensionsRequest.Builder> listDimensionsRequest) List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
This is a convenience which creates an instance of the
ListDimensionsRequest.Builder
avoiding the need to create one manually viaListDimensionsRequest.builder()
- Parameters:
listDimensionsRequest
- AConsumer
that will call methods onListDimensionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDimensions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalFailureException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDimensionsPaginator
default ListDimensionsPublisher listDimensionsPaginator(ListDimensionsRequest listDimensionsRequest) This is a variant of
listDimensions(software.amazon.awssdk.services.iot.model.ListDimensionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListDimensionsPublisher publisher = client.listDimensionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListDimensionsPublisher publisher = client.listDimensionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListDimensionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListDimensionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDimensions(software.amazon.awssdk.services.iot.model.ListDimensionsRequest)
operation.- Parameters:
listDimensionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalFailureException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDimensionsPaginator
default ListDimensionsPublisher listDimensionsPaginator(Consumer<ListDimensionsRequest.Builder> listDimensionsRequest) This is a variant of
listDimensions(software.amazon.awssdk.services.iot.model.ListDimensionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListDimensionsPublisher publisher = client.listDimensionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListDimensionsPublisher publisher = client.listDimensionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListDimensionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListDimensionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDimensions(software.amazon.awssdk.services.iot.model.ListDimensionsRequest)
operation.
This is a convenience which creates an instance of the
ListDimensionsRequest.Builder
avoiding the need to create one manually viaListDimensionsRequest.builder()
- Parameters:
listDimensionsRequest
- AConsumer
that will call methods onListDimensionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalFailureException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainConfigurations
default CompletableFuture<ListDomainConfigurationsResponse> 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.
- Parameters:
listDomainConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListDomainConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainConfigurations
default CompletableFuture<ListDomainConfigurationsResponse> listDomainConfigurations(Consumer<ListDomainConfigurationsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListDomainConfigurationsRequest.Builder
avoiding the need to create one manually viaListDomainConfigurationsRequest.builder()
- Parameters:
listDomainConfigurationsRequest
- AConsumer
that will call methods onListDomainConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDomainConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainConfigurationsPaginator
default ListDomainConfigurationsPublisher listDomainConfigurationsPaginator(ListDomainConfigurationsRequest listDomainConfigurationsRequest) This is a variant of
listDomainConfigurations(software.amazon.awssdk.services.iot.model.ListDomainConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListDomainConfigurationsPublisher publisher = client.listDomainConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListDomainConfigurationsPublisher publisher = client.listDomainConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListDomainConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListDomainConfigurationsResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomainConfigurations(software.amazon.awssdk.services.iot.model.ListDomainConfigurationsRequest)
operation.- Parameters:
listDomainConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainConfigurationsPaginator
default ListDomainConfigurationsPublisher listDomainConfigurationsPaginator(Consumer<ListDomainConfigurationsRequest.Builder> listDomainConfigurationsRequest) This is a variant of
listDomainConfigurations(software.amazon.awssdk.services.iot.model.ListDomainConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListDomainConfigurationsPublisher publisher = client.listDomainConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListDomainConfigurationsPublisher publisher = client.listDomainConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListDomainConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListDomainConfigurationsResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomainConfigurations(software.amazon.awssdk.services.iot.model.ListDomainConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
ListDomainConfigurationsRequest.Builder
avoiding the need to create one manually viaListDomainConfigurationsRequest.builder()
- Parameters:
listDomainConfigurationsRequest
- AConsumer
that will call methods onListDomainConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listFleetMetrics
default CompletableFuture<ListFleetMetricsResponse> listFleetMetrics(ListFleetMetricsRequest listFleetMetricsRequest) Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
- Parameters:
listFleetMetricsRequest
-- Returns:
- A Java Future containing the result of the ListFleetMetrics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listFleetMetrics
default CompletableFuture<ListFleetMetricsResponse> listFleetMetrics(Consumer<ListFleetMetricsRequest.Builder> listFleetMetricsRequest) Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
This is a convenience which creates an instance of the
ListFleetMetricsRequest.Builder
avoiding the need to create one manually viaListFleetMetricsRequest.builder()
- Parameters:
listFleetMetricsRequest
- AConsumer
that will call methods onListFleetMetricsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListFleetMetrics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listFleetMetricsPaginator
default ListFleetMetricsPublisher listFleetMetricsPaginator(ListFleetMetricsRequest listFleetMetricsRequest) This is a variant of
listFleetMetrics(software.amazon.awssdk.services.iot.model.ListFleetMetricsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListFleetMetricsPublisher publisher = client.listFleetMetricsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListFleetMetricsPublisher publisher = client.listFleetMetricsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListFleetMetricsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListFleetMetricsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFleetMetrics(software.amazon.awssdk.services.iot.model.ListFleetMetricsRequest)
operation.- Parameters:
listFleetMetricsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listFleetMetricsPaginator
default ListFleetMetricsPublisher listFleetMetricsPaginator(Consumer<ListFleetMetricsRequest.Builder> listFleetMetricsRequest) This is a variant of
listFleetMetrics(software.amazon.awssdk.services.iot.model.ListFleetMetricsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListFleetMetricsPublisher publisher = client.listFleetMetricsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListFleetMetricsPublisher publisher = client.listFleetMetricsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListFleetMetricsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListFleetMetricsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFleetMetrics(software.amazon.awssdk.services.iot.model.ListFleetMetricsRequest)
operation.
This is a convenience which creates an instance of the
ListFleetMetricsRequest.Builder
avoiding the need to create one manually viaListFleetMetricsRequest.builder()
- Parameters:
listFleetMetricsRequest
- AConsumer
that will call methods onListFleetMetricsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listIndices
Lists the search indices.
Requires permission to access the ListIndices action.
- Parameters:
listIndicesRequest
-- Returns:
- A Java Future containing the result of the ListIndices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listIndices
default CompletableFuture<ListIndicesResponse> listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest) Lists the search indices.
Requires permission to access the ListIndices action.
This is a convenience which creates an instance of the
ListIndicesRequest.Builder
avoiding the need to create one manually viaListIndicesRequest.builder()
- Parameters:
listIndicesRequest
- AConsumer
that will call methods onListIndicesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListIndices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listIndices
Lists the search indices.
Requires permission to access the ListIndices action.
- Returns:
- A Java Future containing the result of the ListIndices operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listIndicesPaginator
This is a variant of
listIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListIndicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListIndicesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listIndicesPaginator
This is a variant of
listIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListIndicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListIndicesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation.- Parameters:
listIndicesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listIndicesPaginator
default ListIndicesPublisher listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest) This is a variant of
listIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListIndicesPublisher publisher = client.listIndicesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListIndicesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListIndicesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation.
This is a convenience which creates an instance of the
ListIndicesRequest.Builder
avoiding the need to create one manually viaListIndicesRequest.builder()
- Parameters:
listIndicesRequest
- AConsumer
that will call methods onListIndicesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobExecutionsForJob
default CompletableFuture<ListJobExecutionsForJobResponse> listJobExecutionsForJob(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest) Lists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
- Parameters:
listJobExecutionsForJobRequest
-- Returns:
- A Java Future containing the result of the ListJobExecutionsForJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobExecutionsForJob
default CompletableFuture<ListJobExecutionsForJobResponse> listJobExecutionsForJob(Consumer<ListJobExecutionsForJobRequest.Builder> listJobExecutionsForJobRequest) Lists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
This is a convenience which creates an instance of the
ListJobExecutionsForJobRequest.Builder
avoiding the need to create one manually viaListJobExecutionsForJobRequest.builder()
- Parameters:
listJobExecutionsForJobRequest
- AConsumer
that will call methods onListJobExecutionsForJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListJobExecutionsForJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobExecutionsForJobPaginator
default ListJobExecutionsForJobPublisher listJobExecutionsForJobPaginator(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest) This is a variant of
listJobExecutionsForJob(software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForJobPublisher publisher = client.listJobExecutionsForJobPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListJobExecutionsForJobPublisher publisher = client.listJobExecutionsForJobPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobExecutionsForJob(software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobRequest)
operation.- Parameters:
listJobExecutionsForJobRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobExecutionsForJobPaginator
default ListJobExecutionsForJobPublisher listJobExecutionsForJobPaginator(Consumer<ListJobExecutionsForJobRequest.Builder> listJobExecutionsForJobRequest) This is a variant of
listJobExecutionsForJob(software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForJobPublisher publisher = client.listJobExecutionsForJobPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListJobExecutionsForJobPublisher publisher = client.listJobExecutionsForJobPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobExecutionsForJob(software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobRequest)
operation.
This is a convenience which creates an instance of the
ListJobExecutionsForJobRequest.Builder
avoiding the need to create one manually viaListJobExecutionsForJobRequest.builder()
- Parameters:
listJobExecutionsForJobRequest
- AConsumer
that will call methods onListJobExecutionsForJobRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobExecutionsForThing
default CompletableFuture<ListJobExecutionsForThingResponse> listJobExecutionsForThing(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest) Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
- Parameters:
listJobExecutionsForThingRequest
-- Returns:
- A Java Future containing the result of the ListJobExecutionsForThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobExecutionsForThing
default CompletableFuture<ListJobExecutionsForThingResponse> listJobExecutionsForThing(Consumer<ListJobExecutionsForThingRequest.Builder> listJobExecutionsForThingRequest) Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
This is a convenience which creates an instance of the
ListJobExecutionsForThingRequest.Builder
avoiding the need to create one manually viaListJobExecutionsForThingRequest.builder()
- Parameters:
listJobExecutionsForThingRequest
- AConsumer
that will call methods onListJobExecutionsForThingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListJobExecutionsForThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobExecutionsForThingPaginator
default ListJobExecutionsForThingPublisher listJobExecutionsForThingPaginator(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest) This is a variant of
listJobExecutionsForThing(software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForThingPublisher publisher = client.listJobExecutionsForThingPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListJobExecutionsForThingPublisher publisher = client.listJobExecutionsForThingPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobExecutionsForThing(software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingRequest)
operation.- Parameters:
listJobExecutionsForThingRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobExecutionsForThingPaginator
default ListJobExecutionsForThingPublisher listJobExecutionsForThingPaginator(Consumer<ListJobExecutionsForThingRequest.Builder> listJobExecutionsForThingRequest) This is a variant of
listJobExecutionsForThing(software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForThingPublisher publisher = client.listJobExecutionsForThingPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListJobExecutionsForThingPublisher publisher = client.listJobExecutionsForThingPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobExecutionsForThing(software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingRequest)
operation.
This is a convenience which creates an instance of the
ListJobExecutionsForThingRequest.Builder
avoiding the need to create one manually viaListJobExecutionsForThingRequest.builder()
- Parameters:
listJobExecutionsForThingRequest
- AConsumer
that will call methods onListJobExecutionsForThingRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobTemplates
default CompletableFuture<ListJobTemplatesResponse> listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest) Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
- Parameters:
listJobTemplatesRequest
-- Returns:
- A Java Future containing the result of the ListJobTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobTemplates
default CompletableFuture<ListJobTemplatesResponse> listJobTemplates(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
This is a convenience which creates an instance of the
ListJobTemplatesRequest.Builder
avoiding the need to create one manually viaListJobTemplatesRequest.builder()
- Parameters:
listJobTemplatesRequest
- AConsumer
that will call methods onListJobTemplatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListJobTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobTemplatesPaginator
default ListJobTemplatesPublisher listJobTemplatesPaginator(ListJobTemplatesRequest listJobTemplatesRequest) This is a variant of
listJobTemplates(software.amazon.awssdk.services.iot.model.ListJobTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListJobTemplatesPublisher publisher = client.listJobTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListJobTemplatesPublisher publisher = client.listJobTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListJobTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListJobTemplatesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobTemplates(software.amazon.awssdk.services.iot.model.ListJobTemplatesRequest)
operation.- Parameters:
listJobTemplatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobTemplatesPaginator
default ListJobTemplatesPublisher listJobTemplatesPaginator(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) This is a variant of
listJobTemplates(software.amazon.awssdk.services.iot.model.ListJobTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListJobTemplatesPublisher publisher = client.listJobTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListJobTemplatesPublisher publisher = client.listJobTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListJobTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListJobTemplatesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobTemplates(software.amazon.awssdk.services.iot.model.ListJobTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListJobTemplatesRequest.Builder
avoiding the need to create one manually viaListJobTemplatesRequest.builder()
- Parameters:
listJobTemplatesRequest
- AConsumer
that will call methods onListJobTemplatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobs
Lists jobs.
Requires permission to access the ListJobs action.
- Parameters:
listJobsRequest
-- Returns:
- A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobs
default CompletableFuture<ListJobsResponse> listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) Lists jobs.
Requires permission to access the ListJobs action.
This is a convenience which creates an instance of the
ListJobsRequest.Builder
avoiding the need to create one manually viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobs
Lists jobs.
Requires permission to access the ListJobs action.
- Returns:
- A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobsPaginator
This is a variant of
listJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobsPaginator
This is a variant of
listJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation.- Parameters:
listJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listJobsPaginator
This is a variant of
listJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation.
This is a convenience which creates an instance of the
ListJobsRequest.Builder
avoiding the need to create one manually viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listManagedJobTemplates
default CompletableFuture<ListManagedJobTemplatesResponse> listManagedJobTemplates(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest) Returns a list of managed job templates.
- Parameters:
listManagedJobTemplatesRequest
-- Returns:
- A Java Future containing the result of the ListManagedJobTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listManagedJobTemplates
default CompletableFuture<ListManagedJobTemplatesResponse> listManagedJobTemplates(Consumer<ListManagedJobTemplatesRequest.Builder> listManagedJobTemplatesRequest) Returns a list of managed job templates.
This is a convenience which creates an instance of the
ListManagedJobTemplatesRequest.Builder
avoiding the need to create one manually viaListManagedJobTemplatesRequest.builder()
- Parameters:
listManagedJobTemplatesRequest
- AConsumer
that will call methods onListManagedJobTemplatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListManagedJobTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listManagedJobTemplatesPaginator
default ListManagedJobTemplatesPublisher listManagedJobTemplatesPaginator(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest) This is a variant of
listManagedJobTemplates(software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListManagedJobTemplatesPublisher publisher = client.listManagedJobTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListManagedJobTemplatesPublisher publisher = client.listManagedJobTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedJobTemplates(software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesRequest)
operation.- Parameters:
listManagedJobTemplatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listManagedJobTemplatesPaginator
default ListManagedJobTemplatesPublisher listManagedJobTemplatesPaginator(Consumer<ListManagedJobTemplatesRequest.Builder> listManagedJobTemplatesRequest) This is a variant of
listManagedJobTemplates(software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListManagedJobTemplatesPublisher publisher = client.listManagedJobTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListManagedJobTemplatesPublisher publisher = client.listManagedJobTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedJobTemplates(software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListManagedJobTemplatesRequest.Builder
avoiding the need to create one manually viaListManagedJobTemplatesRequest.builder()
- Parameters:
listManagedJobTemplatesRequest
- AConsumer
that will call methods onListManagedJobTemplatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMetricValues
default CompletableFuture<ListMetricValuesResponse> 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.
- Parameters:
listMetricValuesRequest
-- Returns:
- A Java Future containing the result of the ListMetricValues operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMetricValues
default CompletableFuture<ListMetricValuesResponse> listMetricValues(Consumer<ListMetricValuesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListMetricValuesRequest.Builder
avoiding the need to create one manually viaListMetricValuesRequest.builder()
- Parameters:
listMetricValuesRequest
- AConsumer
that will call methods onListMetricValuesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMetricValues operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMetricValuesPaginator
default ListMetricValuesPublisher listMetricValuesPaginator(ListMetricValuesRequest listMetricValuesRequest) This is a variant of
listMetricValues(software.amazon.awssdk.services.iot.model.ListMetricValuesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListMetricValuesPublisher publisher = client.listMetricValuesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListMetricValuesPublisher publisher = client.listMetricValuesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListMetricValuesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListMetricValuesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMetricValues(software.amazon.awssdk.services.iot.model.ListMetricValuesRequest)
operation.- Parameters:
listMetricValuesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMetricValuesPaginator
default ListMetricValuesPublisher listMetricValuesPaginator(Consumer<ListMetricValuesRequest.Builder> listMetricValuesRequest) This is a variant of
listMetricValues(software.amazon.awssdk.services.iot.model.ListMetricValuesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListMetricValuesPublisher publisher = client.listMetricValuesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListMetricValuesPublisher publisher = client.listMetricValuesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListMetricValuesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListMetricValuesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMetricValues(software.amazon.awssdk.services.iot.model.ListMetricValuesRequest)
operation.
This is a convenience which creates an instance of the
ListMetricValuesRequest.Builder
avoiding the need to create one manually viaListMetricValuesRequest.builder()
- Parameters:
listMetricValuesRequest
- AConsumer
that will call methods onListMetricValuesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMitigationActions
default CompletableFuture<ListMitigationActionsResponse> listMitigationActions(ListMitigationActionsRequest listMitigationActionsRequest) Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
- Parameters:
listMitigationActionsRequest
-- Returns:
- A Java Future containing the result of the ListMitigationActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMitigationActions
default CompletableFuture<ListMitigationActionsResponse> listMitigationActions(Consumer<ListMitigationActionsRequest.Builder> listMitigationActionsRequest) Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
This is a convenience which creates an instance of the
ListMitigationActionsRequest.Builder
avoiding the need to create one manually viaListMitigationActionsRequest.builder()
- Parameters:
listMitigationActionsRequest
- AConsumer
that will call methods onListMitigationActionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMitigationActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMitigationActionsPaginator
default ListMitigationActionsPublisher listMitigationActionsPaginator(ListMitigationActionsRequest listMitigationActionsRequest) This is a variant of
listMitigationActions(software.amazon.awssdk.services.iot.model.ListMitigationActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListMitigationActionsPublisher publisher = client.listMitigationActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListMitigationActionsPublisher publisher = client.listMitigationActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListMitigationActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListMitigationActionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMitigationActions(software.amazon.awssdk.services.iot.model.ListMitigationActionsRequest)
operation.- Parameters:
listMitigationActionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listMitigationActionsPaginator
default ListMitigationActionsPublisher listMitigationActionsPaginator(Consumer<ListMitigationActionsRequest.Builder> listMitigationActionsRequest) This is a variant of
listMitigationActions(software.amazon.awssdk.services.iot.model.ListMitigationActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListMitigationActionsPublisher publisher = client.listMitigationActionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListMitigationActionsPublisher publisher = client.listMitigationActionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListMitigationActionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListMitigationActionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMitigationActions(software.amazon.awssdk.services.iot.model.ListMitigationActionsRequest)
operation.
This is a convenience which creates an instance of the
ListMitigationActionsRequest.Builder
avoiding the need to create one manually viaListMitigationActionsRequest.builder()
- Parameters:
listMitigationActionsRequest
- AConsumer
that will call methods onListMitigationActionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOTAUpdates
default CompletableFuture<ListOtaUpdatesResponse> listOTAUpdates(ListOtaUpdatesRequest listOtaUpdatesRequest) Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
- Parameters:
listOtaUpdatesRequest
-- Returns:
- A Java Future containing the result of the ListOTAUpdates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOTAUpdates
default CompletableFuture<ListOtaUpdatesResponse> listOTAUpdates(Consumer<ListOtaUpdatesRequest.Builder> listOtaUpdatesRequest) Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
This is a convenience which creates an instance of the
ListOtaUpdatesRequest.Builder
avoiding the need to create one manually viaListOtaUpdatesRequest.builder()
- Parameters:
listOtaUpdatesRequest
- AConsumer
that will call methods onListOtaUpdatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOTAUpdates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOTAUpdates
Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
- Returns:
- A Java Future containing the result of the ListOTAUpdates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOTAUpdatesPaginator
This is a variant of
listOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListOTAUpdatesPublisher publisher = client.listOTAUpdatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListOTAUpdatesPublisher publisher = client.listOTAUpdatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListOtaUpdatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListOtaUpdatesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOTAUpdatesPaginator
default ListOTAUpdatesPublisher listOTAUpdatesPaginator(ListOtaUpdatesRequest listOtaUpdatesRequest) This is a variant of
listOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListOTAUpdatesPublisher publisher = client.listOTAUpdatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListOTAUpdatesPublisher publisher = client.listOTAUpdatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListOtaUpdatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListOtaUpdatesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation.- Parameters:
listOtaUpdatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOTAUpdatesPaginator
default ListOTAUpdatesPublisher listOTAUpdatesPaginator(Consumer<ListOtaUpdatesRequest.Builder> listOtaUpdatesRequest) This is a variant of
listOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListOTAUpdatesPublisher publisher = client.listOTAUpdatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListOTAUpdatesPublisher publisher = client.listOTAUpdatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListOtaUpdatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListOtaUpdatesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation.
This is a convenience which creates an instance of the
ListOtaUpdatesRequest.Builder
avoiding the need to create one manually viaListOtaUpdatesRequest.builder()
- Parameters:
listOtaUpdatesRequest
- AConsumer
that will call methods onListOtaUpdatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOutgoingCertificates
default CompletableFuture<ListOutgoingCertificatesResponse> listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
- Parameters:
listOutgoingCertificatesRequest
- The input to the ListOutgoingCertificates operation.- Returns:
- A Java Future containing the result of the ListOutgoingCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOutgoingCertificates
default CompletableFuture<ListOutgoingCertificatesResponse> listOutgoingCertificates(Consumer<ListOutgoingCertificatesRequest.Builder> listOutgoingCertificatesRequest) Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
This is a convenience which creates an instance of the
ListOutgoingCertificatesRequest.Builder
avoiding the need to create one manually viaListOutgoingCertificatesRequest.builder()
- Parameters:
listOutgoingCertificatesRequest
- AConsumer
that will call methods onListOutgoingCertificatesRequest.Builder
to create a request. The input to the ListOutgoingCertificates operation.- Returns:
- A Java Future containing the result of the ListOutgoingCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOutgoingCertificates
Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
- Returns:
- A Java Future containing the result of the ListOutgoingCertificates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOutgoingCertificatesPaginator
This is a variant of
listOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesPublisher publisher = client.listOutgoingCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesPublisher publisher = client.listOutgoingCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOutgoingCertificatesPaginator
default ListOutgoingCertificatesPublisher listOutgoingCertificatesPaginator(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) This is a variant of
listOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesPublisher publisher = client.listOutgoingCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesPublisher publisher = client.listOutgoingCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation.- Parameters:
listOutgoingCertificatesRequest
- The input to the ListOutgoingCertificates operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listOutgoingCertificatesPaginator
default ListOutgoingCertificatesPublisher listOutgoingCertificatesPaginator(Consumer<ListOutgoingCertificatesRequest.Builder> listOutgoingCertificatesRequest) This is a variant of
listOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesPublisher publisher = client.listOutgoingCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesPublisher publisher = client.listOutgoingCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation.
This is a convenience which creates an instance of the
ListOutgoingCertificatesRequest.Builder
avoiding the need to create one manually viaListOutgoingCertificatesRequest.builder()
- Parameters:
listOutgoingCertificatesRequest
- AConsumer
that will call methods onListOutgoingCertificatesRequest.Builder
to create a request. The input to the ListOutgoingCertificates operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackageVersions
default CompletableFuture<ListPackageVersionsResponse> listPackageVersions(ListPackageVersionsRequest listPackageVersionsRequest) Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
- Parameters:
listPackageVersionsRequest
-- Returns:
- A Java Future containing the result of the ListPackageVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackageVersions
default CompletableFuture<ListPackageVersionsResponse> listPackageVersions(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest) Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
This is a convenience which creates an instance of the
ListPackageVersionsRequest.Builder
avoiding the need to create one manually viaListPackageVersionsRequest.builder()
- Parameters:
listPackageVersionsRequest
- AConsumer
that will call methods onListPackageVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPackageVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackageVersionsPaginator
default ListPackageVersionsPublisher listPackageVersionsPaginator(ListPackageVersionsRequest listPackageVersionsRequest) This is a variant of
listPackageVersions(software.amazon.awssdk.services.iot.model.ListPackageVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListPackageVersionsPublisher publisher = client.listPackageVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListPackageVersionsPublisher publisher = client.listPackageVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListPackageVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListPackageVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackageVersions(software.amazon.awssdk.services.iot.model.ListPackageVersionsRequest)
operation.- Parameters:
listPackageVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackageVersionsPaginator
default ListPackageVersionsPublisher listPackageVersionsPaginator(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest) This is a variant of
listPackageVersions(software.amazon.awssdk.services.iot.model.ListPackageVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListPackageVersionsPublisher publisher = client.listPackageVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListPackageVersionsPublisher publisher = client.listPackageVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListPackageVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListPackageVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackageVersions(software.amazon.awssdk.services.iot.model.ListPackageVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListPackageVersionsRequest.Builder
avoiding the need to create one manually viaListPackageVersionsRequest.builder()
- Parameters:
listPackageVersionsRequest
- AConsumer
that will call methods onListPackageVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackages
default CompletableFuture<ListPackagesResponse> listPackages(ListPackagesRequest listPackagesRequest) Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
- Parameters:
listPackagesRequest
-- Returns:
- A Java Future containing the result of the ListPackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackages
default CompletableFuture<ListPackagesResponse> listPackages(Consumer<ListPackagesRequest.Builder> listPackagesRequest) Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
This is a convenience which creates an instance of the
ListPackagesRequest.Builder
avoiding the need to create one manually viaListPackagesRequest.builder()
- Parameters:
listPackagesRequest
- AConsumer
that will call methods onListPackagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackagesPaginator
This is a variant of
listPackages(software.amazon.awssdk.services.iot.model.ListPackagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListPackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListPackagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackages(software.amazon.awssdk.services.iot.model.ListPackagesRequest)
operation.- Parameters:
listPackagesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackagesPaginator
default ListPackagesPublisher listPackagesPaginator(Consumer<ListPackagesRequest.Builder> listPackagesRequest) This is a variant of
listPackages(software.amazon.awssdk.services.iot.model.ListPackagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListPackagesPublisher publisher = client.listPackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListPackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListPackagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackages(software.amazon.awssdk.services.iot.model.ListPackagesRequest)
operation.
This is a convenience which creates an instance of the
ListPackagesRequest.Builder
avoiding the need to create one manually viaListPackagesRequest.builder()
- Parameters:
listPackagesRequest
- AConsumer
that will call methods onListPackagesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPolicies
default CompletableFuture<ListPoliciesResponse> listPolicies(ListPoliciesRequest listPoliciesRequest) Lists your policies.
Requires permission to access the ListPolicies action.
- Parameters:
listPoliciesRequest
- The input for the ListPolicies operation.- Returns:
- A Java Future containing the result of the ListPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPolicies
default CompletableFuture<ListPoliciesResponse> listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) Lists your policies.
Requires permission to access the ListPolicies action.
This is a convenience which creates an instance of the
ListPoliciesRequest.Builder
avoiding the need to create one manually viaListPoliciesRequest.builder()
- Parameters:
listPoliciesRequest
- AConsumer
that will call methods onListPoliciesRequest.Builder
to create a request. The input for the ListPolicies operation.- Returns:
- A Java Future containing the result of the ListPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPolicies
Lists your policies.
Requires permission to access the ListPolicies action.
- Returns:
- A Java Future containing the result of the ListPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPoliciesPaginator
This is a variant of
listPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListPoliciesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPoliciesPaginator
This is a variant of
listPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListPoliciesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation.- Parameters:
listPoliciesRequest
- The input for the ListPolicies operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPoliciesPaginator
default ListPoliciesPublisher listPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) This is a variant of
listPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListPoliciesPublisher publisher = client.listPoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListPoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListPoliciesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListPoliciesRequest.Builder
avoiding the need to create one manually viaListPoliciesRequest.builder()
- Parameters:
listPoliciesRequest
- AConsumer
that will call methods onListPoliciesRequest.Builder
to create a request. The input for the ListPolicies operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPolicyVersions
default CompletableFuture<ListPolicyVersionsResponse> listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) Lists the versions of the specified policy and identifies the default version.
Requires permission to access the ListPolicyVersions action.
- Parameters:
listPolicyVersionsRequest
- The input for the ListPolicyVersions operation.- Returns:
- A Java Future containing the result of the ListPolicyVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPolicyVersions
default CompletableFuture<ListPolicyVersionsResponse> listPolicyVersions(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) Lists the versions of the specified policy and identifies the default version.
Requires permission to access the ListPolicyVersions action.
This is a convenience which creates an instance of the
ListPolicyVersionsRequest.Builder
avoiding the need to create one manually viaListPolicyVersionsRequest.builder()
- Parameters:
listPolicyVersionsRequest
- AConsumer
that will call methods onListPolicyVersionsRequest.Builder
to create a request. The input for the ListPolicyVersions operation.- Returns:
- A Java Future containing the result of the ListPolicyVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPrincipalThings
default CompletableFuture<ListPrincipalThingsResponse> 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.
- Parameters:
listPrincipalThingsRequest
- The input for the ListPrincipalThings operation.- Returns:
- A Java Future containing the result of the ListPrincipalThings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPrincipalThings
default CompletableFuture<ListPrincipalThingsResponse> listPrincipalThings(Consumer<ListPrincipalThingsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListPrincipalThingsRequest.Builder
avoiding the need to create one manually viaListPrincipalThingsRequest.builder()
- Parameters:
listPrincipalThingsRequest
- AConsumer
that will call methods onListPrincipalThingsRequest.Builder
to create a request. The input for the ListPrincipalThings operation.- Returns:
- A Java Future containing the result of the ListPrincipalThings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPrincipalThingsPaginator
default ListPrincipalThingsPublisher listPrincipalThingsPaginator(ListPrincipalThingsRequest listPrincipalThingsRequest) This is a variant of
listPrincipalThings(software.amazon.awssdk.services.iot.model.ListPrincipalThingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListPrincipalThingsPublisher publisher = client.listPrincipalThingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListPrincipalThingsPublisher publisher = client.listPrincipalThingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListPrincipalThingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListPrincipalThingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrincipalThings(software.amazon.awssdk.services.iot.model.ListPrincipalThingsRequest)
operation.- Parameters:
listPrincipalThingsRequest
- The input for the ListPrincipalThings operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPrincipalThingsPaginator
default ListPrincipalThingsPublisher listPrincipalThingsPaginator(Consumer<ListPrincipalThingsRequest.Builder> listPrincipalThingsRequest) This is a variant of
listPrincipalThings(software.amazon.awssdk.services.iot.model.ListPrincipalThingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListPrincipalThingsPublisher publisher = client.listPrincipalThingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListPrincipalThingsPublisher publisher = client.listPrincipalThingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListPrincipalThingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListPrincipalThingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrincipalThings(software.amazon.awssdk.services.iot.model.ListPrincipalThingsRequest)
operation.
This is a convenience which creates an instance of the
ListPrincipalThingsRequest.Builder
avoiding the need to create one manually viaListPrincipalThingsRequest.builder()
- Parameters:
listPrincipalThingsRequest
- AConsumer
that will call methods onListPrincipalThingsRequest.Builder
to create a request. The input for the ListPrincipalThings operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisioningTemplateVersions
default CompletableFuture<ListProvisioningTemplateVersionsResponse> listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest) A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
- Parameters:
listProvisioningTemplateVersionsRequest
-- Returns:
- A Java Future containing the result of the ListProvisioningTemplateVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisioningTemplateVersions
default CompletableFuture<ListProvisioningTemplateVersionsResponse> listProvisioningTemplateVersions(Consumer<ListProvisioningTemplateVersionsRequest.Builder> listProvisioningTemplateVersionsRequest) A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
This is a convenience which creates an instance of the
ListProvisioningTemplateVersionsRequest.Builder
avoiding the need to create one manually viaListProvisioningTemplateVersionsRequest.builder()
- Parameters:
listProvisioningTemplateVersionsRequest
- AConsumer
that will call methods onListProvisioningTemplateVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProvisioningTemplateVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisioningTemplateVersionsPaginator
default ListProvisioningTemplateVersionsPublisher listProvisioningTemplateVersionsPaginator(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest) This is a variant of
listProvisioningTemplateVersions(software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplateVersionsPublisher publisher = client.listProvisioningTemplateVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListProvisioningTemplateVersionsPublisher publisher = client.listProvisioningTemplateVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisioningTemplateVersions(software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsRequest)
operation.- Parameters:
listProvisioningTemplateVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisioningTemplateVersionsPaginator
default ListProvisioningTemplateVersionsPublisher listProvisioningTemplateVersionsPaginator(Consumer<ListProvisioningTemplateVersionsRequest.Builder> listProvisioningTemplateVersionsRequest) This is a variant of
listProvisioningTemplateVersions(software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplateVersionsPublisher publisher = client.listProvisioningTemplateVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListProvisioningTemplateVersionsPublisher publisher = client.listProvisioningTemplateVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisioningTemplateVersions(software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListProvisioningTemplateVersionsRequest.Builder
avoiding the need to create one manually viaListProvisioningTemplateVersionsRequest.builder()
- Parameters:
listProvisioningTemplateVersionsRequest
- AConsumer
that will call methods onListProvisioningTemplateVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisioningTemplates
default CompletableFuture<ListProvisioningTemplatesResponse> listProvisioningTemplates(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest) Lists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
- Parameters:
listProvisioningTemplatesRequest
-- Returns:
- A Java Future containing the result of the ListProvisioningTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisioningTemplates
default CompletableFuture<ListProvisioningTemplatesResponse> listProvisioningTemplates(Consumer<ListProvisioningTemplatesRequest.Builder> listProvisioningTemplatesRequest) Lists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
This is a convenience which creates an instance of the
ListProvisioningTemplatesRequest.Builder
avoiding the need to create one manually viaListProvisioningTemplatesRequest.builder()
- Parameters:
listProvisioningTemplatesRequest
- AConsumer
that will call methods onListProvisioningTemplatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProvisioningTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisioningTemplatesPaginator
default ListProvisioningTemplatesPublisher listProvisioningTemplatesPaginator(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest) This is a variant of
listProvisioningTemplates(software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplatesPublisher publisher = client.listProvisioningTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListProvisioningTemplatesPublisher publisher = client.listProvisioningTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisioningTemplates(software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesRequest)
operation.- Parameters:
listProvisioningTemplatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listProvisioningTemplatesPaginator
default ListProvisioningTemplatesPublisher listProvisioningTemplatesPaginator(Consumer<ListProvisioningTemplatesRequest.Builder> listProvisioningTemplatesRequest) This is a variant of
listProvisioningTemplates(software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplatesPublisher publisher = client.listProvisioningTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListProvisioningTemplatesPublisher publisher = client.listProvisioningTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisioningTemplates(software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListProvisioningTemplatesRequest.Builder
avoiding the need to create one manually viaListProvisioningTemplatesRequest.builder()
- Parameters:
listProvisioningTemplatesRequest
- AConsumer
that will call methods onListProvisioningTemplatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listRelatedResourcesForAuditFinding
default CompletableFuture<ListRelatedResourcesForAuditFindingResponse> 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.
- Parameters:
listRelatedResourcesForAuditFindingRequest
-- Returns:
- A Java Future containing the result of the ListRelatedResourcesForAuditFinding operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
listRelatedResourcesForAuditFinding
default CompletableFuture<ListRelatedResourcesForAuditFindingResponse> listRelatedResourcesForAuditFinding(Consumer<ListRelatedResourcesForAuditFindingRequest.Builder> 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.
This is a convenience which creates an instance of the
ListRelatedResourcesForAuditFindingRequest.Builder
avoiding the need to create one manually viaListRelatedResourcesForAuditFindingRequest.builder()
- Parameters:
listRelatedResourcesForAuditFindingRequest
- AConsumer
that will call methods onListRelatedResourcesForAuditFindingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRelatedResourcesForAuditFinding operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
-
listRelatedResourcesForAuditFindingPaginator
default ListRelatedResourcesForAuditFindingPublisher listRelatedResourcesForAuditFindingPaginator(ListRelatedResourcesForAuditFindingRequest listRelatedResourcesForAuditFindingRequest) This is a variant of
listRelatedResourcesForAuditFinding(software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListRelatedResourcesForAuditFindingPublisher publisher = client.listRelatedResourcesForAuditFindingPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListRelatedResourcesForAuditFindingPublisher publisher = client.listRelatedResourcesForAuditFindingPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRelatedResourcesForAuditFinding(software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingRequest)
operation.- Parameters:
listRelatedResourcesForAuditFindingRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listRelatedResourcesForAuditFindingPaginator
default ListRelatedResourcesForAuditFindingPublisher listRelatedResourcesForAuditFindingPaginator(Consumer<ListRelatedResourcesForAuditFindingRequest.Builder> listRelatedResourcesForAuditFindingRequest) This is a variant of
listRelatedResourcesForAuditFinding(software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListRelatedResourcesForAuditFindingPublisher publisher = client.listRelatedResourcesForAuditFindingPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListRelatedResourcesForAuditFindingPublisher publisher = client.listRelatedResourcesForAuditFindingPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRelatedResourcesForAuditFinding(software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingRequest)
operation.
This is a convenience which creates an instance of the
ListRelatedResourcesForAuditFindingRequest.Builder
avoiding the need to create one manually viaListRelatedResourcesForAuditFindingRequest.builder()
- Parameters:
listRelatedResourcesForAuditFindingRequest
- AConsumer
that will call methods onListRelatedResourcesForAuditFindingRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listRoleAliases
default CompletableFuture<ListRoleAliasesResponse> listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest) Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
- Parameters:
listRoleAliasesRequest
-- Returns:
- A Java Future containing the result of the ListRoleAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listRoleAliases
default CompletableFuture<ListRoleAliasesResponse> listRoleAliases(Consumer<ListRoleAliasesRequest.Builder> listRoleAliasesRequest) Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
This is a convenience which creates an instance of the
ListRoleAliasesRequest.Builder
avoiding the need to create one manually viaListRoleAliasesRequest.builder()
- Parameters:
listRoleAliasesRequest
- AConsumer
that will call methods onListRoleAliasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListRoleAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listRoleAliases
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
- Returns:
- A Java Future containing the result of the ListRoleAliases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listRoleAliasesPaginator
This is a variant of
listRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListRoleAliasesPublisher publisher = client.listRoleAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListRoleAliasesPublisher publisher = client.listRoleAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListRoleAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListRoleAliasesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listRoleAliasesPaginator
default ListRoleAliasesPublisher listRoleAliasesPaginator(ListRoleAliasesRequest listRoleAliasesRequest) This is a variant of
listRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListRoleAliasesPublisher publisher = client.listRoleAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListRoleAliasesPublisher publisher = client.listRoleAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListRoleAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListRoleAliasesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation.- Parameters:
listRoleAliasesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listRoleAliasesPaginator
default ListRoleAliasesPublisher listRoleAliasesPaginator(Consumer<ListRoleAliasesRequest.Builder> listRoleAliasesRequest) This is a variant of
listRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListRoleAliasesPublisher publisher = client.listRoleAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListRoleAliasesPublisher publisher = client.listRoleAliasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListRoleAliasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListRoleAliasesResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation.
This is a convenience which creates an instance of the
ListRoleAliasesRequest.Builder
avoiding the need to create one manually viaListRoleAliasesRequest.builder()
- Parameters:
listRoleAliasesRequest
- AConsumer
that will call methods onListRoleAliasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSbomValidationResults
default CompletableFuture<ListSbomValidationResultsResponse> listSbomValidationResults(ListSbomValidationResultsRequest listSbomValidationResultsRequest) The validation results for all software bill of materials (SBOM) attached to a specific software package version.
Requires permission to access the ListSbomValidationResults action.
- Parameters:
listSbomValidationResultsRequest
-- Returns:
- A Java Future containing the result of the ListSbomValidationResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSbomValidationResults
default CompletableFuture<ListSbomValidationResultsResponse> listSbomValidationResults(Consumer<ListSbomValidationResultsRequest.Builder> listSbomValidationResultsRequest) The validation results for all software bill of materials (SBOM) attached to a specific software package version.
Requires permission to access the ListSbomValidationResults action.
This is a convenience which creates an instance of the
ListSbomValidationResultsRequest.Builder
avoiding the need to create one manually viaListSbomValidationResultsRequest.builder()
- Parameters:
listSbomValidationResultsRequest
- AConsumer
that will call methods onListSbomValidationResultsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSbomValidationResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSbomValidationResultsPaginator
default ListSbomValidationResultsPublisher listSbomValidationResultsPaginator(ListSbomValidationResultsRequest listSbomValidationResultsRequest) This is a variant of
listSbomValidationResults(software.amazon.awssdk.services.iot.model.ListSbomValidationResultsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListSbomValidationResultsPublisher publisher = client.listSbomValidationResultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListSbomValidationResultsPublisher publisher = client.listSbomValidationResultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListSbomValidationResultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListSbomValidationResultsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSbomValidationResults(software.amazon.awssdk.services.iot.model.ListSbomValidationResultsRequest)
operation.- Parameters:
listSbomValidationResultsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSbomValidationResultsPaginator
default ListSbomValidationResultsPublisher listSbomValidationResultsPaginator(Consumer<ListSbomValidationResultsRequest.Builder> listSbomValidationResultsRequest) This is a variant of
listSbomValidationResults(software.amazon.awssdk.services.iot.model.ListSbomValidationResultsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListSbomValidationResultsPublisher publisher = client.listSbomValidationResultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListSbomValidationResultsPublisher publisher = client.listSbomValidationResultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListSbomValidationResultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListSbomValidationResultsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSbomValidationResults(software.amazon.awssdk.services.iot.model.ListSbomValidationResultsRequest)
operation.
This is a convenience which creates an instance of the
ListSbomValidationResultsRequest.Builder
avoiding the need to create one manually viaListSbomValidationResultsRequest.builder()
- Parameters:
listSbomValidationResultsRequest
- AConsumer
that will call methods onListSbomValidationResultsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listScheduledAudits
default CompletableFuture<ListScheduledAuditsResponse> listScheduledAudits(ListScheduledAuditsRequest listScheduledAuditsRequest) Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
- Parameters:
listScheduledAuditsRequest
-- Returns:
- A Java Future containing the result of the ListScheduledAudits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listScheduledAudits
default CompletableFuture<ListScheduledAuditsResponse> listScheduledAudits(Consumer<ListScheduledAuditsRequest.Builder> listScheduledAuditsRequest) Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
This is a convenience which creates an instance of the
ListScheduledAuditsRequest.Builder
avoiding the need to create one manually viaListScheduledAuditsRequest.builder()
- Parameters:
listScheduledAuditsRequest
- AConsumer
that will call methods onListScheduledAuditsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListScheduledAudits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listScheduledAudits
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
- Returns:
- A Java Future containing the result of the ListScheduledAudits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listScheduledAuditsPaginator
This is a variant of
listScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListScheduledAuditsPublisher publisher = client.listScheduledAuditsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListScheduledAuditsPublisher publisher = client.listScheduledAuditsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListScheduledAuditsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListScheduledAuditsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listScheduledAuditsPaginator
default ListScheduledAuditsPublisher listScheduledAuditsPaginator(ListScheduledAuditsRequest listScheduledAuditsRequest) This is a variant of
listScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListScheduledAuditsPublisher publisher = client.listScheduledAuditsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListScheduledAuditsPublisher publisher = client.listScheduledAuditsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListScheduledAuditsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListScheduledAuditsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation.- Parameters:
listScheduledAuditsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listScheduledAuditsPaginator
default ListScheduledAuditsPublisher listScheduledAuditsPaginator(Consumer<ListScheduledAuditsRequest.Builder> listScheduledAuditsRequest) This is a variant of
listScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListScheduledAuditsPublisher publisher = client.listScheduledAuditsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListScheduledAuditsPublisher publisher = client.listScheduledAuditsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListScheduledAuditsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListScheduledAuditsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation.
This is a convenience which creates an instance of the
ListScheduledAuditsRequest.Builder
avoiding the need to create one manually viaListScheduledAuditsRequest.builder()
- Parameters:
listScheduledAuditsRequest
- AConsumer
that will call methods onListScheduledAuditsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSecurityProfiles
default CompletableFuture<ListSecurityProfilesResponse> 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
andmetricName
cannot be used in the same request.- Parameters:
listSecurityProfilesRequest
-- Returns:
- A Java Future containing the result of the ListSecurityProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSecurityProfiles
default CompletableFuture<ListSecurityProfilesResponse> listSecurityProfiles(Consumer<ListSecurityProfilesRequest.Builder> 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
andmetricName
cannot be used in the same request.
This is a convenience which creates an instance of the
ListSecurityProfilesRequest.Builder
avoiding the need to create one manually viaListSecurityProfilesRequest.builder()
- Parameters:
listSecurityProfilesRequest
- AConsumer
that will call methods onListSecurityProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSecurityProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSecurityProfiles
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
andmetricName
cannot be used in the same request.- Returns:
- A Java Future containing the result of the ListSecurityProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSecurityProfilesForTarget
default CompletableFuture<ListSecurityProfilesForTargetResponse> listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest) Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
- Parameters:
listSecurityProfilesForTargetRequest
-- Returns:
- A Java Future containing the result of the ListSecurityProfilesForTarget operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSecurityProfilesForTarget
default CompletableFuture<ListSecurityProfilesForTargetResponse> listSecurityProfilesForTarget(Consumer<ListSecurityProfilesForTargetRequest.Builder> listSecurityProfilesForTargetRequest) Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
This is a convenience which creates an instance of the
ListSecurityProfilesForTargetRequest.Builder
avoiding the need to create one manually viaListSecurityProfilesForTargetRequest.builder()
- Parameters:
listSecurityProfilesForTargetRequest
- AConsumer
that will call methods onListSecurityProfilesForTargetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSecurityProfilesForTarget operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSecurityProfilesForTargetPaginator
default ListSecurityProfilesForTargetPublisher listSecurityProfilesForTargetPaginator(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest) This is a variant of
listSecurityProfilesForTarget(software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesForTargetPublisher publisher = client.listSecurityProfilesForTargetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListSecurityProfilesForTargetPublisher publisher = client.listSecurityProfilesForTargetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityProfilesForTarget(software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetRequest)
operation.- Parameters:
listSecurityProfilesForTargetRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSecurityProfilesForTargetPaginator
default ListSecurityProfilesForTargetPublisher listSecurityProfilesForTargetPaginator(Consumer<ListSecurityProfilesForTargetRequest.Builder> listSecurityProfilesForTargetRequest) This is a variant of
listSecurityProfilesForTarget(software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesForTargetPublisher publisher = client.listSecurityProfilesForTargetPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListSecurityProfilesForTargetPublisher publisher = client.listSecurityProfilesForTargetPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityProfilesForTarget(software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetRequest)
operation.
This is a convenience which creates an instance of the
ListSecurityProfilesForTargetRequest.Builder
avoiding the need to create one manually viaListSecurityProfilesForTargetRequest.builder()
- Parameters:
listSecurityProfilesForTargetRequest
- AConsumer
that will call methods onListSecurityProfilesForTargetRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSecurityProfilesPaginator
This is a variant of
listSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesPublisher publisher = client.listSecurityProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListSecurityProfilesPublisher publisher = client.listSecurityProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListSecurityProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListSecurityProfilesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSecurityProfilesPaginator
default ListSecurityProfilesPublisher listSecurityProfilesPaginator(ListSecurityProfilesRequest listSecurityProfilesRequest) This is a variant of
listSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesPublisher publisher = client.listSecurityProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListSecurityProfilesPublisher publisher = client.listSecurityProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListSecurityProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListSecurityProfilesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation.- Parameters:
listSecurityProfilesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listSecurityProfilesPaginator
default ListSecurityProfilesPublisher listSecurityProfilesPaginator(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest) This is a variant of
listSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesPublisher publisher = client.listSecurityProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListSecurityProfilesPublisher publisher = client.listSecurityProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListSecurityProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListSecurityProfilesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation.
This is a convenience which creates an instance of the
ListSecurityProfilesRequest.Builder
avoiding the need to create one manually viaListSecurityProfilesRequest.builder()
- Parameters:
listSecurityProfilesRequest
- AConsumer
that will call methods onListSecurityProfilesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listStreams
Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
- Parameters:
listStreamsRequest
-- Returns:
- A Java Future containing the result of the ListStreams operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listStreams
default CompletableFuture<ListStreamsResponse> listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest) Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
This is a convenience which creates an instance of the
ListStreamsRequest.Builder
avoiding the need to create one manually viaListStreamsRequest.builder()
- Parameters:
listStreamsRequest
- AConsumer
that will call methods onListStreamsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStreams operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listStreams
Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
- Returns:
- A Java Future containing the result of the ListStreams operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listStreamsPaginator
This is a variant of
listStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListStreamsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListStreamsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listStreamsPaginator
This is a variant of
listStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListStreamsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListStreamsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation.- Parameters:
listStreamsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listStreamsPaginator
default ListStreamsPublisher listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest) This is a variant of
listStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListStreamsPublisher publisher = client.listStreamsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListStreamsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListStreamsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation.
This is a convenience which creates an instance of the
ListStreamsRequest.Builder
avoiding the need to create one manually viaListStreamsRequest.builder()
- Parameters:
listStreamsRequest
- AConsumer
that will call methods onListStreamsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.iot.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.iot.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.iot.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.iot.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTargetsForPolicy
default CompletableFuture<ListTargetsForPolicyResponse> listTargetsForPolicy(ListTargetsForPolicyRequest listTargetsForPolicyRequest) List targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
- Parameters:
listTargetsForPolicyRequest
-- Returns:
- A Java Future containing the result of the ListTargetsForPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTargetsForPolicy
default CompletableFuture<ListTargetsForPolicyResponse> listTargetsForPolicy(Consumer<ListTargetsForPolicyRequest.Builder> listTargetsForPolicyRequest) List targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
This is a convenience which creates an instance of the
ListTargetsForPolicyRequest.Builder
avoiding the need to create one manually viaListTargetsForPolicyRequest.builder()
- Parameters:
listTargetsForPolicyRequest
- AConsumer
that will call methods onListTargetsForPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTargetsForPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTargetsForPolicyPaginator
default ListTargetsForPolicyPublisher listTargetsForPolicyPaginator(ListTargetsForPolicyRequest listTargetsForPolicyRequest) This is a variant of
listTargetsForPolicy(software.amazon.awssdk.services.iot.model.ListTargetsForPolicyRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTargetsForPolicyPublisher publisher = client.listTargetsForPolicyPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTargetsForPolicyPublisher publisher = client.listTargetsForPolicyPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTargetsForPolicyResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTargetsForPolicyResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTargetsForPolicy(software.amazon.awssdk.services.iot.model.ListTargetsForPolicyRequest)
operation.- Parameters:
listTargetsForPolicyRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTargetsForPolicyPaginator
default ListTargetsForPolicyPublisher listTargetsForPolicyPaginator(Consumer<ListTargetsForPolicyRequest.Builder> listTargetsForPolicyRequest) This is a variant of
listTargetsForPolicy(software.amazon.awssdk.services.iot.model.ListTargetsForPolicyRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTargetsForPolicyPublisher publisher = client.listTargetsForPolicyPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTargetsForPolicyPublisher publisher = client.listTargetsForPolicyPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTargetsForPolicyResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTargetsForPolicyResponse response) { //... }; });
Please notice that the configuration of pageSize won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTargetsForPolicy(software.amazon.awssdk.services.iot.model.ListTargetsForPolicyRequest)
operation.
This is a convenience which creates an instance of the
ListTargetsForPolicyRequest.Builder
avoiding the need to create one manually viaListTargetsForPolicyRequest.builder()
- Parameters:
listTargetsForPolicyRequest
- AConsumer
that will call methods onListTargetsForPolicyRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTargetsForSecurityProfile
default CompletableFuture<ListTargetsForSecurityProfileResponse> listTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest) Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
- Parameters:
listTargetsForSecurityProfileRequest
-- Returns:
- A Java Future containing the result of the ListTargetsForSecurityProfile operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTargetsForSecurityProfile
default CompletableFuture<ListTargetsForSecurityProfileResponse> listTargetsForSecurityProfile(Consumer<ListTargetsForSecurityProfileRequest.Builder> listTargetsForSecurityProfileRequest) Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
This is a convenience which creates an instance of the
ListTargetsForSecurityProfileRequest.Builder
avoiding the need to create one manually viaListTargetsForSecurityProfileRequest.builder()
- Parameters:
listTargetsForSecurityProfileRequest
- AConsumer
that will call methods onListTargetsForSecurityProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTargetsForSecurityProfile operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTargetsForSecurityProfilePaginator
default ListTargetsForSecurityProfilePublisher listTargetsForSecurityProfilePaginator(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest) This is a variant of
listTargetsForSecurityProfile(software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTargetsForSecurityProfilePublisher publisher = client.listTargetsForSecurityProfilePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTargetsForSecurityProfilePublisher publisher = client.listTargetsForSecurityProfilePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTargetsForSecurityProfile(software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileRequest)
operation.- Parameters:
listTargetsForSecurityProfileRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTargetsForSecurityProfilePaginator
default ListTargetsForSecurityProfilePublisher listTargetsForSecurityProfilePaginator(Consumer<ListTargetsForSecurityProfileRequest.Builder> listTargetsForSecurityProfileRequest) This is a variant of
listTargetsForSecurityProfile(software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTargetsForSecurityProfilePublisher publisher = client.listTargetsForSecurityProfilePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTargetsForSecurityProfilePublisher publisher = client.listTargetsForSecurityProfilePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTargetsForSecurityProfile(software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileRequest)
operation.
This is a convenience which creates an instance of the
ListTargetsForSecurityProfileRequest.Builder
avoiding the need to create one manually viaListTargetsForSecurityProfileRequest.builder()
- Parameters:
listTargetsForSecurityProfileRequest
- AConsumer
that will call methods onListTargetsForSecurityProfileRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingGroups
default CompletableFuture<ListThingGroupsResponse> listThingGroups(ListThingGroupsRequest listThingGroupsRequest) List the thing groups in your account.
Requires permission to access the ListThingGroups action.
- Parameters:
listThingGroupsRequest
-- Returns:
- A Java Future containing the result of the ListThingGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingGroups
default CompletableFuture<ListThingGroupsResponse> listThingGroups(Consumer<ListThingGroupsRequest.Builder> listThingGroupsRequest) List the thing groups in your account.
Requires permission to access the ListThingGroups action.
This is a convenience which creates an instance of the
ListThingGroupsRequest.Builder
avoiding the need to create one manually viaListThingGroupsRequest.builder()
- Parameters:
listThingGroupsRequest
- AConsumer
that will call methods onListThingGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListThingGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingGroups
List the thing groups in your account.
Requires permission to access the ListThingGroups action.
- Returns:
- A Java Future containing the result of the ListThingGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingGroupsForThing
default CompletableFuture<ListThingGroupsForThingResponse> listThingGroupsForThing(ListThingGroupsForThingRequest listThingGroupsForThingRequest) List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
- Parameters:
listThingGroupsForThingRequest
-- Returns:
- A Java Future containing the result of the ListThingGroupsForThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingGroupsForThing
default CompletableFuture<ListThingGroupsForThingResponse> listThingGroupsForThing(Consumer<ListThingGroupsForThingRequest.Builder> listThingGroupsForThingRequest) List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
This is a convenience which creates an instance of the
ListThingGroupsForThingRequest.Builder
avoiding the need to create one manually viaListThingGroupsForThingRequest.builder()
- Parameters:
listThingGroupsForThingRequest
- AConsumer
that will call methods onListThingGroupsForThingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListThingGroupsForThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingGroupsForThingPaginator
default ListThingGroupsForThingPublisher listThingGroupsForThingPaginator(ListThingGroupsForThingRequest listThingGroupsForThingRequest) This is a variant of
listThingGroupsForThing(software.amazon.awssdk.services.iot.model.ListThingGroupsForThingRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsForThingPublisher publisher = client.listThingGroupsForThingPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingGroupsForThingPublisher publisher = client.listThingGroupsForThingPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingGroupsForThingResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingGroupsForThingResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingGroupsForThing(software.amazon.awssdk.services.iot.model.ListThingGroupsForThingRequest)
operation.- Parameters:
listThingGroupsForThingRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingGroupsForThingPaginator
default ListThingGroupsForThingPublisher listThingGroupsForThingPaginator(Consumer<ListThingGroupsForThingRequest.Builder> listThingGroupsForThingRequest) This is a variant of
listThingGroupsForThing(software.amazon.awssdk.services.iot.model.ListThingGroupsForThingRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsForThingPublisher publisher = client.listThingGroupsForThingPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingGroupsForThingPublisher publisher = client.listThingGroupsForThingPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingGroupsForThingResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingGroupsForThingResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingGroupsForThing(software.amazon.awssdk.services.iot.model.ListThingGroupsForThingRequest)
operation.
This is a convenience which creates an instance of the
ListThingGroupsForThingRequest.Builder
avoiding the need to create one manually viaListThingGroupsForThingRequest.builder()
- Parameters:
listThingGroupsForThingRequest
- AConsumer
that will call methods onListThingGroupsForThingRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingGroupsPaginator
This is a variant of
listThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsPublisher publisher = client.listThingGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingGroupsPublisher publisher = client.listThingGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingGroupsPaginator
default ListThingGroupsPublisher listThingGroupsPaginator(ListThingGroupsRequest listThingGroupsRequest) This is a variant of
listThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsPublisher publisher = client.listThingGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingGroupsPublisher publisher = client.listThingGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation.- Parameters:
listThingGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingGroupsPaginator
default ListThingGroupsPublisher listThingGroupsPaginator(Consumer<ListThingGroupsRequest.Builder> listThingGroupsRequest) This is a variant of
listThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsPublisher publisher = client.listThingGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingGroupsPublisher publisher = client.listThingGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListThingGroupsRequest.Builder
avoiding the need to create one manually viaListThingGroupsRequest.builder()
- Parameters:
listThingGroupsRequest
- AConsumer
that will call methods onListThingGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingPrincipals
default CompletableFuture<ListThingPrincipalsResponse> 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.
- Parameters:
listThingPrincipalsRequest
- The input for the ListThingPrincipal operation.- Returns:
- A Java Future containing the result of the ListThingPrincipals operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingPrincipals
default CompletableFuture<ListThingPrincipalsResponse> listThingPrincipals(Consumer<ListThingPrincipalsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListThingPrincipalsRequest.Builder
avoiding the need to create one manually viaListThingPrincipalsRequest.builder()
- Parameters:
listThingPrincipalsRequest
- AConsumer
that will call methods onListThingPrincipalsRequest.Builder
to create a request. The input for the ListThingPrincipal operation.- Returns:
- A Java Future containing the result of the ListThingPrincipals operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingPrincipalsPaginator
default ListThingPrincipalsPublisher listThingPrincipalsPaginator(ListThingPrincipalsRequest listThingPrincipalsRequest) This is a variant of
listThingPrincipals(software.amazon.awssdk.services.iot.model.ListThingPrincipalsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingPrincipalsPublisher publisher = client.listThingPrincipalsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingPrincipalsPublisher publisher = client.listThingPrincipalsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingPrincipalsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingPrincipalsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingPrincipals(software.amazon.awssdk.services.iot.model.ListThingPrincipalsRequest)
operation.- Parameters:
listThingPrincipalsRequest
- The input for the ListThingPrincipal operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingPrincipalsPaginator
default ListThingPrincipalsPublisher listThingPrincipalsPaginator(Consumer<ListThingPrincipalsRequest.Builder> listThingPrincipalsRequest) This is a variant of
listThingPrincipals(software.amazon.awssdk.services.iot.model.ListThingPrincipalsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingPrincipalsPublisher publisher = client.listThingPrincipalsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingPrincipalsPublisher publisher = client.listThingPrincipalsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingPrincipalsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingPrincipalsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingPrincipals(software.amazon.awssdk.services.iot.model.ListThingPrincipalsRequest)
operation.
This is a convenience which creates an instance of the
ListThingPrincipalsRequest.Builder
avoiding the need to create one manually viaListThingPrincipalsRequest.builder()
- Parameters:
listThingPrincipalsRequest
- AConsumer
that will call methods onListThingPrincipalsRequest.Builder
to create a request. The input for the ListThingPrincipal operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingRegistrationTaskReports
default CompletableFuture<ListThingRegistrationTaskReportsResponse> listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest) Information about the thing registration tasks.
- Parameters:
listThingRegistrationTaskReportsRequest
-- Returns:
- A Java Future containing the result of the ListThingRegistrationTaskReports operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingRegistrationTaskReports
default CompletableFuture<ListThingRegistrationTaskReportsResponse> listThingRegistrationTaskReports(Consumer<ListThingRegistrationTaskReportsRequest.Builder> listThingRegistrationTaskReportsRequest) Information about the thing registration tasks.
This is a convenience which creates an instance of the
ListThingRegistrationTaskReportsRequest.Builder
avoiding the need to create one manually viaListThingRegistrationTaskReportsRequest.builder()
- Parameters:
listThingRegistrationTaskReportsRequest
- AConsumer
that will call methods onListThingRegistrationTaskReportsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListThingRegistrationTaskReports operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingRegistrationTaskReportsPaginator
default ListThingRegistrationTaskReportsPublisher listThingRegistrationTaskReportsPaginator(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest) This is a variant of
listThingRegistrationTaskReports(software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTaskReportsPublisher publisher = client.listThingRegistrationTaskReportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingRegistrationTaskReportsPublisher publisher = client.listThingRegistrationTaskReportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingRegistrationTaskReports(software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsRequest)
operation.- Parameters:
listThingRegistrationTaskReportsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingRegistrationTaskReportsPaginator
default ListThingRegistrationTaskReportsPublisher listThingRegistrationTaskReportsPaginator(Consumer<ListThingRegistrationTaskReportsRequest.Builder> listThingRegistrationTaskReportsRequest) This is a variant of
listThingRegistrationTaskReports(software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTaskReportsPublisher publisher = client.listThingRegistrationTaskReportsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingRegistrationTaskReportsPublisher publisher = client.listThingRegistrationTaskReportsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingRegistrationTaskReports(software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsRequest)
operation.
This is a convenience which creates an instance of the
ListThingRegistrationTaskReportsRequest.Builder
avoiding the need to create one manually viaListThingRegistrationTaskReportsRequest.builder()
- Parameters:
listThingRegistrationTaskReportsRequest
- AConsumer
that will call methods onListThingRegistrationTaskReportsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingRegistrationTasks
default CompletableFuture<ListThingRegistrationTasksResponse> listThingRegistrationTasks(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest) List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
- Parameters:
listThingRegistrationTasksRequest
-- Returns:
- A Java Future containing the result of the ListThingRegistrationTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingRegistrationTasks
default CompletableFuture<ListThingRegistrationTasksResponse> listThingRegistrationTasks(Consumer<ListThingRegistrationTasksRequest.Builder> listThingRegistrationTasksRequest) List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
This is a convenience which creates an instance of the
ListThingRegistrationTasksRequest.Builder
avoiding the need to create one manually viaListThingRegistrationTasksRequest.builder()
- Parameters:
listThingRegistrationTasksRequest
- AConsumer
that will call methods onListThingRegistrationTasksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListThingRegistrationTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingRegistrationTasks
List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
- Returns:
- A Java Future containing the result of the ListThingRegistrationTasks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingRegistrationTasksPaginator
This is a variant of
listThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksPublisher publisher = client.listThingRegistrationTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksPublisher publisher = client.listThingRegistrationTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingRegistrationTasksPaginator
default ListThingRegistrationTasksPublisher listThingRegistrationTasksPaginator(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest) This is a variant of
listThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksPublisher publisher = client.listThingRegistrationTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksPublisher publisher = client.listThingRegistrationTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation.- Parameters:
listThingRegistrationTasksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingRegistrationTasksPaginator
default ListThingRegistrationTasksPublisher listThingRegistrationTasksPaginator(Consumer<ListThingRegistrationTasksRequest.Builder> listThingRegistrationTasksRequest) This is a variant of
listThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksPublisher publisher = client.listThingRegistrationTasksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksPublisher publisher = client.listThingRegistrationTasksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation.
This is a convenience which creates an instance of the
ListThingRegistrationTasksRequest.Builder
avoiding the need to create one manually viaListThingRegistrationTasksRequest.builder()
- Parameters:
listThingRegistrationTasksRequest
- AConsumer
that will call methods onListThingRegistrationTasksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingTypes
default CompletableFuture<ListThingTypesResponse> listThingTypes(ListThingTypesRequest listThingTypesRequest) Lists the existing thing types.
Requires permission to access the ListThingTypes action.
- Parameters:
listThingTypesRequest
- The input for the ListThingTypes operation.- Returns:
- A Java Future containing the result of the ListThingTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingTypes
default CompletableFuture<ListThingTypesResponse> listThingTypes(Consumer<ListThingTypesRequest.Builder> listThingTypesRequest) Lists the existing thing types.
Requires permission to access the ListThingTypes action.
This is a convenience which creates an instance of the
ListThingTypesRequest.Builder
avoiding the need to create one manually viaListThingTypesRequest.builder()
- Parameters:
listThingTypesRequest
- AConsumer
that will call methods onListThingTypesRequest.Builder
to create a request. The input for the ListThingTypes operation.- Returns:
- A Java Future containing the result of the ListThingTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingTypes
Lists the existing thing types.
Requires permission to access the ListThingTypes action.
- Returns:
- A Java Future containing the result of the ListThingTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingTypesPaginator
This is a variant of
listThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingTypesPublisher publisher = client.listThingTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingTypesPublisher publisher = client.listThingTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingTypesPaginator
default ListThingTypesPublisher listThingTypesPaginator(ListThingTypesRequest listThingTypesRequest) This is a variant of
listThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingTypesPublisher publisher = client.listThingTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingTypesPublisher publisher = client.listThingTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation.- Parameters:
listThingTypesRequest
- The input for the ListThingTypes operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingTypesPaginator
default ListThingTypesPublisher listThingTypesPaginator(Consumer<ListThingTypesRequest.Builder> listThingTypesRequest) This is a variant of
listThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingTypesPublisher publisher = client.listThingTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingTypesPublisher publisher = client.listThingTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation.
This is a convenience which creates an instance of the
ListThingTypesRequest.Builder
avoiding the need to create one manually viaListThingTypesRequest.builder()
- Parameters:
listThingTypesRequest
- AConsumer
that will call methods onListThingTypesRequest.Builder
to create a request. The input for the ListThingTypes operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThings
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.- Parameters:
listThingsRequest
- The input for the ListThings operation.- Returns:
- A Java Future containing the result of the ListThings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThings
default CompletableFuture<ListThingsResponse> listThings(Consumer<ListThingsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListThingsRequest.Builder
avoiding the need to create one manually viaListThingsRequest.builder()
- Parameters:
listThingsRequest
- AConsumer
that will call methods onListThingsRequest.Builder
to create a request. The input for the ListThings operation.- Returns:
- A Java Future containing the result of the ListThings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThings
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.- Returns:
- A Java Future containing the result of the ListThings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsInBillingGroup
default CompletableFuture<ListThingsInBillingGroupResponse> listThingsInBillingGroup(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest) Lists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
- Parameters:
listThingsInBillingGroupRequest
-- Returns:
- A Java Future containing the result of the ListThingsInBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsInBillingGroup
default CompletableFuture<ListThingsInBillingGroupResponse> listThingsInBillingGroup(Consumer<ListThingsInBillingGroupRequest.Builder> listThingsInBillingGroupRequest) Lists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
This is a convenience which creates an instance of the
ListThingsInBillingGroupRequest.Builder
avoiding the need to create one manually viaListThingsInBillingGroupRequest.builder()
- Parameters:
listThingsInBillingGroupRequest
- AConsumer
that will call methods onListThingsInBillingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListThingsInBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsInBillingGroupPaginator
default ListThingsInBillingGroupPublisher listThingsInBillingGroupPaginator(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest) This is a variant of
listThingsInBillingGroup(software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingsInBillingGroupPublisher publisher = client.listThingsInBillingGroupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingsInBillingGroupPublisher publisher = client.listThingsInBillingGroupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingsInBillingGroup(software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupRequest)
operation.- Parameters:
listThingsInBillingGroupRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsInBillingGroupPaginator
default ListThingsInBillingGroupPublisher listThingsInBillingGroupPaginator(Consumer<ListThingsInBillingGroupRequest.Builder> listThingsInBillingGroupRequest) This is a variant of
listThingsInBillingGroup(software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingsInBillingGroupPublisher publisher = client.listThingsInBillingGroupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingsInBillingGroupPublisher publisher = client.listThingsInBillingGroupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingsInBillingGroup(software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupRequest)
operation.
This is a convenience which creates an instance of the
ListThingsInBillingGroupRequest.Builder
avoiding the need to create one manually viaListThingsInBillingGroupRequest.builder()
- Parameters:
listThingsInBillingGroupRequest
- AConsumer
that will call methods onListThingsInBillingGroupRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsInThingGroup
default CompletableFuture<ListThingsInThingGroupResponse> listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest) Lists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
- Parameters:
listThingsInThingGroupRequest
-- Returns:
- A Java Future containing the result of the ListThingsInThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsInThingGroup
default CompletableFuture<ListThingsInThingGroupResponse> listThingsInThingGroup(Consumer<ListThingsInThingGroupRequest.Builder> listThingsInThingGroupRequest) Lists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
This is a convenience which creates an instance of the
ListThingsInThingGroupRequest.Builder
avoiding the need to create one manually viaListThingsInThingGroupRequest.builder()
- Parameters:
listThingsInThingGroupRequest
- AConsumer
that will call methods onListThingsInThingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListThingsInThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsInThingGroupPaginator
default ListThingsInThingGroupPublisher listThingsInThingGroupPaginator(ListThingsInThingGroupRequest listThingsInThingGroupRequest) This is a variant of
listThingsInThingGroup(software.amazon.awssdk.services.iot.model.ListThingsInThingGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingsInThingGroupPublisher publisher = client.listThingsInThingGroupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingsInThingGroupPublisher publisher = client.listThingsInThingGroupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingsInThingGroupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingsInThingGroupResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingsInThingGroup(software.amazon.awssdk.services.iot.model.ListThingsInThingGroupRequest)
operation.- Parameters:
listThingsInThingGroupRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsInThingGroupPaginator
default ListThingsInThingGroupPublisher listThingsInThingGroupPaginator(Consumer<ListThingsInThingGroupRequest.Builder> listThingsInThingGroupRequest) This is a variant of
listThingsInThingGroup(software.amazon.awssdk.services.iot.model.ListThingsInThingGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingsInThingGroupPublisher publisher = client.listThingsInThingGroupPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingsInThingGroupPublisher publisher = client.listThingsInThingGroupPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingsInThingGroupResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingsInThingGroupResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThingsInThingGroup(software.amazon.awssdk.services.iot.model.ListThingsInThingGroupRequest)
operation.
This is a convenience which creates an instance of the
ListThingsInThingGroupRequest.Builder
avoiding the need to create one manually viaListThingsInThingGroupRequest.builder()
- Parameters:
listThingsInThingGroupRequest
- AConsumer
that will call methods onListThingsInThingGroupRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsPaginator
This is a variant of
listThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingsPublisher publisher = client.listThingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingsPublisher publisher = client.listThingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsPaginator
This is a variant of
listThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingsPublisher publisher = client.listThingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingsPublisher publisher = client.listThingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation.- Parameters:
listThingsRequest
- The input for the ListThings operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listThingsPaginator
default ListThingsPublisher listThingsPaginator(Consumer<ListThingsRequest.Builder> listThingsRequest) This is a variant of
listThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListThingsPublisher publisher = client.listThingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListThingsPublisher publisher = client.listThingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListThingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListThingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation.
This is a convenience which creates an instance of the
ListThingsRequest.Builder
avoiding the need to create one manually viaListThingsRequest.builder()
- Parameters:
listThingsRequest
- AConsumer
that will call methods onListThingsRequest.Builder
to create a request. The input for the ListThings operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTopicRuleDestinations
default CompletableFuture<ListTopicRuleDestinationsResponse> listTopicRuleDestinations(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest) Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
- Parameters:
listTopicRuleDestinationsRequest
-- Returns:
- A Java Future containing the result of the ListTopicRuleDestinations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTopicRuleDestinations
default CompletableFuture<ListTopicRuleDestinationsResponse> listTopicRuleDestinations(Consumer<ListTopicRuleDestinationsRequest.Builder> listTopicRuleDestinationsRequest) Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
This is a convenience which creates an instance of the
ListTopicRuleDestinationsRequest.Builder
avoiding the need to create one manually viaListTopicRuleDestinationsRequest.builder()
- Parameters:
listTopicRuleDestinationsRequest
- AConsumer
that will call methods onListTopicRuleDestinationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTopicRuleDestinations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTopicRuleDestinationsPaginator
default ListTopicRuleDestinationsPublisher listTopicRuleDestinationsPaginator(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest) This is a variant of
listTopicRuleDestinations(software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTopicRuleDestinationsPublisher publisher = client.listTopicRuleDestinationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTopicRuleDestinationsPublisher publisher = client.listTopicRuleDestinationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopicRuleDestinations(software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsRequest)
operation.- Parameters:
listTopicRuleDestinationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTopicRuleDestinationsPaginator
default ListTopicRuleDestinationsPublisher listTopicRuleDestinationsPaginator(Consumer<ListTopicRuleDestinationsRequest.Builder> listTopicRuleDestinationsRequest) This is a variant of
listTopicRuleDestinations(software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTopicRuleDestinationsPublisher publisher = client.listTopicRuleDestinationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTopicRuleDestinationsPublisher publisher = client.listTopicRuleDestinationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopicRuleDestinations(software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsRequest)
operation.
This is a convenience which creates an instance of the
ListTopicRuleDestinationsRequest.Builder
avoiding the need to create one manually viaListTopicRuleDestinationsRequest.builder()
- Parameters:
listTopicRuleDestinationsRequest
- AConsumer
that will call methods onListTopicRuleDestinationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTopicRules
default CompletableFuture<ListTopicRulesResponse> listTopicRules(ListTopicRulesRequest listTopicRulesRequest) Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
- Parameters:
listTopicRulesRequest
- The input for the ListTopicRules operation.- Returns:
- A Java Future containing the result of the ListTopicRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTopicRules
default CompletableFuture<ListTopicRulesResponse> listTopicRules(Consumer<ListTopicRulesRequest.Builder> listTopicRulesRequest) Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
This is a convenience which creates an instance of the
ListTopicRulesRequest.Builder
avoiding the need to create one manually viaListTopicRulesRequest.builder()
- Parameters:
listTopicRulesRequest
- AConsumer
that will call methods onListTopicRulesRequest.Builder
to create a request. The input for the ListTopicRules operation.- Returns:
- A Java Future containing the result of the ListTopicRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTopicRules
Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
- Returns:
- A Java Future containing the result of the ListTopicRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTopicRulesPaginator
This is a variant of
listTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTopicRulesPublisher publisher = client.listTopicRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTopicRulesPublisher publisher = client.listTopicRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTopicRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTopicRulesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTopicRulesPaginator
default ListTopicRulesPublisher listTopicRulesPaginator(ListTopicRulesRequest listTopicRulesRequest) This is a variant of
listTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTopicRulesPublisher publisher = client.listTopicRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTopicRulesPublisher publisher = client.listTopicRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTopicRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTopicRulesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation.- Parameters:
listTopicRulesRequest
- The input for the ListTopicRules operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTopicRulesPaginator
default ListTopicRulesPublisher listTopicRulesPaginator(Consumer<ListTopicRulesRequest.Builder> listTopicRulesRequest) This is a variant of
listTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListTopicRulesPublisher publisher = client.listTopicRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListTopicRulesPublisher publisher = client.listTopicRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListTopicRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListTopicRulesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation.
This is a convenience which creates an instance of the
ListTopicRulesRequest.Builder
avoiding the need to create one manually viaListTopicRulesRequest.builder()
- Parameters:
listTopicRulesRequest
- AConsumer
that will call methods onListTopicRulesRequest.Builder
to create a request. The input for the ListTopicRules operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listV2LoggingLevels
default CompletableFuture<ListV2LoggingLevelsResponse> listV2LoggingLevels(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest) Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.
- Parameters:
listV2LoggingLevelsRequest
-- Returns:
- A Java Future containing the result of the ListV2LoggingLevels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- NotConfiguredException The resource is not configured.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listV2LoggingLevels
default CompletableFuture<ListV2LoggingLevelsResponse> listV2LoggingLevels(Consumer<ListV2LoggingLevelsRequest.Builder> listV2LoggingLevelsRequest) Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.
This is a convenience which creates an instance of the
ListV2LoggingLevelsRequest.Builder
avoiding the need to create one manually viaListV2LoggingLevelsRequest.builder()
- Parameters:
listV2LoggingLevelsRequest
- AConsumer
that will call methods onListV2LoggingLevelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListV2LoggingLevels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- NotConfiguredException The resource is not configured.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listV2LoggingLevelsPaginator
default ListV2LoggingLevelsPublisher listV2LoggingLevelsPaginator(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest) This is a variant of
listV2LoggingLevels(software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListV2LoggingLevelsPublisher publisher = client.listV2LoggingLevelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListV2LoggingLevelsPublisher publisher = client.listV2LoggingLevelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listV2LoggingLevels(software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsRequest)
operation.- Parameters:
listV2LoggingLevelsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- NotConfiguredException The resource is not configured.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listV2LoggingLevelsPaginator
default ListV2LoggingLevelsPublisher listV2LoggingLevelsPaginator(Consumer<ListV2LoggingLevelsRequest.Builder> listV2LoggingLevelsRequest) This is a variant of
listV2LoggingLevels(software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListV2LoggingLevelsPublisher publisher = client.listV2LoggingLevelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListV2LoggingLevelsPublisher publisher = client.listV2LoggingLevelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listV2LoggingLevels(software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsRequest)
operation.
This is a convenience which creates an instance of the
ListV2LoggingLevelsRequest.Builder
avoiding the need to create one manually viaListV2LoggingLevelsRequest.builder()
- Parameters:
listV2LoggingLevelsRequest
- AConsumer
that will call methods onListV2LoggingLevelsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- NotConfiguredException The resource is not configured.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listViolationEvents
default CompletableFuture<ListViolationEventsResponse> 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.
- Parameters:
listViolationEventsRequest
-- Returns:
- A Java Future containing the result of the ListViolationEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listViolationEvents
default CompletableFuture<ListViolationEventsResponse> listViolationEvents(Consumer<ListViolationEventsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListViolationEventsRequest.Builder
avoiding the need to create one manually viaListViolationEventsRequest.builder()
- Parameters:
listViolationEventsRequest
- AConsumer
that will call methods onListViolationEventsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListViolationEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listViolationEventsPaginator
default ListViolationEventsPublisher listViolationEventsPaginator(ListViolationEventsRequest listViolationEventsRequest) This is a variant of
listViolationEvents(software.amazon.awssdk.services.iot.model.ListViolationEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListViolationEventsPublisher publisher = client.listViolationEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListViolationEventsPublisher publisher = client.listViolationEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListViolationEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListViolationEventsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listViolationEvents(software.amazon.awssdk.services.iot.model.ListViolationEventsRequest)
operation.- Parameters:
listViolationEventsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listViolationEventsPaginator
default ListViolationEventsPublisher listViolationEventsPaginator(Consumer<ListViolationEventsRequest.Builder> listViolationEventsRequest) This is a variant of
listViolationEvents(software.amazon.awssdk.services.iot.model.ListViolationEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.iot.paginators.ListViolationEventsPublisher publisher = client.listViolationEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.iot.paginators.ListViolationEventsPublisher publisher = client.listViolationEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iot.model.ListViolationEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.iot.model.ListViolationEventsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listViolationEvents(software.amazon.awssdk.services.iot.model.ListViolationEventsRequest)
operation.
This is a convenience which creates an instance of the
ListViolationEventsRequest.Builder
avoiding the need to create one manually viaListViolationEventsRequest.builder()
- Parameters:
listViolationEventsRequest
- AConsumer
that will call methods onListViolationEventsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
putVerificationStateOnViolation
default CompletableFuture<PutVerificationStateOnViolationResponse> putVerificationStateOnViolation(PutVerificationStateOnViolationRequest putVerificationStateOnViolationRequest) Set a verification state and provide a description of that verification state on a violation (detect alarm).
- Parameters:
putVerificationStateOnViolationRequest
-- Returns:
- A Java Future containing the result of the PutVerificationStateOnViolation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
putVerificationStateOnViolation
default CompletableFuture<PutVerificationStateOnViolationResponse> putVerificationStateOnViolation(Consumer<PutVerificationStateOnViolationRequest.Builder> putVerificationStateOnViolationRequest) Set a verification state and provide a description of that verification state on a violation (detect alarm).
This is a convenience which creates an instance of the
PutVerificationStateOnViolationRequest.Builder
avoiding the need to create one manually viaPutVerificationStateOnViolationRequest.builder()
- Parameters:
putVerificationStateOnViolationRequest
- AConsumer
that will call methods onPutVerificationStateOnViolationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutVerificationStateOnViolation operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
registerCACertificate
default CompletableFuture<RegisterCaCertificateResponse> 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.
- Parameters:
registerCaCertificateRequest
- The input to the RegisterCACertificate operation.- Returns:
- A Java Future containing the result of the RegisterCACertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
registerCACertificate
default CompletableFuture<RegisterCaCertificateResponse> registerCACertificate(Consumer<RegisterCaCertificateRequest.Builder> 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.
This is a convenience which creates an instance of the
RegisterCaCertificateRequest.Builder
avoiding the need to create one manually viaRegisterCaCertificateRequest.builder()
- Parameters:
registerCaCertificateRequest
- AConsumer
that will call methods onRegisterCaCertificateRequest.Builder
to create a request. The input to the RegisterCACertificate operation.- Returns:
- A Java Future containing the result of the RegisterCACertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
registerCertificate
default CompletableFuture<RegisterCertificateResponse> 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.
- Parameters:
registerCertificateRequest
- The input to the RegisterCertificate operation.- Returns:
- A Java Future containing the result of the RegisterCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
registerCertificate
default CompletableFuture<RegisterCertificateResponse> registerCertificate(Consumer<RegisterCertificateRequest.Builder> 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.
This is a convenience which creates an instance of the
RegisterCertificateRequest.Builder
avoiding the need to create one manually viaRegisterCertificateRequest.builder()
- Parameters:
registerCertificateRequest
- AConsumer
that will call methods onRegisterCertificateRequest.Builder
to create a request. The input to the RegisterCertificate operation.- Returns:
- A Java Future containing the result of the RegisterCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
registerCertificateWithoutCA
default CompletableFuture<RegisterCertificateWithoutCaResponse> registerCertificateWithoutCA(RegisterCertificateWithoutCaRequest registerCertificateWithoutCaRequest) Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.
- Parameters:
registerCertificateWithoutCaRequest
-- Returns:
- A Java Future containing the result of the RegisterCertificateWithoutCA operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
registerCertificateWithoutCA
default CompletableFuture<RegisterCertificateWithoutCaResponse> registerCertificateWithoutCA(Consumer<RegisterCertificateWithoutCaRequest.Builder> registerCertificateWithoutCaRequest) Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.
This is a convenience which creates an instance of the
RegisterCertificateWithoutCaRequest.Builder
avoiding the need to create one manually viaRegisterCertificateWithoutCaRequest.builder()
- Parameters:
registerCertificateWithoutCaRequest
- AConsumer
that will call methods onRegisterCertificateWithoutCaRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterCertificateWithoutCA operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
registerThing
default CompletableFuture<RegisterThingResponse> 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.
- Parameters:
registerThingRequest
-- Returns:
- A Java Future containing the result of the RegisterThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
registerThing
default CompletableFuture<RegisterThingResponse> registerThing(Consumer<RegisterThingRequest.Builder> 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.
This is a convenience which creates an instance of the
RegisterThingRequest.Builder
avoiding the need to create one manually viaRegisterThingRequest.builder()
- Parameters:
registerThingRequest
- AConsumer
that will call methods onRegisterThingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
rejectCertificateTransfer
default CompletableFuture<RejectCertificateTransferResponse> 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.
- Parameters:
rejectCertificateTransferRequest
- The input for the RejectCertificateTransfer operation.- Returns:
- A Java Future containing the result of the RejectCertificateTransfer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
rejectCertificateTransfer
default CompletableFuture<RejectCertificateTransferResponse> rejectCertificateTransfer(Consumer<RejectCertificateTransferRequest.Builder> 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.
This is a convenience which creates an instance of the
RejectCertificateTransferRequest.Builder
avoiding the need to create one manually viaRejectCertificateTransferRequest.builder()
- Parameters:
rejectCertificateTransferRequest
- AConsumer
that will call methods onRejectCertificateTransferRequest.Builder
to create a request. The input for the RejectCertificateTransfer operation.- Returns:
- A Java Future containing the result of the RejectCertificateTransfer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
removeThingFromBillingGroup
default CompletableFuture<RemoveThingFromBillingGroupResponse> 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.
- Parameters:
removeThingFromBillingGroupRequest
-- Returns:
- A Java Future containing the result of the RemoveThingFromBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
removeThingFromBillingGroup
default CompletableFuture<RemoveThingFromBillingGroupResponse> removeThingFromBillingGroup(Consumer<RemoveThingFromBillingGroupRequest.Builder> 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.
This is a convenience which creates an instance of the
RemoveThingFromBillingGroupRequest.Builder
avoiding the need to create one manually viaRemoveThingFromBillingGroupRequest.builder()
- Parameters:
removeThingFromBillingGroupRequest
- AConsumer
that will call methods onRemoveThingFromBillingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveThingFromBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
removeThingFromThingGroup
default CompletableFuture<RemoveThingFromThingGroupResponse> removeThingFromThingGroup(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest) Remove the specified thing from the specified group.
You must specify either a
thingGroupArn
or athingGroupName
to identify the thing group and either athingArn
or athingName
to identify the thing to remove from the thing group.Requires permission to access the RemoveThingFromThingGroup action.
- Parameters:
removeThingFromThingGroupRequest
-- Returns:
- A Java Future containing the result of the RemoveThingFromThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
removeThingFromThingGroup
default CompletableFuture<RemoveThingFromThingGroupResponse> removeThingFromThingGroup(Consumer<RemoveThingFromThingGroupRequest.Builder> removeThingFromThingGroupRequest) Remove the specified thing from the specified group.
You must specify either a
thingGroupArn
or athingGroupName
to identify the thing group and either athingArn
or athingName
to identify the thing to remove from the thing group.Requires permission to access the RemoveThingFromThingGroup action.
This is a convenience which creates an instance of the
RemoveThingFromThingGroupRequest.Builder
avoiding the need to create one manually viaRemoveThingFromThingGroupRequest.builder()
- Parameters:
removeThingFromThingGroupRequest
- AConsumer
that will call methods onRemoveThingFromThingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveThingFromThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
replaceTopicRule
default CompletableFuture<ReplaceTopicRuleResponse> 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.
- Parameters:
replaceTopicRuleRequest
- The input for the ReplaceTopicRule operation.- Returns:
- A Java Future containing the result of the ReplaceTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
replaceTopicRule
default CompletableFuture<ReplaceTopicRuleResponse> replaceTopicRule(Consumer<ReplaceTopicRuleRequest.Builder> 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.
This is a convenience which creates an instance of the
ReplaceTopicRuleRequest.Builder
avoiding the need to create one manually viaReplaceTopicRuleRequest.builder()
- Parameters:
replaceTopicRuleRequest
- AConsumer
that will call methods onReplaceTopicRuleRequest.Builder
to create a request. The input for the ReplaceTopicRule operation.- Returns:
- A Java Future containing the result of the ReplaceTopicRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
searchIndex
The query search index.
Requires permission to access the SearchIndex action.
- Parameters:
searchIndexRequest
-- Returns:
- A Java Future containing the result of the SearchIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
searchIndex
default CompletableFuture<SearchIndexResponse> searchIndex(Consumer<SearchIndexRequest.Builder> searchIndexRequest) The query search index.
Requires permission to access the SearchIndex action.
This is a convenience which creates an instance of the
SearchIndexRequest.Builder
avoiding the need to create one manually viaSearchIndexRequest.builder()
- Parameters:
searchIndexRequest
- AConsumer
that will call methods onSearchIndexRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SearchIndex operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setDefaultAuthorizer
default CompletableFuture<SetDefaultAuthorizerResponse> 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.
- Parameters:
setDefaultAuthorizerRequest
-- Returns:
- A Java Future containing the result of the SetDefaultAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setDefaultAuthorizer
default CompletableFuture<SetDefaultAuthorizerResponse> setDefaultAuthorizer(Consumer<SetDefaultAuthorizerRequest.Builder> 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.
This is a convenience which creates an instance of the
SetDefaultAuthorizerRequest.Builder
avoiding the need to create one manually viaSetDefaultAuthorizerRequest.builder()
- Parameters:
setDefaultAuthorizerRequest
- AConsumer
that will call methods onSetDefaultAuthorizerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetDefaultAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setDefaultPolicyVersion
default CompletableFuture<SetDefaultPolicyVersionResponse> 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.
- Parameters:
setDefaultPolicyVersionRequest
- The input for the SetDefaultPolicyVersion operation.- Returns:
- A Java Future containing the result of the SetDefaultPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setDefaultPolicyVersion
default CompletableFuture<SetDefaultPolicyVersionResponse> setDefaultPolicyVersion(Consumer<SetDefaultPolicyVersionRequest.Builder> 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.
This is a convenience which creates an instance of the
SetDefaultPolicyVersionRequest.Builder
avoiding the need to create one manually viaSetDefaultPolicyVersionRequest.builder()
- Parameters:
setDefaultPolicyVersionRequest
- AConsumer
that will call methods onSetDefaultPolicyVersionRequest.Builder
to create a request. The input for the SetDefaultPolicyVersion operation.- Returns:
- A Java Future containing the result of the SetDefaultPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setLoggingOptions
default CompletableFuture<SetLoggingOptionsResponse> 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.
- Parameters:
setLoggingOptionsRequest
- The input for the SetLoggingOptions operation.- Returns:
- A Java Future containing the result of the SetLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setLoggingOptions
default CompletableFuture<SetLoggingOptionsResponse> setLoggingOptions(Consumer<SetLoggingOptionsRequest.Builder> setLoggingOptionsRequest) Sets the logging options.
NOTE: use of this command is not recommended. Use
SetV2LoggingOptions
instead.Requires permission to access the SetLoggingOptions action.
This is a convenience which creates an instance of the
SetLoggingOptionsRequest.Builder
avoiding the need to create one manually viaSetLoggingOptionsRequest.builder()
- Parameters:
setLoggingOptionsRequest
- AConsumer
that will call methods onSetLoggingOptionsRequest.Builder
to create a request. The input for the SetLoggingOptions operation.- Returns:
- A Java Future containing the result of the SetLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setV2LoggingLevel
default CompletableFuture<SetV2LoggingLevelResponse> setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest) Sets the logging level.
Requires permission to access the SetV2LoggingLevel action.
- Parameters:
setV2LoggingLevelRequest
-- Returns:
- A Java Future containing the result of the SetV2LoggingLevel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setV2LoggingLevel
default CompletableFuture<SetV2LoggingLevelResponse> setV2LoggingLevel(Consumer<SetV2LoggingLevelRequest.Builder> setV2LoggingLevelRequest) Sets the logging level.
Requires permission to access the SetV2LoggingLevel action.
This is a convenience which creates an instance of the
SetV2LoggingLevelRequest.Builder
avoiding the need to create one manually viaSetV2LoggingLevelRequest.builder()
- Parameters:
setV2LoggingLevelRequest
- AConsumer
that will call methods onSetV2LoggingLevelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetV2LoggingLevel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setV2LoggingOptions
default CompletableFuture<SetV2LoggingOptionsResponse> setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest) Sets the logging options for the V2 logging service.
Requires permission to access the SetV2LoggingOptions action.
- Parameters:
setV2LoggingOptionsRequest
-- Returns:
- A Java Future containing the result of the SetV2LoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
setV2LoggingOptions
default CompletableFuture<SetV2LoggingOptionsResponse> setV2LoggingOptions(Consumer<SetV2LoggingOptionsRequest.Builder> setV2LoggingOptionsRequest) Sets the logging options for the V2 logging service.
Requires permission to access the SetV2LoggingOptions action.
This is a convenience which creates an instance of the
SetV2LoggingOptionsRequest.Builder
avoiding the need to create one manually viaSetV2LoggingOptionsRequest.builder()
- Parameters:
setV2LoggingOptionsRequest
- AConsumer
that will call methods onSetV2LoggingOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetV2LoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalException An unexpected error has occurred.
- InvalidRequestException The request is not valid.
- ServiceUnavailableException The service is temporarily unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startAuditMitigationActionsTask
default CompletableFuture<StartAuditMitigationActionsTaskResponse> startAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest startAuditMitigationActionsTaskRequest) Starts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
- Parameters:
startAuditMitigationActionsTaskRequest
-- Returns:
- A Java Future containing the result of the StartAuditMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startAuditMitigationActionsTask
default CompletableFuture<StartAuditMitigationActionsTaskResponse> startAuditMitigationActionsTask(Consumer<StartAuditMitigationActionsTaskRequest.Builder> startAuditMitigationActionsTaskRequest) Starts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
This is a convenience which creates an instance of the
StartAuditMitigationActionsTaskRequest.Builder
avoiding the need to create one manually viaStartAuditMitigationActionsTaskRequest.builder()
- Parameters:
startAuditMitigationActionsTaskRequest
- AConsumer
that will call methods onStartAuditMitigationActionsTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartAuditMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startDetectMitigationActionsTask
default CompletableFuture<StartDetectMitigationActionsTaskResponse> startDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest startDetectMitigationActionsTaskRequest) Starts a Device Defender ML Detect mitigation actions task.
Requires permission to access the StartDetectMitigationActionsTask action.
- Parameters:
startDetectMitigationActionsTaskRequest
-- Returns:
- A Java Future containing the result of the StartDetectMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startDetectMitigationActionsTask
default CompletableFuture<StartDetectMitigationActionsTaskResponse> startDetectMitigationActionsTask(Consumer<StartDetectMitigationActionsTaskRequest.Builder> startDetectMitigationActionsTaskRequest) Starts a Device Defender ML Detect mitigation actions task.
Requires permission to access the StartDetectMitigationActionsTask action.
This is a convenience which creates an instance of the
StartDetectMitigationActionsTaskRequest.Builder
avoiding the need to create one manually viaStartDetectMitigationActionsTaskRequest.builder()
- Parameters:
startDetectMitigationActionsTaskRequest
- AConsumer
that will call methods onStartDetectMitigationActionsTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartDetectMitigationActionsTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startOnDemandAuditTask
default CompletableFuture<StartOnDemandAuditTaskResponse> startOnDemandAuditTask(StartOnDemandAuditTaskRequest startOnDemandAuditTaskRequest) Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
- Parameters:
startOnDemandAuditTaskRequest
-- Returns:
- A Java Future containing the result of the StartOnDemandAuditTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- LimitExceededException A limit has been exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startOnDemandAuditTask
default CompletableFuture<StartOnDemandAuditTaskResponse> startOnDemandAuditTask(Consumer<StartOnDemandAuditTaskRequest.Builder> startOnDemandAuditTaskRequest) Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
This is a convenience which creates an instance of the
StartOnDemandAuditTaskRequest.Builder
avoiding the need to create one manually viaStartOnDemandAuditTaskRequest.builder()
- Parameters:
startOnDemandAuditTaskRequest
- AConsumer
that will call methods onStartOnDemandAuditTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartOnDemandAuditTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- LimitExceededException A limit has been exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startThingRegistrationTask
default CompletableFuture<StartThingRegistrationTaskResponse> startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest) Creates a bulk thing provisioning task.
Requires permission to access the StartThingRegistrationTask action.
- Parameters:
startThingRegistrationTaskRequest
-- Returns:
- A Java Future containing the result of the StartThingRegistrationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startThingRegistrationTask
default CompletableFuture<StartThingRegistrationTaskResponse> startThingRegistrationTask(Consumer<StartThingRegistrationTaskRequest.Builder> startThingRegistrationTaskRequest) Creates a bulk thing provisioning task.
Requires permission to access the StartThingRegistrationTask action.
This is a convenience which creates an instance of the
StartThingRegistrationTaskRequest.Builder
avoiding the need to create one manually viaStartThingRegistrationTaskRequest.builder()
- Parameters:
startThingRegistrationTaskRequest
- AConsumer
that will call methods onStartThingRegistrationTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartThingRegistrationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
stopThingRegistrationTask
default CompletableFuture<StopThingRegistrationTaskResponse> stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest) Cancels a bulk thing provisioning task.
Requires permission to access the StopThingRegistrationTask action.
- Parameters:
stopThingRegistrationTaskRequest
-- Returns:
- A Java Future containing the result of the StopThingRegistrationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
stopThingRegistrationTask
default CompletableFuture<StopThingRegistrationTaskResponse> stopThingRegistrationTask(Consumer<StopThingRegistrationTaskRequest.Builder> stopThingRegistrationTaskRequest) Cancels a bulk thing provisioning task.
Requires permission to access the StopThingRegistrationTask action.
This is a convenience which creates an instance of the
StopThingRegistrationTaskRequest.Builder
avoiding the need to create one manually viaStopThingRegistrationTaskRequest.builder()
- Parameters:
stopThingRegistrationTaskRequest
- AConsumer
that will call methods onStopThingRegistrationTaskRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopThingRegistrationTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
testAuthorization
default CompletableFuture<TestAuthorizationResponse> 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.
- Parameters:
testAuthorizationRequest
-- Returns:
- A Java Future containing the result of the TestAuthorization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
testAuthorization
default CompletableFuture<TestAuthorizationResponse> testAuthorization(Consumer<TestAuthorizationRequest.Builder> 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.
This is a convenience which creates an instance of the
TestAuthorizationRequest.Builder
avoiding the need to create one manually viaTestAuthorizationRequest.builder()
- Parameters:
testAuthorizationRequest
- AConsumer
that will call methods onTestAuthorizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestAuthorization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
testInvokeAuthorizer
default CompletableFuture<TestInvokeAuthorizerResponse> 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.
- Parameters:
testInvokeAuthorizerRequest
-- Returns:
- A Java Future containing the result of the TestInvokeAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
testInvokeAuthorizer
default CompletableFuture<TestInvokeAuthorizerResponse> testInvokeAuthorizer(Consumer<TestInvokeAuthorizerRequest.Builder> 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.
This is a convenience which creates an instance of the
TestInvokeAuthorizerRequest.Builder
avoiding the need to create one manually viaTestInvokeAuthorizerRequest.builder()
- Parameters:
testInvokeAuthorizerRequest
- AConsumer
that will call methods onTestInvokeAuthorizerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TestInvokeAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
transferCertificate
default CompletableFuture<TransferCertificateResponse> 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.
- Parameters:
transferCertificateRequest
- The input for the TransferCertificate operation.- Returns:
- A Java Future containing the result of the TransferCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
transferCertificate
default CompletableFuture<TransferCertificateResponse> transferCertificate(Consumer<TransferCertificateRequest.Builder> 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.
This is a convenience which creates an instance of the
TransferCertificateRequest.Builder
avoiding the need to create one manually viaTransferCertificateRequest.builder()
- Parameters:
transferCertificateRequest
- AConsumer
that will call methods onTransferCertificateRequest.Builder
to create a request. The input for the TransferCertificate operation.- Returns:
- A Java Future containing the result of the TransferCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the given tags (metadata) from the resource.
Requires permission to access the UntagResource action.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the given tags (metadata) from the resource.
Requires permission to access the UntagResource action.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateAccountAuditConfiguration
default CompletableFuture<UpdateAccountAuditConfigurationResponse> 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.
- Parameters:
updateAccountAuditConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateAccountAuditConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateAccountAuditConfiguration
default CompletableFuture<UpdateAccountAuditConfigurationResponse> updateAccountAuditConfiguration(Consumer<UpdateAccountAuditConfigurationRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateAccountAuditConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateAccountAuditConfigurationRequest.builder()
- Parameters:
updateAccountAuditConfigurationRequest
- AConsumer
that will call methods onUpdateAccountAuditConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAccountAuditConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateAuditSuppression
default CompletableFuture<UpdateAuditSuppressionResponse> updateAuditSuppression(UpdateAuditSuppressionRequest updateAuditSuppressionRequest) Updates a Device Defender audit suppression.
- Parameters:
updateAuditSuppressionRequest
-- Returns:
- A Java Future containing the result of the UpdateAuditSuppression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateAuditSuppression
default CompletableFuture<UpdateAuditSuppressionResponse> updateAuditSuppression(Consumer<UpdateAuditSuppressionRequest.Builder> updateAuditSuppressionRequest) Updates a Device Defender audit suppression.
This is a convenience which creates an instance of the
UpdateAuditSuppressionRequest.Builder
avoiding the need to create one manually viaUpdateAuditSuppressionRequest.builder()
- Parameters:
updateAuditSuppressionRequest
- AConsumer
that will call methods onUpdateAuditSuppressionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAuditSuppression operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateAuthorizer
default CompletableFuture<UpdateAuthorizerResponse> updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest) Updates an authorizer.
Requires permission to access the UpdateAuthorizer action.
- Parameters:
updateAuthorizerRequest
-- Returns:
- A Java Future containing the result of the UpdateAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateAuthorizer
default CompletableFuture<UpdateAuthorizerResponse> updateAuthorizer(Consumer<UpdateAuthorizerRequest.Builder> updateAuthorizerRequest) Updates an authorizer.
Requires permission to access the UpdateAuthorizer action.
This is a convenience which creates an instance of the
UpdateAuthorizerRequest.Builder
avoiding the need to create one manually viaUpdateAuthorizerRequest.builder()
- Parameters:
updateAuthorizerRequest
- AConsumer
that will call methods onUpdateAuthorizerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAuthorizer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateBillingGroup
default CompletableFuture<UpdateBillingGroupResponse> updateBillingGroup(UpdateBillingGroupRequest updateBillingGroupRequest) Updates information about the billing group.
Requires permission to access the UpdateBillingGroup action.
- Parameters:
updateBillingGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateBillingGroup
default CompletableFuture<UpdateBillingGroupResponse> updateBillingGroup(Consumer<UpdateBillingGroupRequest.Builder> updateBillingGroupRequest) Updates information about the billing group.
Requires permission to access the UpdateBillingGroup action.
This is a convenience which creates an instance of the
UpdateBillingGroupRequest.Builder
avoiding the need to create one manually viaUpdateBillingGroupRequest.builder()
- Parameters:
updateBillingGroupRequest
- AConsumer
that will call methods onUpdateBillingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateBillingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateCACertificate
default CompletableFuture<UpdateCaCertificateResponse> updateCACertificate(UpdateCaCertificateRequest updateCaCertificateRequest) Updates a registered CA certificate.
Requires permission to access the UpdateCACertificate action.
- Parameters:
updateCaCertificateRequest
- The input to the UpdateCACertificate operation.- Returns:
- A Java Future containing the result of the UpdateCACertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateCACertificate
default CompletableFuture<UpdateCaCertificateResponse> updateCACertificate(Consumer<UpdateCaCertificateRequest.Builder> updateCaCertificateRequest) Updates a registered CA certificate.
Requires permission to access the UpdateCACertificate action.
This is a convenience which creates an instance of the
UpdateCaCertificateRequest.Builder
avoiding the need to create one manually viaUpdateCaCertificateRequest.builder()
- Parameters:
updateCaCertificateRequest
- AConsumer
that will call methods onUpdateCaCertificateRequest.Builder
to create a request. The input to the UpdateCACertificate operation.- Returns:
- A Java Future containing the result of the UpdateCACertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateCertificate
default CompletableFuture<UpdateCertificateResponse> 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.
- Parameters:
updateCertificateRequest
- The input for the UpdateCertificate operation.- Returns:
- A Java Future containing the result of the UpdateCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateCertificate
default CompletableFuture<UpdateCertificateResponse> updateCertificate(Consumer<UpdateCertificateRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateCertificateRequest.Builder
avoiding the need to create one manually viaUpdateCertificateRequest.builder()
- Parameters:
updateCertificateRequest
- AConsumer
that will call methods onUpdateCertificateRequest.Builder
to create a request. The input for the UpdateCertificate operation.- Returns:
- A Java Future containing the result of the UpdateCertificate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateCertificateProvider
default CompletableFuture<UpdateCertificateProviderResponse> updateCertificateProvider(UpdateCertificateProviderRequest updateCertificateProviderRequest) Updates a certificate provider.
Requires permission to access the UpdateCertificateProvider action.
- Parameters:
updateCertificateProviderRequest
-- Returns:
- A Java Future containing the result of the UpdateCertificateProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateCertificateProvider
default CompletableFuture<UpdateCertificateProviderResponse> updateCertificateProvider(Consumer<UpdateCertificateProviderRequest.Builder> updateCertificateProviderRequest) Updates a certificate provider.
Requires permission to access the UpdateCertificateProvider action.
This is a convenience which creates an instance of the
UpdateCertificateProviderRequest.Builder
avoiding the need to create one manually viaUpdateCertificateProviderRequest.builder()
- Parameters:
updateCertificateProviderRequest
- AConsumer
that will call methods onUpdateCertificateProviderRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCertificateProvider operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateCustomMetric
default CompletableFuture<UpdateCustomMetricResponse> updateCustomMetric(UpdateCustomMetricRequest updateCustomMetricRequest) Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
- Parameters:
updateCustomMetricRequest
-- Returns:
- A Java Future containing the result of the UpdateCustomMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateCustomMetric
default CompletableFuture<UpdateCustomMetricResponse> updateCustomMetric(Consumer<UpdateCustomMetricRequest.Builder> updateCustomMetricRequest) Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
This is a convenience which creates an instance of the
UpdateCustomMetricRequest.Builder
avoiding the need to create one manually viaUpdateCustomMetricRequest.builder()
- Parameters:
updateCustomMetricRequest
- AConsumer
that will call methods onUpdateCustomMetricRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCustomMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateDimension
default CompletableFuture<UpdateDimensionResponse> 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.
- Parameters:
updateDimensionRequest
-- Returns:
- A Java Future containing the result of the UpdateDimension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateDimension
default CompletableFuture<UpdateDimensionResponse> updateDimension(Consumer<UpdateDimensionRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateDimensionRequest.Builder
avoiding the need to create one manually viaUpdateDimensionRequest.builder()
- Parameters:
updateDimensionRequest
- AConsumer
that will call methods onUpdateDimensionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDimension operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateDomainConfiguration
default CompletableFuture<UpdateDomainConfigurationResponse> 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.
- Parameters:
updateDomainConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateDomainConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateDomainConfiguration
default CompletableFuture<UpdateDomainConfigurationResponse> updateDomainConfiguration(Consumer<UpdateDomainConfigurationRequest.Builder> updateDomainConfigurationRequest) Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.
Requires permission to access the UpdateDomainConfiguration action.
This is a convenience which creates an instance of the
UpdateDomainConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateDomainConfigurationRequest.builder()
- Parameters:
updateDomainConfigurationRequest
- AConsumer
that will call methods onUpdateDomainConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDomainConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateDynamicThingGroup
default CompletableFuture<UpdateDynamicThingGroupResponse> updateDynamicThingGroup(UpdateDynamicThingGroupRequest updateDynamicThingGroupRequest) Updates a dynamic thing group.
Requires permission to access the UpdateDynamicThingGroup action.
- Parameters:
updateDynamicThingGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateDynamicThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateDynamicThingGroup
default CompletableFuture<UpdateDynamicThingGroupResponse> updateDynamicThingGroup(Consumer<UpdateDynamicThingGroupRequest.Builder> updateDynamicThingGroupRequest) Updates a dynamic thing group.
Requires permission to access the UpdateDynamicThingGroup action.
This is a convenience which creates an instance of the
UpdateDynamicThingGroupRequest.Builder
avoiding the need to create one manually viaUpdateDynamicThingGroupRequest.builder()
- Parameters:
updateDynamicThingGroupRequest
- AConsumer
that will call methods onUpdateDynamicThingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDynamicThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateEventConfigurations
default CompletableFuture<UpdateEventConfigurationsResponse> updateEventConfigurations(UpdateEventConfigurationsRequest updateEventConfigurationsRequest) Updates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
- Parameters:
updateEventConfigurationsRequest
-- Returns:
- A Java Future containing the result of the UpdateEventConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- InternalFailureException An unexpected error has occurred.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateEventConfigurations
default CompletableFuture<UpdateEventConfigurationsResponse> updateEventConfigurations(Consumer<UpdateEventConfigurationsRequest.Builder> updateEventConfigurationsRequest) Updates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
This is a convenience which creates an instance of the
UpdateEventConfigurationsRequest.Builder
avoiding the need to create one manually viaUpdateEventConfigurationsRequest.builder()
- Parameters:
updateEventConfigurationsRequest
- AConsumer
that will call methods onUpdateEventConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEventConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- InternalFailureException An unexpected error has occurred.
- ThrottlingException The rate exceeds the limit.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateFleetMetric
default CompletableFuture<UpdateFleetMetricResponse> updateFleetMetric(UpdateFleetMetricRequest updateFleetMetricRequest) Updates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
- Parameters:
updateFleetMetricRequest
-- Returns:
- A Java Future containing the result of the UpdateFleetMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateFleetMetric
default CompletableFuture<UpdateFleetMetricResponse> updateFleetMetric(Consumer<UpdateFleetMetricRequest.Builder> updateFleetMetricRequest) Updates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
This is a convenience which creates an instance of the
UpdateFleetMetricRequest.Builder
avoiding the need to create one manually viaUpdateFleetMetricRequest.builder()
- Parameters:
updateFleetMetricRequest
- AConsumer
that will call methods onUpdateFleetMetricRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateFleetMetric operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateIndexingConfiguration
default CompletableFuture<UpdateIndexingConfigurationResponse> updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest) Updates the search configuration.
Requires permission to access the UpdateIndexingConfiguration action.
- Parameters:
updateIndexingConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateIndexingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateIndexingConfiguration
default CompletableFuture<UpdateIndexingConfigurationResponse> updateIndexingConfiguration(Consumer<UpdateIndexingConfigurationRequest.Builder> updateIndexingConfigurationRequest) Updates the search configuration.
Requires permission to access the UpdateIndexingConfiguration action.
This is a convenience which creates an instance of the
UpdateIndexingConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateIndexingConfigurationRequest.builder()
- Parameters:
updateIndexingConfigurationRequest
- AConsumer
that will call methods onUpdateIndexingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateIndexingConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateJob
Updates supported fields of the specified job.
Requires permission to access the UpdateJob action.
- Parameters:
updateJobRequest
-- Returns:
- A Java Future containing the result of the UpdateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateJob
default CompletableFuture<UpdateJobResponse> updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest) Updates supported fields of the specified job.
Requires permission to access the UpdateJob action.
This is a convenience which creates an instance of the
UpdateJobRequest.Builder
avoiding the need to create one manually viaUpdateJobRequest.builder()
- Parameters:
updateJobRequest
- AConsumer
that will call methods onUpdateJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateMitigationAction
default CompletableFuture<UpdateMitigationActionResponse> updateMitigationAction(UpdateMitigationActionRequest updateMitigationActionRequest) Updates the definition for the specified mitigation action.
Requires permission to access the UpdateMitigationAction action.
- Parameters:
updateMitigationActionRequest
-- Returns:
- A Java Future containing the result of the UpdateMitigationAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateMitigationAction
default CompletableFuture<UpdateMitigationActionResponse> updateMitigationAction(Consumer<UpdateMitigationActionRequest.Builder> updateMitigationActionRequest) Updates the definition for the specified mitigation action.
Requires permission to access the UpdateMitigationAction action.
This is a convenience which creates an instance of the
UpdateMitigationActionRequest.Builder
avoiding the need to create one manually viaUpdateMitigationActionRequest.builder()
- Parameters:
updateMitigationActionRequest
- AConsumer
that will call methods onUpdateMitigationActionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMitigationAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updatePackage
default CompletableFuture<UpdatePackageResponse> updatePackage(UpdatePackageRequest updatePackageRequest) Updates the supported fields for a specific software package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
- Parameters:
updatePackageRequest
-- Returns:
- A Java Future containing the result of the UpdatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updatePackage
default CompletableFuture<UpdatePackageResponse> updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest) Updates the supported fields for a specific software package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
This is a convenience which creates an instance of the
UpdatePackageRequest.Builder
avoiding the need to create one manually viaUpdatePackageRequest.builder()
- Parameters:
updatePackageRequest
- AConsumer
that will call methods onUpdatePackageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updatePackageConfiguration
default CompletableFuture<UpdatePackageConfigurationResponse> updatePackageConfiguration(UpdatePackageConfigurationRequest updatePackageConfigurationRequest) Updates the software package configuration.
Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
- Parameters:
updatePackageConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdatePackageConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updatePackageConfiguration
default CompletableFuture<UpdatePackageConfigurationResponse> updatePackageConfiguration(Consumer<UpdatePackageConfigurationRequest.Builder> updatePackageConfigurationRequest) Updates the software package configuration.
Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
This is a convenience which creates an instance of the
UpdatePackageConfigurationRequest.Builder
avoiding the need to create one manually viaUpdatePackageConfigurationRequest.builder()
- Parameters:
updatePackageConfigurationRequest
- AConsumer
that will call methods onUpdatePackageConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePackageConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updatePackageVersion
default CompletableFuture<UpdatePackageVersionResponse> updatePackageVersion(UpdatePackageVersionRequest updatePackageVersionRequest) Updates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
- Parameters:
updatePackageVersionRequest
-- Returns:
- A Java Future containing the result of the UpdatePackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updatePackageVersion
default CompletableFuture<UpdatePackageVersionResponse> updatePackageVersion(Consumer<UpdatePackageVersionRequest.Builder> updatePackageVersionRequest) Updates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
This is a convenience which creates an instance of the
UpdatePackageVersionRequest.Builder
avoiding the need to create one manually viaUpdatePackageVersionRequest.builder()
- Parameters:
updatePackageVersionRequest
- AConsumer
that will call methods onUpdatePackageVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePackageVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateProvisioningTemplate
default CompletableFuture<UpdateProvisioningTemplateResponse> updateProvisioningTemplate(UpdateProvisioningTemplateRequest updateProvisioningTemplateRequest) Updates a provisioning template.
Requires permission to access the UpdateProvisioningTemplate action.
- Parameters:
updateProvisioningTemplateRequest
-- Returns:
- A Java Future containing the result of the UpdateProvisioningTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateProvisioningTemplate
default CompletableFuture<UpdateProvisioningTemplateResponse> updateProvisioningTemplate(Consumer<UpdateProvisioningTemplateRequest.Builder> updateProvisioningTemplateRequest) Updates a provisioning template.
Requires permission to access the UpdateProvisioningTemplate action.
This is a convenience which creates an instance of the
UpdateProvisioningTemplateRequest.Builder
avoiding the need to create one manually viaUpdateProvisioningTemplateRequest.builder()
- Parameters:
updateProvisioningTemplateRequest
- AConsumer
that will call methods onUpdateProvisioningTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProvisioningTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateRoleAlias
default CompletableFuture<UpdateRoleAliasResponse> updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest) Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
The value of
credentialDurationSeconds
must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.- Parameters:
updateRoleAliasRequest
-- Returns:
- A Java Future containing the result of the UpdateRoleAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateRoleAlias
default CompletableFuture<UpdateRoleAliasResponse> updateRoleAlias(Consumer<UpdateRoleAliasRequest.Builder> updateRoleAliasRequest) Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
The value of
credentialDurationSeconds
must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.
This is a convenience which creates an instance of the
UpdateRoleAliasRequest.Builder
avoiding the need to create one manually viaUpdateRoleAliasRequest.builder()
- Parameters:
updateRoleAliasRequest
- AConsumer
that will call methods onUpdateRoleAliasRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateRoleAlias operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateScheduledAudit
default CompletableFuture<UpdateScheduledAuditResponse> 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.
- Parameters:
updateScheduledAuditRequest
-- Returns:
- A Java Future containing the result of the UpdateScheduledAudit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateScheduledAudit
default CompletableFuture<UpdateScheduledAuditResponse> updateScheduledAudit(Consumer<UpdateScheduledAuditRequest.Builder> updateScheduledAuditRequest) Updates a scheduled audit, including which checks are performed and how often the audit takes place.
Requires permission to access the UpdateScheduledAudit action.
This is a convenience which creates an instance of the
UpdateScheduledAuditRequest.Builder
avoiding the need to create one manually viaUpdateScheduledAuditRequest.builder()
- Parameters:
updateScheduledAuditRequest
- AConsumer
that will call methods onUpdateScheduledAuditRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateScheduledAudit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateSecurityProfile
default CompletableFuture<UpdateSecurityProfileResponse> updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest) Updates a Device Defender security profile.
Requires permission to access the UpdateSecurityProfile action.
- Parameters:
updateSecurityProfileRequest
-- Returns:
- A Java Future containing the result of the UpdateSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateSecurityProfile
default CompletableFuture<UpdateSecurityProfileResponse> updateSecurityProfile(Consumer<UpdateSecurityProfileRequest.Builder> updateSecurityProfileRequest) Updates a Device Defender security profile.
Requires permission to access the UpdateSecurityProfile action.
This is a convenience which creates an instance of the
UpdateSecurityProfileRequest.Builder
avoiding the need to create one manually viaUpdateSecurityProfileRequest.builder()
- Parameters:
updateSecurityProfileRequest
- AConsumer
that will call methods onUpdateSecurityProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSecurityProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateStream
default CompletableFuture<UpdateStreamResponse> updateStream(UpdateStreamRequest updateStreamRequest) Updates an existing stream. The stream version will be incremented by one.
Requires permission to access the UpdateStream action.
- Parameters:
updateStreamRequest
-- Returns:
- A Java Future containing the result of the UpdateStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- LimitExceededException A limit has been exceeded.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateStream
default CompletableFuture<UpdateStreamResponse> updateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest) Updates an existing stream. The stream version will be incremented by one.
Requires permission to access the UpdateStream action.
This is a convenience which creates an instance of the
UpdateStreamRequest.Builder
avoiding the need to create one manually viaUpdateStreamRequest.builder()
- Parameters:
updateStreamRequest
- AConsumer
that will call methods onUpdateStreamRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- LimitExceededException A limit has been exceeded.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateThing
Updates the data for a thing.
Requires permission to access the UpdateThing action.
- Parameters:
updateThingRequest
- The input for the UpdateThing operation.- Returns:
- A Java Future containing the result of the UpdateThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateThing
default CompletableFuture<UpdateThingResponse> updateThing(Consumer<UpdateThingRequest.Builder> updateThingRequest) Updates the data for a thing.
Requires permission to access the UpdateThing action.
This is a convenience which creates an instance of the
UpdateThingRequest.Builder
avoiding the need to create one manually viaUpdateThingRequest.builder()
- Parameters:
updateThingRequest
- AConsumer
that will call methods onUpdateThingRequest.Builder
to create a request. The input for the UpdateThing operation.- Returns:
- A Java Future containing the result of the UpdateThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateThingGroup
default CompletableFuture<UpdateThingGroupResponse> updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest) Update a thing group.
Requires permission to access the UpdateThingGroup action.
- Parameters:
updateThingGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateThingGroup
default CompletableFuture<UpdateThingGroupResponse> updateThingGroup(Consumer<UpdateThingGroupRequest.Builder> updateThingGroupRequest) Update a thing group.
Requires permission to access the UpdateThingGroup action.
This is a convenience which creates an instance of the
UpdateThingGroupRequest.Builder
avoiding the need to create one manually viaUpdateThingGroupRequest.builder()
- Parameters:
updateThingGroupRequest
- AConsumer
that will call methods onUpdateThingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateThingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateThingGroupsForThing
default CompletableFuture<UpdateThingGroupsForThingResponse> updateThingGroupsForThing(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest) Updates the groups to which the thing belongs.
Requires permission to access the UpdateThingGroupsForThing action.
- Parameters:
updateThingGroupsForThingRequest
-- Returns:
- A Java Future containing the result of the UpdateThingGroupsForThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateThingGroupsForThing
default CompletableFuture<UpdateThingGroupsForThingResponse> updateThingGroupsForThing(Consumer<UpdateThingGroupsForThingRequest.Builder> updateThingGroupsForThingRequest) Updates the groups to which the thing belongs.
Requires permission to access the UpdateThingGroupsForThing action.
This is a convenience which creates an instance of the
UpdateThingGroupsForThingRequest.Builder
avoiding the need to create one manually viaUpdateThingGroupsForThingRequest.builder()
- Parameters:
updateThingGroupsForThingRequest
- AConsumer
that will call methods onUpdateThingGroupsForThingRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateThingGroupsForThing operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateTopicRuleDestination
default CompletableFuture<UpdateTopicRuleDestinationResponse> 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.
- Parameters:
updateTopicRuleDestinationRequest
-- Returns:
- A Java Future containing the result of the UpdateTopicRuleDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateTopicRuleDestination
default CompletableFuture<UpdateTopicRuleDestinationResponse> updateTopicRuleDestination(Consumer<UpdateTopicRuleDestinationRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateTopicRuleDestinationRequest.Builder
avoiding the need to create one manually viaUpdateTopicRuleDestinationRequest.builder()
- Parameters:
updateTopicRuleDestinationRequest
- AConsumer
that will call methods onUpdateTopicRuleDestinationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateTopicRuleDestination operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
validateSecurityProfileBehaviors
default CompletableFuture<ValidateSecurityProfileBehaviorsResponse> validateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest validateSecurityProfileBehaviorsRequest) Validates a Device Defender security profile behaviors specification.
Requires permission to access the ValidateSecurityProfileBehaviors action.
- Parameters:
validateSecurityProfileBehaviorsRequest
-- Returns:
- A Java Future containing the result of the ValidateSecurityProfileBehaviors operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
validateSecurityProfileBehaviors
default CompletableFuture<ValidateSecurityProfileBehaviorsResponse> validateSecurityProfileBehaviors(Consumer<ValidateSecurityProfileBehaviorsRequest.Builder> validateSecurityProfileBehaviorsRequest) Validates a Device Defender security profile behaviors specification.
Requires permission to access the ValidateSecurityProfileBehaviors action.
This is a convenience which creates an instance of the
ValidateSecurityProfileBehaviorsRequest.Builder
avoiding the need to create one manually viaValidateSecurityProfileBehaviorsRequest.builder()
- Parameters:
validateSecurityProfileBehaviorsRequest
- AConsumer
that will call methods onValidateSecurityProfileBehaviorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ValidateSecurityProfileBehaviors operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is not valid.
- ThrottlingException The rate exceeds the limit.
- InternalFailureException An unexpected error has occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aIotAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIotAsyncClient
.
-