Interface IotClient
-
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface IotClient extends AwsClient
Service client for accessing AWS IoT. This can be created using the staticbuilder()
method.IoT 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
Fields Modifier and Type Field Description static String
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.static String
SERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AcceptCertificateTransferResponse
acceptCertificateTransfer(Consumer<AcceptCertificateTransferRequest.Builder> acceptCertificateTransferRequest)
Accepts a pending certificate transfer.default AcceptCertificateTransferResponse
acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest)
Accepts a pending certificate transfer.default AddThingToBillingGroupResponse
addThingToBillingGroup(Consumer<AddThingToBillingGroupRequest.Builder> addThingToBillingGroupRequest)
Adds a thing to a billing group.default AddThingToBillingGroupResponse
addThingToBillingGroup(AddThingToBillingGroupRequest addThingToBillingGroupRequest)
Adds a thing to a billing group.default AddThingToThingGroupResponse
addThingToThingGroup(Consumer<AddThingToThingGroupRequest.Builder> addThingToThingGroupRequest)
Adds a thing to a thing group.default AddThingToThingGroupResponse
addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest)
Adds a thing to a thing group.default AssociateTargetsWithJobResponse
associateTargetsWithJob(Consumer<AssociateTargetsWithJobRequest.Builder> associateTargetsWithJobRequest)
Associates a group with a continuous job.default AssociateTargetsWithJobResponse
associateTargetsWithJob(AssociateTargetsWithJobRequest associateTargetsWithJobRequest)
Associates a group with a continuous job.default AttachPolicyResponse
attachPolicy(Consumer<AttachPolicyRequest.Builder> attachPolicyRequest)
Attaches the specified policy to the specified principal (certificate or other credential).default AttachPolicyResponse
attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches the specified policy to the specified principal (certificate or other credential).default AttachSecurityProfileResponse
attachSecurityProfile(Consumer<AttachSecurityProfileRequest.Builder> attachSecurityProfileRequest)
Associates a Device Defender security profile with a thing group or this account.default AttachSecurityProfileResponse
attachSecurityProfile(AttachSecurityProfileRequest attachSecurityProfileRequest)
Associates a Device Defender security profile with a thing group or this account.default AttachThingPrincipalResponse
attachThingPrincipal(Consumer<AttachThingPrincipalRequest.Builder> attachThingPrincipalRequest)
Attaches the specified principal to the specified thing.default AttachThingPrincipalResponse
attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest)
Attaches the specified principal to the specified thing.static IotClientBuilder
builder()
Create a builder that can be used to configure and create aIotClient
.default CancelAuditMitigationActionsTaskResponse
cancelAuditMitigationActionsTask(Consumer<CancelAuditMitigationActionsTaskRequest.Builder> cancelAuditMitigationActionsTaskRequest)
Cancels a mitigation action task that is in progress.default CancelAuditMitigationActionsTaskResponse
cancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest cancelAuditMitigationActionsTaskRequest)
Cancels a mitigation action task that is in progress.default CancelAuditTaskResponse
cancelAuditTask(Consumer<CancelAuditTaskRequest.Builder> cancelAuditTaskRequest)
Cancels an audit that is in progress.default CancelAuditTaskResponse
cancelAuditTask(CancelAuditTaskRequest cancelAuditTaskRequest)
Cancels an audit that is in progress.default CancelCertificateTransferResponse
cancelCertificateTransfer(Consumer<CancelCertificateTransferRequest.Builder> cancelCertificateTransferRequest)
Cancels a pending transfer for the specified certificate.default CancelCertificateTransferResponse
cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest)
Cancels a pending transfer for the specified certificate.default CancelDetectMitigationActionsTaskResponse
cancelDetectMitigationActionsTask(Consumer<CancelDetectMitigationActionsTaskRequest.Builder> cancelDetectMitigationActionsTaskRequest)
Cancels a Device Defender ML Detect mitigation action.default CancelDetectMitigationActionsTaskResponse
cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest)
Cancels a Device Defender ML Detect mitigation action.default CancelJobResponse
cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest)
Cancels a job.default CancelJobResponse
cancelJob(CancelJobRequest cancelJobRequest)
Cancels a job.default CancelJobExecutionResponse
cancelJobExecution(Consumer<CancelJobExecutionRequest.Builder> cancelJobExecutionRequest)
Cancels the execution of a job for a given thing.default CancelJobExecutionResponse
cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest)
Cancels the execution of a job for a given thing.default ClearDefaultAuthorizerResponse
clearDefaultAuthorizer()
Clears the default authorizer.default ClearDefaultAuthorizerResponse
clearDefaultAuthorizer(Consumer<ClearDefaultAuthorizerRequest.Builder> clearDefaultAuthorizerRequest)
Clears the default authorizer.default ClearDefaultAuthorizerResponse
clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest)
Clears the default authorizer.default ConfirmTopicRuleDestinationResponse
confirmTopicRuleDestination(Consumer<ConfirmTopicRuleDestinationRequest.Builder> confirmTopicRuleDestinationRequest)
Confirms a topic rule destination.default ConfirmTopicRuleDestinationResponse
confirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest)
Confirms a topic rule destination.static IotClient
create()
Create aIotClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAuditSuppressionResponse
createAuditSuppression(Consumer<CreateAuditSuppressionRequest.Builder> createAuditSuppressionRequest)
Creates a Device Defender audit suppression.default CreateAuditSuppressionResponse
createAuditSuppression(CreateAuditSuppressionRequest createAuditSuppressionRequest)
Creates a Device Defender audit suppression.default CreateAuthorizerResponse
createAuthorizer(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest)
Creates an authorizer.default CreateAuthorizerResponse
createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest)
Creates an authorizer.default CreateBillingGroupResponse
createBillingGroup(Consumer<CreateBillingGroupRequest.Builder> createBillingGroupRequest)
Creates a billing group.default CreateBillingGroupResponse
createBillingGroup(CreateBillingGroupRequest createBillingGroupRequest)
Creates a billing group.default CreateCertificateFromCsrResponse
createCertificateFromCsr(Consumer<CreateCertificateFromCsrRequest.Builder> createCertificateFromCsrRequest)
Creates an X.509 certificate using the specified certificate signing request.default CreateCertificateFromCsrResponse
createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest)
Creates an X.509 certificate using the specified certificate signing request.default CreateCustomMetricResponse
createCustomMetric(Consumer<CreateCustomMetricRequest.Builder> createCustomMetricRequest)
Use this API to define a Custom Metric published by your devices to Device Defender.default CreateCustomMetricResponse
createCustomMetric(CreateCustomMetricRequest createCustomMetricRequest)
Use this API to define a Custom Metric published by your devices to Device Defender.default 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 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.default CreateDomainConfigurationResponse
createDomainConfiguration(Consumer<CreateDomainConfigurationRequest.Builder> createDomainConfigurationRequest)
Creates a domain configuration.default CreateDomainConfigurationResponse
createDomainConfiguration(CreateDomainConfigurationRequest createDomainConfigurationRequest)
Creates a domain configuration.default CreateDynamicThingGroupResponse
createDynamicThingGroup(Consumer<CreateDynamicThingGroupRequest.Builder> createDynamicThingGroupRequest)
Creates a dynamic thing group.default CreateDynamicThingGroupResponse
createDynamicThingGroup(CreateDynamicThingGroupRequest createDynamicThingGroupRequest)
Creates a dynamic thing group.default CreateFleetMetricResponse
createFleetMetric(Consumer<CreateFleetMetricRequest.Builder> createFleetMetricRequest)
Creates a fleet metric.default CreateFleetMetricResponse
createFleetMetric(CreateFleetMetricRequest createFleetMetricRequest)
Creates a fleet metric.default CreateJobResponse
createJob(Consumer<CreateJobRequest.Builder> createJobRequest)
Creates a job.default CreateJobResponse
createJob(CreateJobRequest createJobRequest)
Creates a job.default CreateJobTemplateResponse
createJobTemplate(Consumer<CreateJobTemplateRequest.Builder> createJobTemplateRequest)
Creates a job template.default CreateJobTemplateResponse
createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest)
Creates a job template.default CreateKeysAndCertificateResponse
createKeysAndCertificate()
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.default CreateKeysAndCertificateResponse
createKeysAndCertificate(Consumer<CreateKeysAndCertificateRequest.Builder> createKeysAndCertificateRequest)
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.default CreateKeysAndCertificateResponse
createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest)
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.default CreateMitigationActionResponse
createMitigationAction(Consumer<CreateMitigationActionRequest.Builder> createMitigationActionRequest)
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.default CreateMitigationActionResponse
createMitigationAction(CreateMitigationActionRequest createMitigationActionRequest)
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.default CreateOtaUpdateResponse
createOTAUpdate(Consumer<CreateOtaUpdateRequest.Builder> createOtaUpdateRequest)
Creates an IoT OTA update on a target group of things or groups.default CreateOtaUpdateResponse
createOTAUpdate(CreateOtaUpdateRequest createOtaUpdateRequest)
Creates an IoT OTA update on a target group of things or groups.default CreatePackageResponse
createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest)
Creates an IoT software package that can be deployed to your fleet.default CreatePackageResponse
createPackage(CreatePackageRequest createPackageRequest)
Creates an IoT software package that can be deployed to your fleet.default CreatePackageVersionResponse
createPackageVersion(Consumer<CreatePackageVersionRequest.Builder> createPackageVersionRequest)
Creates a new version for an existing IoT software package.default CreatePackageVersionResponse
createPackageVersion(CreatePackageVersionRequest createPackageVersionRequest)
Creates a new version for an existing IoT software package.default CreatePolicyResponse
createPolicy(Consumer<CreatePolicyRequest.Builder> createPolicyRequest)
Creates an IoT policy.default CreatePolicyResponse
createPolicy(CreatePolicyRequest createPolicyRequest)
Creates an IoT policy.default CreatePolicyVersionResponse
createPolicyVersion(Consumer<CreatePolicyVersionRequest.Builder> createPolicyVersionRequest)
Creates a new version of the specified IoT policy.default CreatePolicyVersionResponse
createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest)
Creates a new version of the specified IoT policy.default CreateProvisioningClaimResponse
createProvisioningClaim(Consumer<CreateProvisioningClaimRequest.Builder> createProvisioningClaimRequest)
Creates a provisioning claim.default CreateProvisioningClaimResponse
createProvisioningClaim(CreateProvisioningClaimRequest createProvisioningClaimRequest)
Creates a provisioning claim.default CreateProvisioningTemplateResponse
createProvisioningTemplate(Consumer<CreateProvisioningTemplateRequest.Builder> createProvisioningTemplateRequest)
Creates a provisioning template.default CreateProvisioningTemplateResponse
createProvisioningTemplate(CreateProvisioningTemplateRequest createProvisioningTemplateRequest)
Creates a provisioning template.default CreateProvisioningTemplateVersionResponse
createProvisioningTemplateVersion(Consumer<CreateProvisioningTemplateVersionRequest.Builder> createProvisioningTemplateVersionRequest)
Creates a new version of a provisioning template.default CreateProvisioningTemplateVersionResponse
createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest)
Creates a new version of a provisioning template.default CreateRoleAliasResponse
createRoleAlias(Consumer<CreateRoleAliasRequest.Builder> createRoleAliasRequest)
Creates a role alias.default CreateRoleAliasResponse
createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest)
Creates a role alias.default CreateScheduledAuditResponse
createScheduledAudit(Consumer<CreateScheduledAuditRequest.Builder> createScheduledAuditRequest)
Creates a scheduled audit that is run at a specified time interval.default CreateScheduledAuditResponse
createScheduledAudit(CreateScheduledAuditRequest createScheduledAuditRequest)
Creates a scheduled audit that is run at a specified time interval.default CreateSecurityProfileResponse
createSecurityProfile(Consumer<CreateSecurityProfileRequest.Builder> createSecurityProfileRequest)
Creates a Device Defender security profile.default CreateSecurityProfileResponse
createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest)
Creates a Device Defender security profile.default CreateStreamResponse
createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest)
Creates a stream for delivering one or more large files in chunks over MQTT.default CreateStreamResponse
createStream(CreateStreamRequest createStreamRequest)
Creates a stream for delivering one or more large files in chunks over MQTT.default CreateThingResponse
createThing(Consumer<CreateThingRequest.Builder> createThingRequest)
Creates a thing record in the registry.default CreateThingResponse
createThing(CreateThingRequest createThingRequest)
Creates a thing record in the registry.default CreateThingGroupResponse
createThingGroup(Consumer<CreateThingGroupRequest.Builder> createThingGroupRequest)
Create a thing group.default CreateThingGroupResponse
createThingGroup(CreateThingGroupRequest createThingGroupRequest)
Create a thing group.default CreateThingTypeResponse
createThingType(Consumer<CreateThingTypeRequest.Builder> createThingTypeRequest)
Creates a new thing type.default CreateThingTypeResponse
createThingType(CreateThingTypeRequest createThingTypeRequest)
Creates a new thing type.default CreateTopicRuleResponse
createTopicRule(Consumer<CreateTopicRuleRequest.Builder> createTopicRuleRequest)
Creates a rule.default CreateTopicRuleResponse
createTopicRule(CreateTopicRuleRequest createTopicRuleRequest)
Creates a rule.default CreateTopicRuleDestinationResponse
createTopicRuleDestination(Consumer<CreateTopicRuleDestinationRequest.Builder> createTopicRuleDestinationRequest)
Creates a topic rule destination.default CreateTopicRuleDestinationResponse
createTopicRuleDestination(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest)
Creates a topic rule destination.default DeleteAccountAuditConfigurationResponse
deleteAccountAuditConfiguration()
Restores the default settings for Device Defender audits for this account.default DeleteAccountAuditConfigurationResponse
deleteAccountAuditConfiguration(Consumer<DeleteAccountAuditConfigurationRequest.Builder> deleteAccountAuditConfigurationRequest)
Restores the default settings for Device Defender audits for this account.default DeleteAccountAuditConfigurationResponse
deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest deleteAccountAuditConfigurationRequest)
Restores the default settings for Device Defender audits for this account.default DeleteAuditSuppressionResponse
deleteAuditSuppression(Consumer<DeleteAuditSuppressionRequest.Builder> deleteAuditSuppressionRequest)
Deletes a Device Defender audit suppression.default DeleteAuditSuppressionResponse
deleteAuditSuppression(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest)
Deletes a Device Defender audit suppression.default DeleteAuthorizerResponse
deleteAuthorizer(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest)
Deletes an authorizer.default DeleteAuthorizerResponse
deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest)
Deletes an authorizer.default DeleteBillingGroupResponse
deleteBillingGroup(Consumer<DeleteBillingGroupRequest.Builder> deleteBillingGroupRequest)
Deletes the billing group.default DeleteBillingGroupResponse
deleteBillingGroup(DeleteBillingGroupRequest deleteBillingGroupRequest)
Deletes the billing group.default DeleteCaCertificateResponse
deleteCACertificate(Consumer<DeleteCaCertificateRequest.Builder> deleteCaCertificateRequest)
Deletes a registered CA certificate.default DeleteCaCertificateResponse
deleteCACertificate(DeleteCaCertificateRequest deleteCaCertificateRequest)
Deletes a registered CA certificate.default DeleteCertificateResponse
deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)
Deletes the specified certificate.default DeleteCertificateResponse
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes the specified certificate.default DeleteCustomMetricResponse
deleteCustomMetric(Consumer<DeleteCustomMetricRequest.Builder> deleteCustomMetricRequest)
Deletes a Device Defender detect custom metric.default DeleteCustomMetricResponse
deleteCustomMetric(DeleteCustomMetricRequest deleteCustomMetricRequest)
Deletes a Device Defender detect custom metric.default DeleteDimensionResponse
deleteDimension(Consumer<DeleteDimensionRequest.Builder> deleteDimensionRequest)
Removes the specified dimension from your Amazon Web Services accounts.default DeleteDimensionResponse
deleteDimension(DeleteDimensionRequest deleteDimensionRequest)
Removes the specified dimension from your Amazon Web Services accounts.default DeleteDomainConfigurationResponse
deleteDomainConfiguration(Consumer<DeleteDomainConfigurationRequest.Builder> deleteDomainConfigurationRequest)
Deletes the specified domain configuration.default DeleteDomainConfigurationResponse
deleteDomainConfiguration(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest)
Deletes the specified domain configuration.default DeleteDynamicThingGroupResponse
deleteDynamicThingGroup(Consumer<DeleteDynamicThingGroupRequest.Builder> deleteDynamicThingGroupRequest)
Deletes a dynamic thing group.default DeleteDynamicThingGroupResponse
deleteDynamicThingGroup(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest)
Deletes a dynamic thing group.default DeleteFleetMetricResponse
deleteFleetMetric(Consumer<DeleteFleetMetricRequest.Builder> deleteFleetMetricRequest)
Deletes the specified fleet metric.default DeleteFleetMetricResponse
deleteFleetMetric(DeleteFleetMetricRequest deleteFleetMetricRequest)
Deletes the specified fleet metric.default DeleteJobResponse
deleteJob(Consumer<DeleteJobRequest.Builder> deleteJobRequest)
Deletes a job and its related job executions.default DeleteJobResponse
deleteJob(DeleteJobRequest deleteJobRequest)
Deletes a job and its related job executions.default DeleteJobExecutionResponse
deleteJobExecution(Consumer<DeleteJobExecutionRequest.Builder> deleteJobExecutionRequest)
Deletes a job execution.default DeleteJobExecutionResponse
deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest)
Deletes a job execution.default DeleteJobTemplateResponse
deleteJobTemplate(Consumer<DeleteJobTemplateRequest.Builder> deleteJobTemplateRequest)
Deletes the specified job template.default DeleteJobTemplateResponse
deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest)
Deletes the specified job template.default DeleteMitigationActionResponse
deleteMitigationAction(Consumer<DeleteMitigationActionRequest.Builder> deleteMitigationActionRequest)
Deletes a defined mitigation action from your Amazon Web Services accounts.default DeleteMitigationActionResponse
deleteMitigationAction(DeleteMitigationActionRequest deleteMitigationActionRequest)
Deletes a defined mitigation action from your Amazon Web Services accounts.default DeleteOtaUpdateResponse
deleteOTAUpdate(Consumer<DeleteOtaUpdateRequest.Builder> deleteOtaUpdateRequest)
Delete an OTA update.default DeleteOtaUpdateResponse
deleteOTAUpdate(DeleteOtaUpdateRequest deleteOtaUpdateRequest)
Delete an OTA update.default DeletePackageResponse
deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest)
Deletes a specific version from a software package.default DeletePackageResponse
deletePackage(DeletePackageRequest deletePackageRequest)
Deletes a specific version from a software package.default DeletePackageVersionResponse
deletePackageVersion(Consumer<DeletePackageVersionRequest.Builder> deletePackageVersionRequest)
Deletes a specific version from a software package.default DeletePackageVersionResponse
deletePackageVersion(DeletePackageVersionRequest deletePackageVersionRequest)
Deletes a specific version from a software package.default DeletePolicyResponse
deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest)
Deletes the specified policy.default DeletePolicyResponse
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified policy.default DeletePolicyVersionResponse
deletePolicyVersion(Consumer<DeletePolicyVersionRequest.Builder> deletePolicyVersionRequest)
Deletes the specified version of the specified policy.default DeletePolicyVersionResponse
deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest)
Deletes the specified version of the specified policy.default DeleteProvisioningTemplateResponse
deleteProvisioningTemplate(Consumer<DeleteProvisioningTemplateRequest.Builder> deleteProvisioningTemplateRequest)
Deletes a provisioning template.default DeleteProvisioningTemplateResponse
deleteProvisioningTemplate(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest)
Deletes a provisioning template.default DeleteProvisioningTemplateVersionResponse
deleteProvisioningTemplateVersion(Consumer<DeleteProvisioningTemplateVersionRequest.Builder> deleteProvisioningTemplateVersionRequest)
Deletes a provisioning template version.default DeleteProvisioningTemplateVersionResponse
deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest)
Deletes a provisioning template version.default DeleteRegistrationCodeResponse
deleteRegistrationCode()
Deletes a CA certificate registration code.default DeleteRegistrationCodeResponse
deleteRegistrationCode(Consumer<DeleteRegistrationCodeRequest.Builder> deleteRegistrationCodeRequest)
Deletes a CA certificate registration code.default DeleteRegistrationCodeResponse
deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest)
Deletes a CA certificate registration code.default DeleteRoleAliasResponse
deleteRoleAlias(Consumer<DeleteRoleAliasRequest.Builder> deleteRoleAliasRequest)
Deletes a role aliasdefault DeleteRoleAliasResponse
deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest)
Deletes a role aliasdefault DeleteScheduledAuditResponse
deleteScheduledAudit(Consumer<DeleteScheduledAuditRequest.Builder> deleteScheduledAuditRequest)
Deletes a scheduled audit.default DeleteScheduledAuditResponse
deleteScheduledAudit(DeleteScheduledAuditRequest deleteScheduledAuditRequest)
Deletes a scheduled audit.default DeleteSecurityProfileResponse
deleteSecurityProfile(Consumer<DeleteSecurityProfileRequest.Builder> deleteSecurityProfileRequest)
Deletes a Device Defender security profile.default DeleteSecurityProfileResponse
deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest)
Deletes a Device Defender security profile.default DeleteStreamResponse
deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest)
Deletes a stream.default DeleteStreamResponse
deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a stream.default DeleteThingResponse
deleteThing(Consumer<DeleteThingRequest.Builder> deleteThingRequest)
Deletes the specified thing.default DeleteThingResponse
deleteThing(DeleteThingRequest deleteThingRequest)
Deletes the specified thing.default DeleteThingGroupResponse
deleteThingGroup(Consumer<DeleteThingGroupRequest.Builder> deleteThingGroupRequest)
Deletes a thing group.default DeleteThingGroupResponse
deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest)
Deletes a thing group.default DeleteThingTypeResponse
deleteThingType(Consumer<DeleteThingTypeRequest.Builder> deleteThingTypeRequest)
Deletes the specified thing type.default DeleteThingTypeResponse
deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest)
Deletes the specified thing type.default DeleteTopicRuleResponse
deleteTopicRule(Consumer<DeleteTopicRuleRequest.Builder> deleteTopicRuleRequest)
Deletes the rule.default DeleteTopicRuleResponse
deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest)
Deletes the rule.default DeleteTopicRuleDestinationResponse
deleteTopicRuleDestination(Consumer<DeleteTopicRuleDestinationRequest.Builder> deleteTopicRuleDestinationRequest)
Deletes a topic rule destination.default DeleteTopicRuleDestinationResponse
deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest)
Deletes a topic rule destination.default DeleteV2LoggingLevelResponse
deleteV2LoggingLevel(Consumer<DeleteV2LoggingLevelRequest.Builder> deleteV2LoggingLevelRequest)
Deletes a logging level.default DeleteV2LoggingLevelResponse
deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest)
Deletes a logging level.default DeprecateThingTypeResponse
deprecateThingType(Consumer<DeprecateThingTypeRequest.Builder> deprecateThingTypeRequest)
Deprecates a thing type.default DeprecateThingTypeResponse
deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest)
Deprecates a thing type.default DescribeAccountAuditConfigurationResponse
describeAccountAuditConfiguration()
Gets information about the Device Defender audit settings for this account.default DescribeAccountAuditConfigurationResponse
describeAccountAuditConfiguration(Consumer<DescribeAccountAuditConfigurationRequest.Builder> describeAccountAuditConfigurationRequest)
Gets information about the Device Defender audit settings for this account.default DescribeAccountAuditConfigurationResponse
describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest)
Gets information about the Device Defender audit settings for this account.default DescribeAuditFindingResponse
describeAuditFinding(Consumer<DescribeAuditFindingRequest.Builder> describeAuditFindingRequest)
Gets information about a single audit finding.default DescribeAuditFindingResponse
describeAuditFinding(DescribeAuditFindingRequest describeAuditFindingRequest)
Gets information about a single audit finding.default 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.default DescribeAuditMitigationActionsTaskResponse
describeAuditMitigationActionsTask(DescribeAuditMitigationActionsTaskRequest describeAuditMitigationActionsTaskRequest)
Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings.default DescribeAuditSuppressionResponse
describeAuditSuppression(Consumer<DescribeAuditSuppressionRequest.Builder> describeAuditSuppressionRequest)
Gets information about a Device Defender audit suppression.default DescribeAuditSuppressionResponse
describeAuditSuppression(DescribeAuditSuppressionRequest describeAuditSuppressionRequest)
Gets information about a Device Defender audit suppression.default DescribeAuditTaskResponse
describeAuditTask(Consumer<DescribeAuditTaskRequest.Builder> describeAuditTaskRequest)
Gets information about a Device Defender audit.default DescribeAuditTaskResponse
describeAuditTask(DescribeAuditTaskRequest describeAuditTaskRequest)
Gets information about a Device Defender audit.default DescribeAuthorizerResponse
describeAuthorizer(Consumer<DescribeAuthorizerRequest.Builder> describeAuthorizerRequest)
Describes an authorizer.default DescribeAuthorizerResponse
describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest)
Describes an authorizer.default DescribeBillingGroupResponse
describeBillingGroup(Consumer<DescribeBillingGroupRequest.Builder> describeBillingGroupRequest)
Returns information about a billing group.default DescribeBillingGroupResponse
describeBillingGroup(DescribeBillingGroupRequest describeBillingGroupRequest)
Returns information about a billing group.default DescribeCaCertificateResponse
describeCACertificate(Consumer<DescribeCaCertificateRequest.Builder> describeCaCertificateRequest)
Describes a registered CA certificate.default DescribeCaCertificateResponse
describeCACertificate(DescribeCaCertificateRequest describeCaCertificateRequest)
Describes a registered CA certificate.default DescribeCertificateResponse
describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest)
Gets information about the specified certificate.default DescribeCertificateResponse
describeCertificate(DescribeCertificateRequest describeCertificateRequest)
Gets information about the specified certificate.default DescribeCustomMetricResponse
describeCustomMetric(Consumer<DescribeCustomMetricRequest.Builder> describeCustomMetricRequest)
Gets information about a Device Defender detect custom metric.default DescribeCustomMetricResponse
describeCustomMetric(DescribeCustomMetricRequest describeCustomMetricRequest)
Gets information about a Device Defender detect custom metric.default DescribeDefaultAuthorizerResponse
describeDefaultAuthorizer(Consumer<DescribeDefaultAuthorizerRequest.Builder> describeDefaultAuthorizerRequest)
Describes the default authorizer.default DescribeDefaultAuthorizerResponse
describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest)
Describes the default authorizer.default DescribeDetectMitigationActionsTaskResponse
describeDetectMitigationActionsTask(Consumer<DescribeDetectMitigationActionsTaskRequest.Builder> describeDetectMitigationActionsTaskRequest)
Gets information about a Device Defender ML Detect mitigation action.default DescribeDetectMitigationActionsTaskResponse
describeDetectMitigationActionsTask(DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest)
Gets information about a Device Defender ML Detect mitigation action.default DescribeDimensionResponse
describeDimension(Consumer<DescribeDimensionRequest.Builder> describeDimensionRequest)
Provides details about a dimension that is defined in your Amazon Web Services accounts.default DescribeDimensionResponse
describeDimension(DescribeDimensionRequest describeDimensionRequest)
Provides details about a dimension that is defined in your Amazon Web Services accounts.default DescribeDomainConfigurationResponse
describeDomainConfiguration(Consumer<DescribeDomainConfigurationRequest.Builder> describeDomainConfigurationRequest)
Gets summary information about a domain configuration.default DescribeDomainConfigurationResponse
describeDomainConfiguration(DescribeDomainConfigurationRequest describeDomainConfigurationRequest)
Gets summary information about a domain configuration.default DescribeEndpointResponse
describeEndpoint()
Returns a unique endpoint specific to the Amazon Web Services account making the call.default DescribeEndpointResponse
describeEndpoint(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest)
Returns a unique endpoint specific to the Amazon Web Services account making the call.default DescribeEndpointResponse
describeEndpoint(DescribeEndpointRequest describeEndpointRequest)
Returns a unique endpoint specific to the Amazon Web Services account making the call.default DescribeEventConfigurationsResponse
describeEventConfigurations()
Describes event configurations.default DescribeEventConfigurationsResponse
describeEventConfigurations(Consumer<DescribeEventConfigurationsRequest.Builder> describeEventConfigurationsRequest)
Describes event configurations.default DescribeEventConfigurationsResponse
describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest)
Describes event configurations.default DescribeFleetMetricResponse
describeFleetMetric(Consumer<DescribeFleetMetricRequest.Builder> describeFleetMetricRequest)
Gets information about the specified fleet metric.default DescribeFleetMetricResponse
describeFleetMetric(DescribeFleetMetricRequest describeFleetMetricRequest)
Gets information about the specified fleet metric.default DescribeIndexResponse
describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest)
Describes a search index.default DescribeIndexResponse
describeIndex(DescribeIndexRequest describeIndexRequest)
Describes a search index.default DescribeJobResponse
describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest)
Describes a job.default DescribeJobResponse
describeJob(DescribeJobRequest describeJobRequest)
Describes a job.default DescribeJobExecutionResponse
describeJobExecution(Consumer<DescribeJobExecutionRequest.Builder> describeJobExecutionRequest)
Describes a job execution.default DescribeJobExecutionResponse
describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest)
Describes a job execution.default DescribeJobTemplateResponse
describeJobTemplate(Consumer<DescribeJobTemplateRequest.Builder> describeJobTemplateRequest)
Returns information about a job template.default DescribeJobTemplateResponse
describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest)
Returns information about a job template.default DescribeManagedJobTemplateResponse
describeManagedJobTemplate(Consumer<DescribeManagedJobTemplateRequest.Builder> describeManagedJobTemplateRequest)
View details of a managed job template.default DescribeManagedJobTemplateResponse
describeManagedJobTemplate(DescribeManagedJobTemplateRequest describeManagedJobTemplateRequest)
View details of a managed job template.default DescribeMitigationActionResponse
describeMitigationAction(Consumer<DescribeMitigationActionRequest.Builder> describeMitigationActionRequest)
Gets information about a mitigation action.default DescribeMitigationActionResponse
describeMitigationAction(DescribeMitigationActionRequest describeMitigationActionRequest)
Gets information about a mitigation action.default DescribeProvisioningTemplateResponse
describeProvisioningTemplate(Consumer<DescribeProvisioningTemplateRequest.Builder> describeProvisioningTemplateRequest)
Returns information about a provisioning template.default DescribeProvisioningTemplateResponse
describeProvisioningTemplate(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest)
Returns information about a provisioning template.default DescribeProvisioningTemplateVersionResponse
describeProvisioningTemplateVersion(Consumer<DescribeProvisioningTemplateVersionRequest.Builder> describeProvisioningTemplateVersionRequest)
Returns information about a provisioning template version.default DescribeProvisioningTemplateVersionResponse
describeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest)
Returns information about a provisioning template version.default DescribeRoleAliasResponse
describeRoleAlias(Consumer<DescribeRoleAliasRequest.Builder> describeRoleAliasRequest)
Describes a role alias.default DescribeRoleAliasResponse
describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest)
Describes a role alias.default DescribeScheduledAuditResponse
describeScheduledAudit(Consumer<DescribeScheduledAuditRequest.Builder> describeScheduledAuditRequest)
Gets information about a scheduled audit.default DescribeScheduledAuditResponse
describeScheduledAudit(DescribeScheduledAuditRequest describeScheduledAuditRequest)
Gets information about a scheduled audit.default DescribeSecurityProfileResponse
describeSecurityProfile(Consumer<DescribeSecurityProfileRequest.Builder> describeSecurityProfileRequest)
Gets information about a Device Defender security profile.default DescribeSecurityProfileResponse
describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest)
Gets information about a Device Defender security profile.default DescribeStreamResponse
describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)
Gets information about a stream.default DescribeStreamResponse
describeStream(DescribeStreamRequest describeStreamRequest)
Gets information about a stream.default DescribeThingResponse
describeThing(Consumer<DescribeThingRequest.Builder> describeThingRequest)
Gets information about the specified thing.default DescribeThingResponse
describeThing(DescribeThingRequest describeThingRequest)
Gets information about the specified thing.default DescribeThingGroupResponse
describeThingGroup(Consumer<DescribeThingGroupRequest.Builder> describeThingGroupRequest)
Describe a thing group.default DescribeThingGroupResponse
describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest)
Describe a thing group.default DescribeThingRegistrationTaskResponse
describeThingRegistrationTask(Consumer<DescribeThingRegistrationTaskRequest.Builder> describeThingRegistrationTaskRequest)
Describes a bulk thing provisioning task.default DescribeThingRegistrationTaskResponse
describeThingRegistrationTask(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest)
Describes a bulk thing provisioning task.default DescribeThingTypeResponse
describeThingType(Consumer<DescribeThingTypeRequest.Builder> describeThingTypeRequest)
Gets information about the specified thing type.default DescribeThingTypeResponse
describeThingType(DescribeThingTypeRequest describeThingTypeRequest)
Gets information about the specified thing type.default DetachPolicyResponse
detachPolicy(Consumer<DetachPolicyRequest.Builder> detachPolicyRequest)
Detaches a policy from the specified target.default DetachPolicyResponse
detachPolicy(DetachPolicyRequest detachPolicyRequest)
Detaches a policy from the specified target.default DetachSecurityProfileResponse
detachSecurityProfile(Consumer<DetachSecurityProfileRequest.Builder> detachSecurityProfileRequest)
Disassociates a Device Defender security profile from a thing group or from this account.default DetachSecurityProfileResponse
detachSecurityProfile(DetachSecurityProfileRequest detachSecurityProfileRequest)
Disassociates a Device Defender security profile from a thing group or from this account.default DetachThingPrincipalResponse
detachThingPrincipal(Consumer<DetachThingPrincipalRequest.Builder> detachThingPrincipalRequest)
Detaches the specified principal from the specified thing.default DetachThingPrincipalResponse
detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest)
Detaches the specified principal from the specified thing.default DisableTopicRuleResponse
disableTopicRule(Consumer<DisableTopicRuleRequest.Builder> disableTopicRuleRequest)
Disables the rule.default DisableTopicRuleResponse
disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest)
Disables the rule.default EnableTopicRuleResponse
enableTopicRule(Consumer<EnableTopicRuleRequest.Builder> enableTopicRuleRequest)
Enables the rule.default EnableTopicRuleResponse
enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest)
Enables the rule.default GetBehaviorModelTrainingSummariesResponse
getBehaviorModelTrainingSummaries(Consumer<GetBehaviorModelTrainingSummariesRequest.Builder> getBehaviorModelTrainingSummariesRequest)
Returns a Device Defender's ML Detect Security Profile training model's status.default GetBehaviorModelTrainingSummariesResponse
getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest)
Returns a Device Defender's ML Detect Security Profile training model's status.default GetBehaviorModelTrainingSummariesIterable
getBehaviorModelTrainingSummariesPaginator(Consumer<GetBehaviorModelTrainingSummariesRequest.Builder> getBehaviorModelTrainingSummariesRequest)
Returns a Device Defender's ML Detect Security Profile training model's status.default GetBehaviorModelTrainingSummariesIterable
getBehaviorModelTrainingSummariesPaginator(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest)
Returns a Device Defender's ML Detect Security Profile training model's status.default GetBucketsAggregationResponse
getBucketsAggregation(Consumer<GetBucketsAggregationRequest.Builder> getBucketsAggregationRequest)
Aggregates on indexed data with search queries pertaining to particular fields.default GetBucketsAggregationResponse
getBucketsAggregation(GetBucketsAggregationRequest getBucketsAggregationRequest)
Aggregates on indexed data with search queries pertaining to particular fields.default GetCardinalityResponse
getCardinality(Consumer<GetCardinalityRequest.Builder> getCardinalityRequest)
Returns the approximate count of unique values that match the query.default GetCardinalityResponse
getCardinality(GetCardinalityRequest getCardinalityRequest)
Returns the approximate count of unique values that match the query.default 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.default 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.default GetIndexingConfigurationResponse
getIndexingConfiguration()
Gets the indexing configuration.default GetIndexingConfigurationResponse
getIndexingConfiguration(Consumer<GetIndexingConfigurationRequest.Builder> getIndexingConfigurationRequest)
Gets the indexing configuration.default GetIndexingConfigurationResponse
getIndexingConfiguration(GetIndexingConfigurationRequest getIndexingConfigurationRequest)
Gets the indexing configuration.default GetJobDocumentResponse
getJobDocument(Consumer<GetJobDocumentRequest.Builder> getJobDocumentRequest)
Gets a job document.default GetJobDocumentResponse
getJobDocument(GetJobDocumentRequest getJobDocumentRequest)
Gets a job document.default GetLoggingOptionsResponse
getLoggingOptions()
Gets the logging options.default GetLoggingOptionsResponse
getLoggingOptions(Consumer<GetLoggingOptionsRequest.Builder> getLoggingOptionsRequest)
Gets the logging options.default GetLoggingOptionsResponse
getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest)
Gets the logging options.default GetOtaUpdateResponse
getOTAUpdate(Consumer<GetOtaUpdateRequest.Builder> getOtaUpdateRequest)
Gets an OTA update.default GetOtaUpdateResponse
getOTAUpdate(GetOtaUpdateRequest getOtaUpdateRequest)
Gets an OTA update.default GetPackageResponse
getPackage(Consumer<GetPackageRequest.Builder> getPackageRequest)
Gets information about the specified software package.default GetPackageResponse
getPackage(GetPackageRequest getPackageRequest)
Gets information about the specified software package.default GetPackageConfigurationResponse
getPackageConfiguration(Consumer<GetPackageConfigurationRequest.Builder> getPackageConfigurationRequest)
Gets information about the specified software package's configuration.default GetPackageConfigurationResponse
getPackageConfiguration(GetPackageConfigurationRequest getPackageConfigurationRequest)
Gets information about the specified software package's configuration.default GetPackageVersionResponse
getPackageVersion(Consumer<GetPackageVersionRequest.Builder> getPackageVersionRequest)
Gets information about the specified package version.default GetPackageVersionResponse
getPackageVersion(GetPackageVersionRequest getPackageVersionRequest)
Gets information about the specified package version.default GetPercentilesResponse
getPercentiles(Consumer<GetPercentilesRequest.Builder> getPercentilesRequest)
Groups the aggregated values that match the query into percentile groupings.default GetPercentilesResponse
getPercentiles(GetPercentilesRequest getPercentilesRequest)
Groups the aggregated values that match the query into percentile groupings.default GetPolicyResponse
getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest)
Gets information about the specified policy with the policy document of the default version.default GetPolicyResponse
getPolicy(GetPolicyRequest getPolicyRequest)
Gets information about the specified policy with the policy document of the default version.default GetPolicyVersionResponse
getPolicyVersion(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest)
Gets information about the specified policy version.default GetPolicyVersionResponse
getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest)
Gets information about the specified policy version.default GetRegistrationCodeResponse
getRegistrationCode()
Gets a registration code used to register a CA certificate with IoT.default GetRegistrationCodeResponse
getRegistrationCode(Consumer<GetRegistrationCodeRequest.Builder> getRegistrationCodeRequest)
Gets a registration code used to register a CA certificate with IoT.default GetRegistrationCodeResponse
getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest)
Gets a registration code used to register a CA certificate with IoT.default 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 GetStatisticsResponse
getStatistics(GetStatisticsRequest getStatisticsRequest)
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field.default GetTopicRuleResponse
getTopicRule(Consumer<GetTopicRuleRequest.Builder> getTopicRuleRequest)
Gets information about the rule.default GetTopicRuleResponse
getTopicRule(GetTopicRuleRequest getTopicRuleRequest)
Gets information about the rule.default GetTopicRuleDestinationResponse
getTopicRuleDestination(Consumer<GetTopicRuleDestinationRequest.Builder> getTopicRuleDestinationRequest)
Gets information about a topic rule destination.default GetTopicRuleDestinationResponse
getTopicRuleDestination(GetTopicRuleDestinationRequest getTopicRuleDestinationRequest)
Gets information about a topic rule destination.default GetV2LoggingOptionsResponse
getV2LoggingOptions(Consumer<GetV2LoggingOptionsRequest.Builder> getV2LoggingOptionsRequest)
Gets the fine grained logging options.default GetV2LoggingOptionsResponse
getV2LoggingOptions(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest)
Gets the fine grained logging options.default ListActiveViolationsResponse
listActiveViolations()
Lists the active violations for a given Device Defender security profile.default ListActiveViolationsResponse
listActiveViolations(Consumer<ListActiveViolationsRequest.Builder> listActiveViolationsRequest)
Lists the active violations for a given Device Defender security profile.default ListActiveViolationsResponse
listActiveViolations(ListActiveViolationsRequest listActiveViolationsRequest)
Lists the active violations for a given Device Defender security profile.default ListActiveViolationsIterable
listActiveViolationsPaginator()
Lists the active violations for a given Device Defender security profile.default ListActiveViolationsIterable
listActiveViolationsPaginator(Consumer<ListActiveViolationsRequest.Builder> listActiveViolationsRequest)
Lists the active violations for a given Device Defender security profile.default ListActiveViolationsIterable
listActiveViolationsPaginator(ListActiveViolationsRequest listActiveViolationsRequest)
Lists the active violations for a given Device Defender security profile.default ListAttachedPoliciesResponse
listAttachedPolicies(Consumer<ListAttachedPoliciesRequest.Builder> listAttachedPoliciesRequest)
Lists the policies attached to the specified thing group.default ListAttachedPoliciesResponse
listAttachedPolicies(ListAttachedPoliciesRequest listAttachedPoliciesRequest)
Lists the policies attached to the specified thing group.default ListAttachedPoliciesIterable
listAttachedPoliciesPaginator(Consumer<ListAttachedPoliciesRequest.Builder> listAttachedPoliciesRequest)
Lists the policies attached to the specified thing group.default ListAttachedPoliciesIterable
listAttachedPoliciesPaginator(ListAttachedPoliciesRequest listAttachedPoliciesRequest)
Lists the policies attached to the specified thing group.default 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.default ListAuditFindingsResponse
listAuditFindings(ListAuditFindingsRequest listAuditFindingsRequest)
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.default ListAuditFindingsIterable
listAuditFindingsPaginator(Consumer<ListAuditFindingsRequest.Builder> listAuditFindingsRequest)
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.default ListAuditFindingsIterable
listAuditFindingsPaginator(ListAuditFindingsRequest listAuditFindingsRequest)
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.default ListAuditMitigationActionsExecutionsResponse
listAuditMitigationActionsExecutions(Consumer<ListAuditMitigationActionsExecutionsRequest.Builder> listAuditMitigationActionsExecutionsRequest)
Gets the status of audit mitigation action tasks that were executed.default ListAuditMitigationActionsExecutionsResponse
listAuditMitigationActionsExecutions(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest)
Gets the status of audit mitigation action tasks that were executed.default ListAuditMitigationActionsExecutionsIterable
listAuditMitigationActionsExecutionsPaginator(Consumer<ListAuditMitigationActionsExecutionsRequest.Builder> listAuditMitigationActionsExecutionsRequest)
Gets the status of audit mitigation action tasks that were executed.default ListAuditMitigationActionsExecutionsIterable
listAuditMitigationActionsExecutionsPaginator(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest)
Gets the status of audit mitigation action tasks that were executed.default ListAuditMitigationActionsTasksResponse
listAuditMitigationActionsTasks(Consumer<ListAuditMitigationActionsTasksRequest.Builder> listAuditMitigationActionsTasksRequest)
Gets a list of audit mitigation action tasks that match the specified filters.default ListAuditMitigationActionsTasksResponse
listAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest)
Gets a list of audit mitigation action tasks that match the specified filters.default ListAuditMitigationActionsTasksIterable
listAuditMitigationActionsTasksPaginator(Consumer<ListAuditMitigationActionsTasksRequest.Builder> listAuditMitigationActionsTasksRequest)
Gets a list of audit mitigation action tasks that match the specified filters.default ListAuditMitigationActionsTasksIterable
listAuditMitigationActionsTasksPaginator(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest)
Gets a list of audit mitigation action tasks that match the specified filters.default ListAuditSuppressionsResponse
listAuditSuppressions(Consumer<ListAuditSuppressionsRequest.Builder> listAuditSuppressionsRequest)
Lists your Device Defender audit listings.default ListAuditSuppressionsResponse
listAuditSuppressions(ListAuditSuppressionsRequest listAuditSuppressionsRequest)
Lists your Device Defender audit listings.default ListAuditSuppressionsIterable
listAuditSuppressionsPaginator(Consumer<ListAuditSuppressionsRequest.Builder> listAuditSuppressionsRequest)
Lists your Device Defender audit listings.default ListAuditSuppressionsIterable
listAuditSuppressionsPaginator(ListAuditSuppressionsRequest listAuditSuppressionsRequest)
Lists your Device Defender audit listings.default ListAuditTasksResponse
listAuditTasks(Consumer<ListAuditTasksRequest.Builder> listAuditTasksRequest)
Lists the Device Defender audits that have been performed during a given time period.default ListAuditTasksResponse
listAuditTasks(ListAuditTasksRequest listAuditTasksRequest)
Lists the Device Defender audits that have been performed during a given time period.default ListAuditTasksIterable
listAuditTasksPaginator(Consumer<ListAuditTasksRequest.Builder> listAuditTasksRequest)
Lists the Device Defender audits that have been performed during a given time period.default ListAuditTasksIterable
listAuditTasksPaginator(ListAuditTasksRequest listAuditTasksRequest)
Lists the Device Defender audits that have been performed during a given time period.default ListAuthorizersResponse
listAuthorizers()
Lists the authorizers registered in your account.default ListAuthorizersResponse
listAuthorizers(Consumer<ListAuthorizersRequest.Builder> listAuthorizersRequest)
Lists the authorizers registered in your account.default ListAuthorizersResponse
listAuthorizers(ListAuthorizersRequest listAuthorizersRequest)
Lists the authorizers registered in your account.default ListAuthorizersIterable
listAuthorizersPaginator()
Lists the authorizers registered in your account.default ListAuthorizersIterable
listAuthorizersPaginator(Consumer<ListAuthorizersRequest.Builder> listAuthorizersRequest)
Lists the authorizers registered in your account.default ListAuthorizersIterable
listAuthorizersPaginator(ListAuthorizersRequest listAuthorizersRequest)
Lists the authorizers registered in your account.default ListBillingGroupsResponse
listBillingGroups()
Lists the billing groups you have created.default ListBillingGroupsResponse
listBillingGroups(Consumer<ListBillingGroupsRequest.Builder> listBillingGroupsRequest)
Lists the billing groups you have created.default ListBillingGroupsResponse
listBillingGroups(ListBillingGroupsRequest listBillingGroupsRequest)
Lists the billing groups you have created.default ListBillingGroupsIterable
listBillingGroupsPaginator()
Lists the billing groups you have created.default ListBillingGroupsIterable
listBillingGroupsPaginator(Consumer<ListBillingGroupsRequest.Builder> listBillingGroupsRequest)
Lists the billing groups you have created.default ListBillingGroupsIterable
listBillingGroupsPaginator(ListBillingGroupsRequest listBillingGroupsRequest)
Lists the billing groups you have created.default ListCaCertificatesResponse
listCACertificates()
Lists the CA certificates registered for your Amazon Web Services account.default ListCaCertificatesResponse
listCACertificates(Consumer<ListCaCertificatesRequest.Builder> listCaCertificatesRequest)
Lists the CA certificates registered for your Amazon Web Services account.default ListCaCertificatesResponse
listCACertificates(ListCaCertificatesRequest listCaCertificatesRequest)
Lists the CA certificates registered for your Amazon Web Services account.default ListCACertificatesIterable
listCACertificatesPaginator()
Lists the CA certificates registered for your Amazon Web Services account.default ListCACertificatesIterable
listCACertificatesPaginator(Consumer<ListCaCertificatesRequest.Builder> listCaCertificatesRequest)
Lists the CA certificates registered for your Amazon Web Services account.default ListCACertificatesIterable
listCACertificatesPaginator(ListCaCertificatesRequest listCaCertificatesRequest)
Lists the CA certificates registered for your Amazon Web Services account.default ListCertificatesResponse
listCertificates()
Lists the certificates registered in your Amazon Web Services account.default ListCertificatesResponse
listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
Lists the certificates registered in your Amazon Web Services account.default ListCertificatesResponse
listCertificates(ListCertificatesRequest listCertificatesRequest)
Lists the certificates registered in your Amazon Web Services account.default ListCertificatesByCaResponse
listCertificatesByCA(Consumer<ListCertificatesByCaRequest.Builder> listCertificatesByCaRequest)
List the device certificates signed by the specified CA certificate.default ListCertificatesByCaResponse
listCertificatesByCA(ListCertificatesByCaRequest listCertificatesByCaRequest)
List the device certificates signed by the specified CA certificate.default ListCertificatesByCAIterable
listCertificatesByCAPaginator(Consumer<ListCertificatesByCaRequest.Builder> listCertificatesByCaRequest)
List the device certificates signed by the specified CA certificate.default ListCertificatesByCAIterable
listCertificatesByCAPaginator(ListCertificatesByCaRequest listCertificatesByCaRequest)
List the device certificates signed by the specified CA certificate.default ListCertificatesIterable
listCertificatesPaginator()
Lists the certificates registered in your Amazon Web Services account.default ListCertificatesIterable
listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest)
Lists the certificates registered in your Amazon Web Services account.default ListCertificatesIterable
listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest)
Lists the certificates registered in your Amazon Web Services account.default ListCustomMetricsResponse
listCustomMetrics(Consumer<ListCustomMetricsRequest.Builder> listCustomMetricsRequest)
Lists your Device Defender detect custom metrics.default ListCustomMetricsResponse
listCustomMetrics(ListCustomMetricsRequest listCustomMetricsRequest)
Lists your Device Defender detect custom metrics.default ListCustomMetricsIterable
listCustomMetricsPaginator(Consumer<ListCustomMetricsRequest.Builder> listCustomMetricsRequest)
Lists your Device Defender detect custom metrics.default ListCustomMetricsIterable
listCustomMetricsPaginator(ListCustomMetricsRequest listCustomMetricsRequest)
Lists your Device Defender detect custom metrics.default ListDetectMitigationActionsExecutionsResponse
listDetectMitigationActionsExecutions(Consumer<ListDetectMitigationActionsExecutionsRequest.Builder> listDetectMitigationActionsExecutionsRequest)
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.default ListDetectMitigationActionsExecutionsResponse
listDetectMitigationActionsExecutions(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest)
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.default ListDetectMitigationActionsExecutionsIterable
listDetectMitigationActionsExecutionsPaginator(Consumer<ListDetectMitigationActionsExecutionsRequest.Builder> listDetectMitigationActionsExecutionsRequest)
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.default ListDetectMitigationActionsExecutionsIterable
listDetectMitigationActionsExecutionsPaginator(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest)
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.default ListDetectMitigationActionsTasksResponse
listDetectMitigationActionsTasks(Consumer<ListDetectMitigationActionsTasksRequest.Builder> listDetectMitigationActionsTasksRequest)
List of Device Defender ML Detect mitigation actions tasks.default ListDetectMitigationActionsTasksResponse
listDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest)
List of Device Defender ML Detect mitigation actions tasks.default ListDetectMitigationActionsTasksIterable
listDetectMitigationActionsTasksPaginator(Consumer<ListDetectMitigationActionsTasksRequest.Builder> listDetectMitigationActionsTasksRequest)
List of Device Defender ML Detect mitigation actions tasks.default ListDetectMitigationActionsTasksIterable
listDetectMitigationActionsTasksPaginator(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest)
List of Device Defender ML Detect mitigation actions tasks.default ListDimensionsResponse
listDimensions(Consumer<ListDimensionsRequest.Builder> listDimensionsRequest)
List the set of dimensions that are defined for your Amazon Web Services accounts.default ListDimensionsResponse
listDimensions(ListDimensionsRequest listDimensionsRequest)
List the set of dimensions that are defined for your Amazon Web Services accounts.default ListDimensionsIterable
listDimensionsPaginator(Consumer<ListDimensionsRequest.Builder> listDimensionsRequest)
List the set of dimensions that are defined for your Amazon Web Services accounts.default ListDimensionsIterable
listDimensionsPaginator(ListDimensionsRequest listDimensionsRequest)
List the set of dimensions that are defined for your Amazon Web Services accounts.default ListDomainConfigurationsResponse
listDomainConfigurations(Consumer<ListDomainConfigurationsRequest.Builder> listDomainConfigurationsRequest)
Gets a list of domain configurations for the user.default ListDomainConfigurationsResponse
listDomainConfigurations(ListDomainConfigurationsRequest listDomainConfigurationsRequest)
Gets a list of domain configurations for the user.default ListDomainConfigurationsIterable
listDomainConfigurationsPaginator(Consumer<ListDomainConfigurationsRequest.Builder> listDomainConfigurationsRequest)
Gets a list of domain configurations for the user.default ListDomainConfigurationsIterable
listDomainConfigurationsPaginator(ListDomainConfigurationsRequest listDomainConfigurationsRequest)
Gets a list of domain configurations for the user.default ListFleetMetricsResponse
listFleetMetrics(Consumer<ListFleetMetricsRequest.Builder> listFleetMetricsRequest)
Lists all your fleet metrics.default ListFleetMetricsResponse
listFleetMetrics(ListFleetMetricsRequest listFleetMetricsRequest)
Lists all your fleet metrics.default ListFleetMetricsIterable
listFleetMetricsPaginator(Consumer<ListFleetMetricsRequest.Builder> listFleetMetricsRequest)
Lists all your fleet metrics.default ListFleetMetricsIterable
listFleetMetricsPaginator(ListFleetMetricsRequest listFleetMetricsRequest)
Lists all your fleet metrics.default ListIndicesResponse
listIndices()
Lists the search indices.default ListIndicesResponse
listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the search indices.default ListIndicesResponse
listIndices(ListIndicesRequest listIndicesRequest)
Lists the search indices.default ListIndicesIterable
listIndicesPaginator()
Lists the search indices.default ListIndicesIterable
listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest)
Lists the search indices.default ListIndicesIterable
listIndicesPaginator(ListIndicesRequest listIndicesRequest)
Lists the search indices.default ListJobExecutionsForJobResponse
listJobExecutionsForJob(Consumer<ListJobExecutionsForJobRequest.Builder> listJobExecutionsForJobRequest)
Lists the job executions for a job.default ListJobExecutionsForJobResponse
listJobExecutionsForJob(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest)
Lists the job executions for a job.default ListJobExecutionsForJobIterable
listJobExecutionsForJobPaginator(Consumer<ListJobExecutionsForJobRequest.Builder> listJobExecutionsForJobRequest)
Lists the job executions for a job.default ListJobExecutionsForJobIterable
listJobExecutionsForJobPaginator(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest)
Lists the job executions for a job.default ListJobExecutionsForThingResponse
listJobExecutionsForThing(Consumer<ListJobExecutionsForThingRequest.Builder> listJobExecutionsForThingRequest)
Lists the job executions for the specified thing.default ListJobExecutionsForThingResponse
listJobExecutionsForThing(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest)
Lists the job executions for the specified thing.default ListJobExecutionsForThingIterable
listJobExecutionsForThingPaginator(Consumer<ListJobExecutionsForThingRequest.Builder> listJobExecutionsForThingRequest)
Lists the job executions for the specified thing.default ListJobExecutionsForThingIterable
listJobExecutionsForThingPaginator(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest)
Lists the job executions for the specified thing.default ListJobsResponse
listJobs()
Lists jobs.default ListJobsResponse
listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists jobs.default ListJobsResponse
listJobs(ListJobsRequest listJobsRequest)
Lists jobs.default ListJobsIterable
listJobsPaginator()
Lists jobs.default ListJobsIterable
listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists jobs.default ListJobsIterable
listJobsPaginator(ListJobsRequest listJobsRequest)
Lists jobs.default ListJobTemplatesResponse
listJobTemplates(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest)
Returns a list of job templates.default ListJobTemplatesResponse
listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest)
Returns a list of job templates.default ListJobTemplatesIterable
listJobTemplatesPaginator(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest)
Returns a list of job templates.default ListJobTemplatesIterable
listJobTemplatesPaginator(ListJobTemplatesRequest listJobTemplatesRequest)
Returns a list of job templates.default ListManagedJobTemplatesResponse
listManagedJobTemplates(Consumer<ListManagedJobTemplatesRequest.Builder> listManagedJobTemplatesRequest)
Returns a list of managed job templates.default ListManagedJobTemplatesResponse
listManagedJobTemplates(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest)
Returns a list of managed job templates.default ListManagedJobTemplatesIterable
listManagedJobTemplatesPaginator(Consumer<ListManagedJobTemplatesRequest.Builder> listManagedJobTemplatesRequest)
Returns a list of managed job templates.default ListManagedJobTemplatesIterable
listManagedJobTemplatesPaginator(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest)
Returns a list of managed job templates.default 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.default 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.default ListMetricValuesIterable
listMetricValuesPaginator(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.default ListMetricValuesIterable
listMetricValuesPaginator(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 ListMitigationActionsResponse
listMitigationActions(Consumer<ListMitigationActionsRequest.Builder> listMitigationActionsRequest)
Gets a list of all mitigation actions that match the specified filter criteria.default ListMitigationActionsResponse
listMitigationActions(ListMitigationActionsRequest listMitigationActionsRequest)
Gets a list of all mitigation actions that match the specified filter criteria.default ListMitigationActionsIterable
listMitigationActionsPaginator(Consumer<ListMitigationActionsRequest.Builder> listMitigationActionsRequest)
Gets a list of all mitigation actions that match the specified filter criteria.default ListMitigationActionsIterable
listMitigationActionsPaginator(ListMitigationActionsRequest listMitigationActionsRequest)
Gets a list of all mitigation actions that match the specified filter criteria.default ListOtaUpdatesResponse
listOTAUpdates()
Lists OTA updates.default ListOtaUpdatesResponse
listOTAUpdates(Consumer<ListOtaUpdatesRequest.Builder> listOtaUpdatesRequest)
Lists OTA updates.default ListOtaUpdatesResponse
listOTAUpdates(ListOtaUpdatesRequest listOtaUpdatesRequest)
Lists OTA updates.default ListOTAUpdatesIterable
listOTAUpdatesPaginator()
Lists OTA updates.default ListOTAUpdatesIterable
listOTAUpdatesPaginator(Consumer<ListOtaUpdatesRequest.Builder> listOtaUpdatesRequest)
Lists OTA updates.default ListOTAUpdatesIterable
listOTAUpdatesPaginator(ListOtaUpdatesRequest listOtaUpdatesRequest)
Lists OTA updates.default ListOutgoingCertificatesResponse
listOutgoingCertificates()
Lists certificates that are being transferred but not yet accepted.default ListOutgoingCertificatesResponse
listOutgoingCertificates(Consumer<ListOutgoingCertificatesRequest.Builder> listOutgoingCertificatesRequest)
Lists certificates that are being transferred but not yet accepted.default ListOutgoingCertificatesResponse
listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest)
Lists certificates that are being transferred but not yet accepted.default ListOutgoingCertificatesIterable
listOutgoingCertificatesPaginator()
Lists certificates that are being transferred but not yet accepted.default ListOutgoingCertificatesIterable
listOutgoingCertificatesPaginator(Consumer<ListOutgoingCertificatesRequest.Builder> listOutgoingCertificatesRequest)
Lists certificates that are being transferred but not yet accepted.default ListOutgoingCertificatesIterable
listOutgoingCertificatesPaginator(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest)
Lists certificates that are being transferred but not yet accepted.default ListPackagesResponse
listPackages(Consumer<ListPackagesRequest.Builder> listPackagesRequest)
Lists the software packages associated to the account.default ListPackagesResponse
listPackages(ListPackagesRequest listPackagesRequest)
Lists the software packages associated to the account.default ListPackagesIterable
listPackagesPaginator(Consumer<ListPackagesRequest.Builder> listPackagesRequest)
Lists the software packages associated to the account.default ListPackagesIterable
listPackagesPaginator(ListPackagesRequest listPackagesRequest)
Lists the software packages associated to the account.default ListPackageVersionsResponse
listPackageVersions(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest)
Lists the software package versions associated to the account.default ListPackageVersionsResponse
listPackageVersions(ListPackageVersionsRequest listPackageVersionsRequest)
Lists the software package versions associated to the account.default ListPackageVersionsIterable
listPackageVersionsPaginator(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest)
Lists the software package versions associated to the account.default ListPackageVersionsIterable
listPackageVersionsPaginator(ListPackageVersionsRequest listPackageVersionsRequest)
Lists the software package versions associated to the account.default ListPoliciesResponse
listPolicies()
Lists your policies.default ListPoliciesResponse
listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest)
Lists your policies.default ListPoliciesResponse
listPolicies(ListPoliciesRequest listPoliciesRequest)
Lists your policies.default ListPoliciesIterable
listPoliciesPaginator()
Lists your policies.default ListPoliciesIterable
listPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest)
Lists your policies.default ListPoliciesIterable
listPoliciesPaginator(ListPoliciesRequest listPoliciesRequest)
Lists your policies.default ListPolicyVersionsResponse
listPolicyVersions(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest)
Lists the versions of the specified policy and identifies the default version.default ListPolicyVersionsResponse
listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest)
Lists the versions of the specified policy and identifies the default version.default ListPrincipalThingsResponse
listPrincipalThings(Consumer<ListPrincipalThingsRequest.Builder> listPrincipalThingsRequest)
Lists the things associated with the specified principal.default ListPrincipalThingsResponse
listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest)
Lists the things associated with the specified principal.default ListPrincipalThingsIterable
listPrincipalThingsPaginator(Consumer<ListPrincipalThingsRequest.Builder> listPrincipalThingsRequest)
Lists the things associated with the specified principal.default ListPrincipalThingsIterable
listPrincipalThingsPaginator(ListPrincipalThingsRequest listPrincipalThingsRequest)
Lists the things associated with the specified principal.default ListProvisioningTemplatesResponse
listProvisioningTemplates(Consumer<ListProvisioningTemplatesRequest.Builder> listProvisioningTemplatesRequest)
Lists the provisioning templates in your Amazon Web Services account.default ListProvisioningTemplatesResponse
listProvisioningTemplates(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest)
Lists the provisioning templates in your Amazon Web Services account.default ListProvisioningTemplatesIterable
listProvisioningTemplatesPaginator(Consumer<ListProvisioningTemplatesRequest.Builder> listProvisioningTemplatesRequest)
Lists the provisioning templates in your Amazon Web Services account.default ListProvisioningTemplatesIterable
listProvisioningTemplatesPaginator(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest)
Lists the provisioning templates in your Amazon Web Services account.default ListProvisioningTemplateVersionsResponse
listProvisioningTemplateVersions(Consumer<ListProvisioningTemplateVersionsRequest.Builder> listProvisioningTemplateVersionsRequest)
A list of provisioning template versions.default ListProvisioningTemplateVersionsResponse
listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest)
A list of provisioning template versions.default ListProvisioningTemplateVersionsIterable
listProvisioningTemplateVersionsPaginator(Consumer<ListProvisioningTemplateVersionsRequest.Builder> listProvisioningTemplateVersionsRequest)
A list of provisioning template versions.default ListProvisioningTemplateVersionsIterable
listProvisioningTemplateVersionsPaginator(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest)
A list of provisioning template versions.default ListRelatedResourcesForAuditFindingResponse
listRelatedResourcesForAuditFinding(Consumer<ListRelatedResourcesForAuditFindingRequest.Builder> listRelatedResourcesForAuditFindingRequest)
The related resources of an Audit finding.default ListRelatedResourcesForAuditFindingResponse
listRelatedResourcesForAuditFinding(ListRelatedResourcesForAuditFindingRequest listRelatedResourcesForAuditFindingRequest)
The related resources of an Audit finding.default ListRelatedResourcesForAuditFindingIterable
listRelatedResourcesForAuditFindingPaginator(Consumer<ListRelatedResourcesForAuditFindingRequest.Builder> listRelatedResourcesForAuditFindingRequest)
The related resources of an Audit finding.default ListRelatedResourcesForAuditFindingIterable
listRelatedResourcesForAuditFindingPaginator(ListRelatedResourcesForAuditFindingRequest listRelatedResourcesForAuditFindingRequest)
The related resources of an Audit finding.default ListRoleAliasesResponse
listRoleAliases()
Lists the role aliases registered in your account.default ListRoleAliasesResponse
listRoleAliases(Consumer<ListRoleAliasesRequest.Builder> listRoleAliasesRequest)
Lists the role aliases registered in your account.default ListRoleAliasesResponse
listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest)
Lists the role aliases registered in your account.default ListRoleAliasesIterable
listRoleAliasesPaginator()
Lists the role aliases registered in your account.default ListRoleAliasesIterable
listRoleAliasesPaginator(Consumer<ListRoleAliasesRequest.Builder> listRoleAliasesRequest)
Lists the role aliases registered in your account.default ListRoleAliasesIterable
listRoleAliasesPaginator(ListRoleAliasesRequest listRoleAliasesRequest)
Lists the role aliases registered in your account.default ListScheduledAuditsResponse
listScheduledAudits()
Lists all of your scheduled audits.default ListScheduledAuditsResponse
listScheduledAudits(Consumer<ListScheduledAuditsRequest.Builder> listScheduledAuditsRequest)
Lists all of your scheduled audits.default ListScheduledAuditsResponse
listScheduledAudits(ListScheduledAuditsRequest listScheduledAuditsRequest)
Lists all of your scheduled audits.default ListScheduledAuditsIterable
listScheduledAuditsPaginator()
Lists all of your scheduled audits.default ListScheduledAuditsIterable
listScheduledAuditsPaginator(Consumer<ListScheduledAuditsRequest.Builder> listScheduledAuditsRequest)
Lists all of your scheduled audits.default ListScheduledAuditsIterable
listScheduledAuditsPaginator(ListScheduledAuditsRequest listScheduledAuditsRequest)
Lists all of your scheduled audits.default ListSecurityProfilesResponse
listSecurityProfiles()
Lists the Device Defender security profiles you've created.default ListSecurityProfilesResponse
listSecurityProfiles(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest)
Lists the Device Defender security profiles you've created.default ListSecurityProfilesResponse
listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest)
Lists the Device Defender security profiles you've created.default ListSecurityProfilesForTargetResponse
listSecurityProfilesForTarget(Consumer<ListSecurityProfilesForTargetRequest.Builder> listSecurityProfilesForTargetRequest)
Lists the Device Defender security profiles attached to a target (thing group).default ListSecurityProfilesForTargetResponse
listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest)
Lists the Device Defender security profiles attached to a target (thing group).default ListSecurityProfilesForTargetIterable
listSecurityProfilesForTargetPaginator(Consumer<ListSecurityProfilesForTargetRequest.Builder> listSecurityProfilesForTargetRequest)
Lists the Device Defender security profiles attached to a target (thing group).default ListSecurityProfilesForTargetIterable
listSecurityProfilesForTargetPaginator(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest)
Lists the Device Defender security profiles attached to a target (thing group).default ListSecurityProfilesIterable
listSecurityProfilesPaginator()
Lists the Device Defender security profiles you've created.default ListSecurityProfilesIterable
listSecurityProfilesPaginator(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest)
Lists the Device Defender security profiles you've created.default ListSecurityProfilesIterable
listSecurityProfilesPaginator(ListSecurityProfilesRequest listSecurityProfilesRequest)
Lists the Device Defender security profiles you've created.default ListStreamsResponse
listStreams()
Lists all of the streams in your Amazon Web Services account.default ListStreamsResponse
listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Lists all of the streams in your Amazon Web Services account.default ListStreamsResponse
listStreams(ListStreamsRequest listStreamsRequest)
Lists all of the streams in your Amazon Web Services account.default ListStreamsIterable
listStreamsPaginator()
Lists all of the streams in your Amazon Web Services account.default ListStreamsIterable
listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Lists all of the streams in your Amazon Web Services account.default ListStreamsIterable
listStreamsPaginator(ListStreamsRequest listStreamsRequest)
Lists all of the streams in your Amazon Web Services account.default ListTagsForResourceResponse
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags (metadata) you have assigned to the resource.default ListTagsForResourceResponse
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags (metadata) you have assigned to the resource.default ListTagsForResourceIterable
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags (metadata) you have assigned to the resource.default ListTagsForResourceIterable
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags (metadata) you have assigned to the resource.default ListTargetsForPolicyResponse
listTargetsForPolicy(Consumer<ListTargetsForPolicyRequest.Builder> listTargetsForPolicyRequest)
List targets for the specified policy.default ListTargetsForPolicyResponse
listTargetsForPolicy(ListTargetsForPolicyRequest listTargetsForPolicyRequest)
List targets for the specified policy.default ListTargetsForPolicyIterable
listTargetsForPolicyPaginator(Consumer<ListTargetsForPolicyRequest.Builder> listTargetsForPolicyRequest)
List targets for the specified policy.default ListTargetsForPolicyIterable
listTargetsForPolicyPaginator(ListTargetsForPolicyRequest listTargetsForPolicyRequest)
List targets for the specified policy.default ListTargetsForSecurityProfileResponse
listTargetsForSecurityProfile(Consumer<ListTargetsForSecurityProfileRequest.Builder> listTargetsForSecurityProfileRequest)
Lists the targets (thing groups) associated with a given Device Defender security profile.default ListTargetsForSecurityProfileResponse
listTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest)
Lists the targets (thing groups) associated with a given Device Defender security profile.default ListTargetsForSecurityProfileIterable
listTargetsForSecurityProfilePaginator(Consumer<ListTargetsForSecurityProfileRequest.Builder> listTargetsForSecurityProfileRequest)
Lists the targets (thing groups) associated with a given Device Defender security profile.default ListTargetsForSecurityProfileIterable
listTargetsForSecurityProfilePaginator(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest)
Lists the targets (thing groups) associated with a given Device Defender security profile.default ListThingGroupsResponse
listThingGroups()
List the thing groups in your account.default ListThingGroupsResponse
listThingGroups(Consumer<ListThingGroupsRequest.Builder> listThingGroupsRequest)
List the thing groups in your account.default ListThingGroupsResponse
listThingGroups(ListThingGroupsRequest listThingGroupsRequest)
List the thing groups in your account.default ListThingGroupsForThingResponse
listThingGroupsForThing(Consumer<ListThingGroupsForThingRequest.Builder> listThingGroupsForThingRequest)
List the thing groups to which the specified thing belongs.default ListThingGroupsForThingResponse
listThingGroupsForThing(ListThingGroupsForThingRequest listThingGroupsForThingRequest)
List the thing groups to which the specified thing belongs.default ListThingGroupsForThingIterable
listThingGroupsForThingPaginator(Consumer<ListThingGroupsForThingRequest.Builder> listThingGroupsForThingRequest)
List the thing groups to which the specified thing belongs.default ListThingGroupsForThingIterable
listThingGroupsForThingPaginator(ListThingGroupsForThingRequest listThingGroupsForThingRequest)
List the thing groups to which the specified thing belongs.default ListThingGroupsIterable
listThingGroupsPaginator()
List the thing groups in your account.default ListThingGroupsIterable
listThingGroupsPaginator(Consumer<ListThingGroupsRequest.Builder> listThingGroupsRequest)
List the thing groups in your account.default ListThingGroupsIterable
listThingGroupsPaginator(ListThingGroupsRequest listThingGroupsRequest)
List the thing groups in your account.default ListThingPrincipalsResponse
listThingPrincipals(Consumer<ListThingPrincipalsRequest.Builder> listThingPrincipalsRequest)
Lists the principals associated with the specified thing.default ListThingPrincipalsResponse
listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest)
Lists the principals associated with the specified thing.default ListThingPrincipalsIterable
listThingPrincipalsPaginator(Consumer<ListThingPrincipalsRequest.Builder> listThingPrincipalsRequest)
Lists the principals associated with the specified thing.default ListThingPrincipalsIterable
listThingPrincipalsPaginator(ListThingPrincipalsRequest listThingPrincipalsRequest)
Lists the principals associated with the specified thing.default ListThingRegistrationTaskReportsResponse
listThingRegistrationTaskReports(Consumer<ListThingRegistrationTaskReportsRequest.Builder> listThingRegistrationTaskReportsRequest)
Information about the thing registration tasks.default ListThingRegistrationTaskReportsResponse
listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest)
Information about the thing registration tasks.default ListThingRegistrationTaskReportsIterable
listThingRegistrationTaskReportsPaginator(Consumer<ListThingRegistrationTaskReportsRequest.Builder> listThingRegistrationTaskReportsRequest)
Information about the thing registration tasks.default ListThingRegistrationTaskReportsIterable
listThingRegistrationTaskReportsPaginator(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest)
Information about the thing registration tasks.default ListThingRegistrationTasksResponse
listThingRegistrationTasks()
List bulk thing provisioning tasks.default ListThingRegistrationTasksResponse
listThingRegistrationTasks(Consumer<ListThingRegistrationTasksRequest.Builder> listThingRegistrationTasksRequest)
List bulk thing provisioning tasks.default ListThingRegistrationTasksResponse
listThingRegistrationTasks(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest)
List bulk thing provisioning tasks.default ListThingRegistrationTasksIterable
listThingRegistrationTasksPaginator()
List bulk thing provisioning tasks.default ListThingRegistrationTasksIterable
listThingRegistrationTasksPaginator(Consumer<ListThingRegistrationTasksRequest.Builder> listThingRegistrationTasksRequest)
List bulk thing provisioning tasks.default ListThingRegistrationTasksIterable
listThingRegistrationTasksPaginator(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest)
List bulk thing provisioning tasks.default ListThingsResponse
listThings()
Lists your things.default ListThingsResponse
listThings(Consumer<ListThingsRequest.Builder> listThingsRequest)
Lists your things.default ListThingsResponse
listThings(ListThingsRequest listThingsRequest)
Lists your things.default ListThingsInBillingGroupResponse
listThingsInBillingGroup(Consumer<ListThingsInBillingGroupRequest.Builder> listThingsInBillingGroupRequest)
Lists the things you have added to the given billing group.default ListThingsInBillingGroupResponse
listThingsInBillingGroup(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest)
Lists the things you have added to the given billing group.default ListThingsInBillingGroupIterable
listThingsInBillingGroupPaginator(Consumer<ListThingsInBillingGroupRequest.Builder> listThingsInBillingGroupRequest)
Lists the things you have added to the given billing group.default ListThingsInBillingGroupIterable
listThingsInBillingGroupPaginator(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest)
Lists the things you have added to the given billing group.default ListThingsInThingGroupResponse
listThingsInThingGroup(Consumer<ListThingsInThingGroupRequest.Builder> listThingsInThingGroupRequest)
Lists the things in the specified group.default ListThingsInThingGroupResponse
listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest)
Lists the things in the specified group.default ListThingsInThingGroupIterable
listThingsInThingGroupPaginator(Consumer<ListThingsInThingGroupRequest.Builder> listThingsInThingGroupRequest)
Lists the things in the specified group.default ListThingsInThingGroupIterable
listThingsInThingGroupPaginator(ListThingsInThingGroupRequest listThingsInThingGroupRequest)
Lists the things in the specified group.default ListThingsIterable
listThingsPaginator()
Lists your things.default ListThingsIterable
listThingsPaginator(Consumer<ListThingsRequest.Builder> listThingsRequest)
Lists your things.default ListThingsIterable
listThingsPaginator(ListThingsRequest listThingsRequest)
Lists your things.default ListThingTypesResponse
listThingTypes()
Lists the existing thing types.default ListThingTypesResponse
listThingTypes(Consumer<ListThingTypesRequest.Builder> listThingTypesRequest)
Lists the existing thing types.default ListThingTypesResponse
listThingTypes(ListThingTypesRequest listThingTypesRequest)
Lists the existing thing types.default ListThingTypesIterable
listThingTypesPaginator()
Lists the existing thing types.default ListThingTypesIterable
listThingTypesPaginator(Consumer<ListThingTypesRequest.Builder> listThingTypesRequest)
Lists the existing thing types.default ListThingTypesIterable
listThingTypesPaginator(ListThingTypesRequest listThingTypesRequest)
Lists the existing thing types.default ListTopicRuleDestinationsResponse
listTopicRuleDestinations(Consumer<ListTopicRuleDestinationsRequest.Builder> listTopicRuleDestinationsRequest)
Lists all the topic rule destinations in your Amazon Web Services account.default ListTopicRuleDestinationsResponse
listTopicRuleDestinations(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest)
Lists all the topic rule destinations in your Amazon Web Services account.default ListTopicRuleDestinationsIterable
listTopicRuleDestinationsPaginator(Consumer<ListTopicRuleDestinationsRequest.Builder> listTopicRuleDestinationsRequest)
Lists all the topic rule destinations in your Amazon Web Services account.default ListTopicRuleDestinationsIterable
listTopicRuleDestinationsPaginator(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest)
Lists all the topic rule destinations in your Amazon Web Services account.default ListTopicRulesResponse
listTopicRules()
Lists the rules for the specific topic.default ListTopicRulesResponse
listTopicRules(Consumer<ListTopicRulesRequest.Builder> listTopicRulesRequest)
Lists the rules for the specific topic.default ListTopicRulesResponse
listTopicRules(ListTopicRulesRequest listTopicRulesRequest)
Lists the rules for the specific topic.default ListTopicRulesIterable
listTopicRulesPaginator()
Lists the rules for the specific topic.default ListTopicRulesIterable
listTopicRulesPaginator(Consumer<ListTopicRulesRequest.Builder> listTopicRulesRequest)
Lists the rules for the specific topic.default ListTopicRulesIterable
listTopicRulesPaginator(ListTopicRulesRequest listTopicRulesRequest)
Lists the rules for the specific topic.default ListV2LoggingLevelsResponse
listV2LoggingLevels(Consumer<ListV2LoggingLevelsRequest.Builder> listV2LoggingLevelsRequest)
Lists logging levels.default ListV2LoggingLevelsResponse
listV2LoggingLevels(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest)
Lists logging levels.default ListV2LoggingLevelsIterable
listV2LoggingLevelsPaginator(Consumer<ListV2LoggingLevelsRequest.Builder> listV2LoggingLevelsRequest)
Lists logging levels.default ListV2LoggingLevelsIterable
listV2LoggingLevelsPaginator(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest)
Lists logging levels.default ListViolationEventsResponse
listViolationEvents(Consumer<ListViolationEventsRequest.Builder> listViolationEventsRequest)
Lists the Device Defender security profile violations discovered during the given time period.default ListViolationEventsResponse
listViolationEvents(ListViolationEventsRequest listViolationEventsRequest)
Lists the Device Defender security profile violations discovered during the given time period.default ListViolationEventsIterable
listViolationEventsPaginator(Consumer<ListViolationEventsRequest.Builder> listViolationEventsRequest)
Lists the Device Defender security profile violations discovered during the given time period.default ListViolationEventsIterable
listViolationEventsPaginator(ListViolationEventsRequest listViolationEventsRequest)
Lists the Device Defender security profile violations discovered during the given time period.default PutVerificationStateOnViolationResponse
putVerificationStateOnViolation(Consumer<PutVerificationStateOnViolationRequest.Builder> putVerificationStateOnViolationRequest)
Set a verification state and provide a description of that verification state on a violation (detect alarm).default PutVerificationStateOnViolationResponse
putVerificationStateOnViolation(PutVerificationStateOnViolationRequest putVerificationStateOnViolationRequest)
Set a verification state and provide a description of that verification state on a violation (detect alarm).default RegisterCaCertificateResponse
registerCACertificate(Consumer<RegisterCaCertificateRequest.Builder> registerCaCertificateRequest)
Registers a CA certificate with Amazon Web Services IoT Core.default RegisterCaCertificateResponse
registerCACertificate(RegisterCaCertificateRequest registerCaCertificateRequest)
Registers a CA certificate with Amazon Web Services IoT Core.default RegisterCertificateResponse
registerCertificate(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest)
Registers a device certificate with IoT in the same certificate mode as the signing CA.default RegisterCertificateResponse
registerCertificate(RegisterCertificateRequest registerCertificateRequest)
Registers a device certificate with IoT in the same certificate mode as the signing CA.default RegisterCertificateWithoutCaResponse
registerCertificateWithoutCA(Consumer<RegisterCertificateWithoutCaRequest.Builder> registerCertificateWithoutCaRequest)
Register a certificate that does not have a certificate authority (CA).default RegisterCertificateWithoutCaResponse
registerCertificateWithoutCA(RegisterCertificateWithoutCaRequest registerCertificateWithoutCaRequest)
Register a certificate that does not have a certificate authority (CA).default RegisterThingResponse
registerThing(Consumer<RegisterThingRequest.Builder> registerThingRequest)
Provisions a thing in the device registry.default RegisterThingResponse
registerThing(RegisterThingRequest registerThingRequest)
Provisions a thing in the device registry.default RejectCertificateTransferResponse
rejectCertificateTransfer(Consumer<RejectCertificateTransferRequest.Builder> rejectCertificateTransferRequest)
Rejects a pending certificate transfer.default RejectCertificateTransferResponse
rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest)
Rejects a pending certificate transfer.default RemoveThingFromBillingGroupResponse
removeThingFromBillingGroup(Consumer<RemoveThingFromBillingGroupRequest.Builder> removeThingFromBillingGroupRequest)
Removes the given thing from the billing group.default RemoveThingFromBillingGroupResponse
removeThingFromBillingGroup(RemoveThingFromBillingGroupRequest removeThingFromBillingGroupRequest)
Removes the given thing from the billing group.default RemoveThingFromThingGroupResponse
removeThingFromThingGroup(Consumer<RemoveThingFromThingGroupRequest.Builder> removeThingFromThingGroupRequest)
Remove the specified thing from the specified group.default RemoveThingFromThingGroupResponse
removeThingFromThingGroup(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest)
Remove the specified thing from the specified group.default ReplaceTopicRuleResponse
replaceTopicRule(Consumer<ReplaceTopicRuleRequest.Builder> replaceTopicRuleRequest)
Replaces the rule.default ReplaceTopicRuleResponse
replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest)
Replaces the rule.default SearchIndexResponse
searchIndex(Consumer<SearchIndexRequest.Builder> searchIndexRequest)
The query search index.default SearchIndexResponse
searchIndex(SearchIndexRequest searchIndexRequest)
The query search index.default IotServiceClientConfiguration
serviceClientConfiguration()
static ServiceMetadata
serviceMetadata()
default SetDefaultAuthorizerResponse
setDefaultAuthorizer(Consumer<SetDefaultAuthorizerRequest.Builder> setDefaultAuthorizerRequest)
Sets the default authorizer.default SetDefaultAuthorizerResponse
setDefaultAuthorizer(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest)
Sets the default authorizer.default SetDefaultPolicyVersionResponse
setDefaultPolicyVersion(Consumer<SetDefaultPolicyVersionRequest.Builder> setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's default (operative) version.default SetDefaultPolicyVersionResponse
setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest)
Sets the specified version of the specified policy as the policy's default (operative) version.default SetLoggingOptionsResponse
setLoggingOptions(Consumer<SetLoggingOptionsRequest.Builder> setLoggingOptionsRequest)
Sets the logging options.default SetLoggingOptionsResponse
setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest)
Sets the logging options.default SetV2LoggingLevelResponse
setV2LoggingLevel(Consumer<SetV2LoggingLevelRequest.Builder> setV2LoggingLevelRequest)
Sets the logging level.default SetV2LoggingLevelResponse
setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest)
Sets the logging level.default SetV2LoggingOptionsResponse
setV2LoggingOptions(Consumer<SetV2LoggingOptionsRequest.Builder> setV2LoggingOptionsRequest)
Sets the logging options for the V2 logging service.default SetV2LoggingOptionsResponse
setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest)
Sets the logging options for the V2 logging service.default StartAuditMitigationActionsTaskResponse
startAuditMitigationActionsTask(Consumer<StartAuditMitigationActionsTaskRequest.Builder> startAuditMitigationActionsTaskRequest)
Starts a task that applies a set of mitigation actions to the specified target.default StartAuditMitigationActionsTaskResponse
startAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest startAuditMitigationActionsTaskRequest)
Starts a task that applies a set of mitigation actions to the specified target.default StartDetectMitigationActionsTaskResponse
startDetectMitigationActionsTask(Consumer<StartDetectMitigationActionsTaskRequest.Builder> startDetectMitigationActionsTaskRequest)
Starts a Device Defender ML Detect mitigation actions task.default StartDetectMitigationActionsTaskResponse
startDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest startDetectMitigationActionsTaskRequest)
Starts a Device Defender ML Detect mitigation actions task.default StartOnDemandAuditTaskResponse
startOnDemandAuditTask(Consumer<StartOnDemandAuditTaskRequest.Builder> startOnDemandAuditTaskRequest)
Starts an on-demand Device Defender audit.default StartOnDemandAuditTaskResponse
startOnDemandAuditTask(StartOnDemandAuditTaskRequest startOnDemandAuditTaskRequest)
Starts an on-demand Device Defender audit.default StartThingRegistrationTaskResponse
startThingRegistrationTask(Consumer<StartThingRegistrationTaskRequest.Builder> startThingRegistrationTaskRequest)
Creates a bulk thing provisioning task.default StartThingRegistrationTaskResponse
startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest)
Creates a bulk thing provisioning task.default StopThingRegistrationTaskResponse
stopThingRegistrationTask(Consumer<StopThingRegistrationTaskRequest.Builder> stopThingRegistrationTaskRequest)
Cancels a bulk thing provisioning task.default StopThingRegistrationTaskResponse
stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest)
Cancels a bulk thing provisioning task.default TagResourceResponse
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds to or modifies the tags of the given resource.default TagResourceResponse
tagResource(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource.default TestAuthorizationResponse
testAuthorization(Consumer<TestAuthorizationRequest.Builder> testAuthorizationRequest)
Tests if a specified principal is authorized to perform an IoT action on a specified resource.default TestAuthorizationResponse
testAuthorization(TestAuthorizationRequest testAuthorizationRequest)
Tests if a specified principal is authorized to perform an IoT action on a specified resource.default TestInvokeAuthorizerResponse
testInvokeAuthorizer(Consumer<TestInvokeAuthorizerRequest.Builder> testInvokeAuthorizerRequest)
Tests a custom authorization behavior by invoking a specified custom authorizer.default TestInvokeAuthorizerResponse
testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest)
Tests a custom authorization behavior by invoking a specified custom authorizer.default TransferCertificateResponse
transferCertificate(Consumer<TransferCertificateRequest.Builder> transferCertificateRequest)
Transfers the specified certificate to the specified Amazon Web Services account.default TransferCertificateResponse
transferCertificate(TransferCertificateRequest transferCertificateRequest)
Transfers the specified certificate to the specified Amazon Web Services account.default UntagResourceResponse
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the given tags (metadata) from the resource.default UntagResourceResponse
untagResource(UntagResourceRequest untagResourceRequest)
Removes the given tags (metadata) from the resource.default UpdateAccountAuditConfigurationResponse
updateAccountAuditConfiguration(Consumer<UpdateAccountAuditConfigurationRequest.Builder> updateAccountAuditConfigurationRequest)
Configures or reconfigures the Device Defender audit settings for this account.default UpdateAccountAuditConfigurationResponse
updateAccountAuditConfiguration(UpdateAccountAuditConfigurationRequest updateAccountAuditConfigurationRequest)
Configures or reconfigures the Device Defender audit settings for this account.default UpdateAuditSuppressionResponse
updateAuditSuppression(Consumer<UpdateAuditSuppressionRequest.Builder> updateAuditSuppressionRequest)
Updates a Device Defender audit suppression.default UpdateAuditSuppressionResponse
updateAuditSuppression(UpdateAuditSuppressionRequest updateAuditSuppressionRequest)
Updates a Device Defender audit suppression.default UpdateAuthorizerResponse
updateAuthorizer(Consumer<UpdateAuthorizerRequest.Builder> updateAuthorizerRequest)
Updates an authorizer.default UpdateAuthorizerResponse
updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest)
Updates an authorizer.default UpdateBillingGroupResponse
updateBillingGroup(Consumer<UpdateBillingGroupRequest.Builder> updateBillingGroupRequest)
Updates information about the billing group.default UpdateBillingGroupResponse
updateBillingGroup(UpdateBillingGroupRequest updateBillingGroupRequest)
Updates information about the billing group.default UpdateCaCertificateResponse
updateCACertificate(Consumer<UpdateCaCertificateRequest.Builder> updateCaCertificateRequest)
Updates a registered CA certificate.default UpdateCaCertificateResponse
updateCACertificate(UpdateCaCertificateRequest updateCaCertificateRequest)
Updates a registered CA certificate.default UpdateCertificateResponse
updateCertificate(Consumer<UpdateCertificateRequest.Builder> updateCertificateRequest)
Updates the status of the specified certificate.default UpdateCertificateResponse
updateCertificate(UpdateCertificateRequest updateCertificateRequest)
Updates the status of the specified certificate.default UpdateCustomMetricResponse
updateCustomMetric(Consumer<UpdateCustomMetricRequest.Builder> updateCustomMetricRequest)
Updates a Device Defender detect custom metric.default UpdateCustomMetricResponse
updateCustomMetric(UpdateCustomMetricRequest updateCustomMetricRequest)
Updates a Device Defender detect custom metric.default UpdateDimensionResponse
updateDimension(Consumer<UpdateDimensionRequest.Builder> updateDimensionRequest)
Updates the definition for a dimension.default UpdateDimensionResponse
updateDimension(UpdateDimensionRequest updateDimensionRequest)
Updates the definition for a dimension.default UpdateDomainConfigurationResponse
updateDomainConfiguration(Consumer<UpdateDomainConfigurationRequest.Builder> updateDomainConfigurationRequest)
Updates values stored in the domain configuration.default UpdateDomainConfigurationResponse
updateDomainConfiguration(UpdateDomainConfigurationRequest updateDomainConfigurationRequest)
Updates values stored in the domain configuration.default UpdateDynamicThingGroupResponse
updateDynamicThingGroup(Consumer<UpdateDynamicThingGroupRequest.Builder> updateDynamicThingGroupRequest)
Updates a dynamic thing group.default UpdateDynamicThingGroupResponse
updateDynamicThingGroup(UpdateDynamicThingGroupRequest updateDynamicThingGroupRequest)
Updates a dynamic thing group.default UpdateEventConfigurationsResponse
updateEventConfigurations(Consumer<UpdateEventConfigurationsRequest.Builder> updateEventConfigurationsRequest)
Updates the event configurations.default UpdateEventConfigurationsResponse
updateEventConfigurations(UpdateEventConfigurationsRequest updateEventConfigurationsRequest)
Updates the event configurations.default UpdateFleetMetricResponse
updateFleetMetric(Consumer<UpdateFleetMetricRequest.Builder> updateFleetMetricRequest)
Updates the data for a fleet metric.default UpdateFleetMetricResponse
updateFleetMetric(UpdateFleetMetricRequest updateFleetMetricRequest)
Updates the data for a fleet metric.default UpdateIndexingConfigurationResponse
updateIndexingConfiguration(Consumer<UpdateIndexingConfigurationRequest.Builder> updateIndexingConfigurationRequest)
Updates the search configuration.default UpdateIndexingConfigurationResponse
updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest)
Updates the search configuration.default UpdateJobResponse
updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest)
Updates supported fields of the specified job.default UpdateJobResponse
updateJob(UpdateJobRequest updateJobRequest)
Updates supported fields of the specified job.default UpdateMitigationActionResponse
updateMitigationAction(Consumer<UpdateMitigationActionRequest.Builder> updateMitigationActionRequest)
Updates the definition for the specified mitigation action.default UpdateMitigationActionResponse
updateMitigationAction(UpdateMitigationActionRequest updateMitigationActionRequest)
Updates the definition for the specified mitigation action.default UpdatePackageResponse
updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest)
Updates the supported fields for a specific software package.default UpdatePackageResponse
updatePackage(UpdatePackageRequest updatePackageRequest)
Updates the supported fields for a specific software package.default UpdatePackageConfigurationResponse
updatePackageConfiguration(Consumer<UpdatePackageConfigurationRequest.Builder> updatePackageConfigurationRequest)
Updates the software package configuration.default UpdatePackageConfigurationResponse
updatePackageConfiguration(UpdatePackageConfigurationRequest updatePackageConfigurationRequest)
Updates the software package configuration.default UpdatePackageVersionResponse
updatePackageVersion(Consumer<UpdatePackageVersionRequest.Builder> updatePackageVersionRequest)
Updates the supported fields for a specific package version.default UpdatePackageVersionResponse
updatePackageVersion(UpdatePackageVersionRequest updatePackageVersionRequest)
Updates the supported fields for a specific package version.default UpdateProvisioningTemplateResponse
updateProvisioningTemplate(Consumer<UpdateProvisioningTemplateRequest.Builder> updateProvisioningTemplateRequest)
Updates a provisioning template.default UpdateProvisioningTemplateResponse
updateProvisioningTemplate(UpdateProvisioningTemplateRequest updateProvisioningTemplateRequest)
Updates a provisioning template.default UpdateRoleAliasResponse
updateRoleAlias(Consumer<UpdateRoleAliasRequest.Builder> updateRoleAliasRequest)
Updates a role alias.default UpdateRoleAliasResponse
updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest)
Updates a role alias.default UpdateScheduledAuditResponse
updateScheduledAudit(Consumer<UpdateScheduledAuditRequest.Builder> updateScheduledAuditRequest)
Updates a scheduled audit, including which checks are performed and how often the audit takes place.default UpdateScheduledAuditResponse
updateScheduledAudit(UpdateScheduledAuditRequest updateScheduledAuditRequest)
Updates a scheduled audit, including which checks are performed and how often the audit takes place.default UpdateSecurityProfileResponse
updateSecurityProfile(Consumer<UpdateSecurityProfileRequest.Builder> updateSecurityProfileRequest)
Updates a Device Defender security profile.default UpdateSecurityProfileResponse
updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest)
Updates a Device Defender security profile.default UpdateStreamResponse
updateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest)
Updates an existing stream.default UpdateStreamResponse
updateStream(UpdateStreamRequest updateStreamRequest)
Updates an existing stream.default UpdateThingResponse
updateThing(Consumer<UpdateThingRequest.Builder> updateThingRequest)
Updates the data for a thing.default UpdateThingResponse
updateThing(UpdateThingRequest updateThingRequest)
Updates the data for a thing.default UpdateThingGroupResponse
updateThingGroup(Consumer<UpdateThingGroupRequest.Builder> updateThingGroupRequest)
Update a thing group.default UpdateThingGroupResponse
updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest)
Update a thing group.default UpdateThingGroupsForThingResponse
updateThingGroupsForThing(Consumer<UpdateThingGroupsForThingRequest.Builder> updateThingGroupsForThingRequest)
Updates the groups to which the thing belongs.default UpdateThingGroupsForThingResponse
updateThingGroupsForThing(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest)
Updates the groups to which the thing belongs.default UpdateTopicRuleDestinationResponse
updateTopicRuleDestination(Consumer<UpdateTopicRuleDestinationRequest.Builder> updateTopicRuleDestinationRequest)
Updates a topic rule destination.default UpdateTopicRuleDestinationResponse
updateTopicRuleDestination(UpdateTopicRuleDestinationRequest updateTopicRuleDestinationRequest)
Updates a topic rule destination.default ValidateSecurityProfileBehaviorsResponse
validateSecurityProfileBehaviors(Consumer<ValidateSecurityProfileBehaviorsRequest.Builder> validateSecurityProfileBehaviorsRequest)
Validates a Device Defender security profile behaviors specification.default ValidateSecurityProfileBehaviorsResponse
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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptCertificateTransfer
default AcceptCertificateTransferResponse acceptCertificateTransfer(AcceptCertificateTransferRequest acceptCertificateTransferRequest) throws ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AcceptCertificateTransfer operation returned by the service.
- Throws:
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.AwsServiceException
-
acceptCertificateTransfer
default AcceptCertificateTransferResponse acceptCertificateTransfer(Consumer<AcceptCertificateTransferRequest.Builder> acceptCertificateTransferRequest) throws ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AcceptCertificateTransfer operation returned by the service.
- Throws:
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.AwsServiceException
-
addThingToBillingGroup
default AddThingToBillingGroupResponse addThingToBillingGroup(AddThingToBillingGroupRequest addThingToBillingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Adds a thing to a billing group.
Requires permission to access the AddThingToBillingGroup action.
- Parameters:
addThingToBillingGroupRequest
-- Returns:
- Result of the AddThingToBillingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
addThingToBillingGroup
default AddThingToBillingGroupResponse addThingToBillingGroup(Consumer<AddThingToBillingGroupRequest.Builder> addThingToBillingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AddThingToBillingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
addThingToThingGroup
default AddThingToThingGroupResponse addThingToThingGroup(AddThingToThingGroupRequest addThingToThingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Adds a thing to a thing group.
Requires permission to access the AddThingToThingGroup action.
- Parameters:
addThingToThingGroupRequest
-- Returns:
- Result of the AddThingToThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
addThingToThingGroup
default AddThingToThingGroupResponse addThingToThingGroup(Consumer<AddThingToThingGroupRequest.Builder> addThingToThingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AddThingToThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
associateTargetsWithJob
default AssociateTargetsWithJobResponse associateTargetsWithJob(AssociateTargetsWithJobRequest associateTargetsWithJobRequest) throws InvalidRequestException, ResourceNotFoundException, LimitExceededException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AssociateTargetsWithJob operation returned by the service.
- Throws:
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.AwsServiceException
-
-
associateTargetsWithJob
default AssociateTargetsWithJobResponse associateTargetsWithJob(Consumer<AssociateTargetsWithJobRequest.Builder> associateTargetsWithJobRequest) throws InvalidRequestException, ResourceNotFoundException, LimitExceededException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AssociateTargetsWithJob operation returned by the service.
- Throws:
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.AwsServiceException
-
-
attachPolicy
default AttachPolicyResponse attachPolicy(AttachPolicyRequest attachPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
Attaches the specified policy to the specified principal (certificate or other credential).
Requires permission to access the AttachPolicy action.
- Parameters:
attachPolicyRequest
-- Returns:
- Result of the AttachPolicy operation returned by the service.
- Throws:
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.AwsServiceException
-
attachPolicy
default AttachPolicyResponse attachPolicy(Consumer<AttachPolicyRequest.Builder> attachPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AttachPolicy operation returned by the service.
- Throws:
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.AwsServiceException
-
attachSecurityProfile
default AttachSecurityProfileResponse attachSecurityProfile(AttachSecurityProfileRequest attachSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, LimitExceededException, VersionConflictException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AttachSecurityProfile operation returned by the service.
- Throws:
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 theexpectedVersion
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.AwsServiceException
-
attachSecurityProfile
default AttachSecurityProfileResponse attachSecurityProfile(Consumer<AttachSecurityProfileRequest.Builder> attachSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, LimitExceededException, VersionConflictException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AttachSecurityProfile operation returned by the service.
- Throws:
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 theexpectedVersion
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.AwsServiceException
-
attachThingPrincipal
default AttachThingPrincipalResponse attachThingPrincipal(AttachThingPrincipalRequest attachThingPrincipalRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AttachThingPrincipal operation returned by the service.
- Throws:
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.AwsServiceException
-
attachThingPrincipal
default AttachThingPrincipalResponse attachThingPrincipal(Consumer<AttachThingPrincipalRequest.Builder> attachThingPrincipalRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the AttachThingPrincipal operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelAuditMitigationActionsTask
default CancelAuditMitigationActionsTaskResponse cancelAuditMitigationActionsTask(CancelAuditMitigationActionsTaskRequest cancelAuditMitigationActionsTaskRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CancelAuditMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelAuditMitigationActionsTask
default CancelAuditMitigationActionsTaskResponse cancelAuditMitigationActionsTask(Consumer<CancelAuditMitigationActionsTaskRequest.Builder> cancelAuditMitigationActionsTaskRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CancelAuditMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelAuditTask
default CancelAuditTaskResponse cancelAuditTask(CancelAuditTaskRequest cancelAuditTaskRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CancelAuditTask operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelAuditTask
default CancelAuditTaskResponse cancelAuditTask(Consumer<CancelAuditTaskRequest.Builder> cancelAuditTaskRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CancelAuditTask operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelCertificateTransfer
default CancelCertificateTransferResponse cancelCertificateTransfer(CancelCertificateTransferRequest cancelCertificateTransferRequest) throws ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CancelCertificateTransfer operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelCertificateTransfer
default CancelCertificateTransferResponse cancelCertificateTransfer(Consumer<CancelCertificateTransferRequest.Builder> cancelCertificateTransferRequest) throws ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CancelCertificateTransfer operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelDetectMitigationActionsTask
default CancelDetectMitigationActionsTaskResponse cancelDetectMitigationActionsTask(CancelDetectMitigationActionsTaskRequest cancelDetectMitigationActionsTaskRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Cancels a Device Defender ML Detect mitigation action.
Requires permission to access the CancelDetectMitigationActionsTask action.
- Parameters:
cancelDetectMitigationActionsTaskRequest
-- Returns:
- Result of the CancelDetectMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelDetectMitigationActionsTask
default CancelDetectMitigationActionsTaskResponse cancelDetectMitigationActionsTask(Consumer<CancelDetectMitigationActionsTaskRequest.Builder> cancelDetectMitigationActionsTaskRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CancelDetectMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelJob
default CancelJobResponse cancelJob(CancelJobRequest cancelJobRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, IotException
Cancels a job.
Requires permission to access the CancelJob action.
- Parameters:
cancelJobRequest
-- Returns:
- Result of the CancelJob operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelJob
default CancelJobResponse cancelJob(Consumer<CancelJobRequest.Builder> cancelJobRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CancelJob operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelJobExecution
default CancelJobExecutionResponse cancelJobExecution(CancelJobExecutionRequest cancelJobExecutionRequest) throws InvalidRequestException, InvalidStateTransitionException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, VersionConflictException, AwsServiceException, SdkClientException, IotException
Cancels the execution of a job for a given thing.
Requires permission to access the CancelJobExecution action.
- Parameters:
cancelJobExecutionRequest
-- Returns:
- Result of the CancelJobExecution operation returned by the service.
- Throws:
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 theforce
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 theexpectedVersion
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.AwsServiceException
-
cancelJobExecution
default CancelJobExecutionResponse cancelJobExecution(Consumer<CancelJobExecutionRequest.Builder> cancelJobExecutionRequest) throws InvalidRequestException, InvalidStateTransitionException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, VersionConflictException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CancelJobExecution operation returned by the service.
- Throws:
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 theforce
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 theexpectedVersion
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.AwsServiceException
-
clearDefaultAuthorizer
default ClearDefaultAuthorizerResponse clearDefaultAuthorizer(ClearDefaultAuthorizerRequest clearDefaultAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
- Parameters:
clearDefaultAuthorizerRequest
-- Returns:
- Result of the ClearDefaultAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
clearDefaultAuthorizer
default ClearDefaultAuthorizerResponse clearDefaultAuthorizer(Consumer<ClearDefaultAuthorizerRequest.Builder> clearDefaultAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ClearDefaultAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
clearDefaultAuthorizer
default ClearDefaultAuthorizerResponse clearDefaultAuthorizer() throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Clears the default authorizer.
Requires permission to access the ClearDefaultAuthorizer action.
- Returns:
- Result of the ClearDefaultAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
clearDefaultAuthorizer(ClearDefaultAuthorizerRequest)
-
confirmTopicRuleDestination
default ConfirmTopicRuleDestinationResponse confirmTopicRuleDestination(ConfirmTopicRuleDestinationRequest confirmTopicRuleDestinationRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ConfirmTopicRuleDestination operation returned by the service.
- Throws:
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.AwsServiceException
-
confirmTopicRuleDestination
default ConfirmTopicRuleDestinationResponse confirmTopicRuleDestination(Consumer<ConfirmTopicRuleDestinationRequest.Builder> confirmTopicRuleDestinationRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ConfirmTopicRuleDestination operation returned by the service.
- Throws:
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.AwsServiceException
-
createAuditSuppression
default CreateAuditSuppressionResponse createAuditSuppression(CreateAuditSuppressionRequest createAuditSuppressionRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
Creates a Device Defender audit suppression.
Requires permission to access the CreateAuditSuppression action.
- Parameters:
createAuditSuppressionRequest
-- Returns:
- Result of the CreateAuditSuppression operation returned by the service.
- Throws:
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.AwsServiceException
-
createAuditSuppression
default CreateAuditSuppressionResponse createAuditSuppression(Consumer<CreateAuditSuppressionRequest.Builder> createAuditSuppressionRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateAuditSuppression operation returned by the service.
- Throws:
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.AwsServiceException
-
createAuthorizer
default CreateAuthorizerResponse createAuthorizer(CreateAuthorizerRequest createAuthorizerRequest) throws ResourceAlreadyExistsException, InvalidRequestException, LimitExceededException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates an authorizer.
Requires permission to access the CreateAuthorizer action.
- Parameters:
createAuthorizerRequest
-- Returns:
- Result of the CreateAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
createAuthorizer
default CreateAuthorizerResponse createAuthorizer(Consumer<CreateAuthorizerRequest.Builder> createAuthorizerRequest) throws ResourceAlreadyExistsException, InvalidRequestException, LimitExceededException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
createBillingGroup
default CreateBillingGroupResponse createBillingGroup(CreateBillingGroupRequest createBillingGroupRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates a billing group.
Requires permission to access the CreateBillingGroup action.
- Parameters:
createBillingGroupRequest
-- Returns:
- Result of the CreateBillingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
createBillingGroup
default CreateBillingGroupResponse createBillingGroup(Consumer<CreateBillingGroupRequest.Builder> createBillingGroupRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates a billing group.
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:
- Result of the CreateBillingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
createCertificateFromCsr
default CreateCertificateFromCsrResponse createCertificateFromCsr(CreateCertificateFromCsrRequest createCertificateFromCsrRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates an X.509 certificate using the specified certificate signing request.
Requires permission to access the CreateCertificateFromCsr action.
The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple
.csr
files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are located inside of the directory my-csr-directory:On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the
aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for the corresponding CSR.You can also run the
aws iot create-certificate-from-csr
part of the command in parallel to speed up the certificate creation process:$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
- Parameters:
createCertificateFromCsrRequest
- The input for the CreateCertificateFromCsr operation.- Returns:
- Result of the CreateCertificateFromCsr operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
createCertificateFromCsr
default CreateCertificateFromCsrResponse createCertificateFromCsr(Consumer<CreateCertificateFromCsrRequest.Builder> createCertificateFromCsrRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates an X.509 certificate using the specified certificate signing request.
Requires permission to access the CreateCertificateFromCsr action.
The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256, NIST P-384, or NIST P-521 curves. For supported certificates, consult Certificate signing algorithms supported by IoT.
Reusing the same certificate signing request (CSR) results in a distinct certificate.
You can create multiple certificates in a batch by creating a directory, copying multiple
.csr
files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. In the following commands, we assume that a set of CSRs are located inside of the directory my-csr-directory:On Linux and OS X, the command is:
$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the
aws iot create-certificate-from-csr
Amazon Web Services CLI command to create a certificate for the corresponding CSR.You can also run the
aws iot create-certificate-from-csr
part of the command in parallel to speed up the certificate creation process:$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}
On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:
> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}
On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:
> forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
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:
- Result of the CreateCertificateFromCsr operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
createCustomMetric
default CreateCustomMetricResponse createCustomMetric(CreateCustomMetricRequest createCustomMetricRequest) throws InvalidRequestException, LimitExceededException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateCustomMetric operation returned by the service.
- Throws:
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.AwsServiceException
-
createCustomMetric
default CreateCustomMetricResponse createCustomMetric(Consumer<CreateCustomMetricRequest.Builder> createCustomMetricRequest) throws InvalidRequestException, LimitExceededException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateCustomMetric operation returned by the service.
- Throws:
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.AwsServiceException
-
createDimension
default CreateDimensionResponse createDimension(CreateDimensionRequest createDimensionRequest) throws InternalFailureException, InvalidRequestException, LimitExceededException, ResourceAlreadyExistsException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateDimension operation returned by the service.
- Throws:
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.AwsServiceException
-
createDimension
default CreateDimensionResponse createDimension(Consumer<CreateDimensionRequest.Builder> createDimensionRequest) throws InternalFailureException, InvalidRequestException, LimitExceededException, ResourceAlreadyExistsException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateDimension operation returned by the service.
- Throws:
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.AwsServiceException
-
createDomainConfiguration
default CreateDomainConfigurationResponse createDomainConfiguration(CreateDomainConfigurationRequest createDomainConfigurationRequest) throws LimitExceededException, CertificateValidationException, ResourceAlreadyExistsException, ServiceUnavailableException, InternalFailureException, InvalidRequestException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Creates a domain configuration.
Requires permission to access the CreateDomainConfiguration action.
- Parameters:
createDomainConfigurationRequest
-- Returns:
- Result of the CreateDomainConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
createDomainConfiguration
default CreateDomainConfigurationResponse createDomainConfiguration(Consumer<CreateDomainConfigurationRequest.Builder> createDomainConfigurationRequest) throws LimitExceededException, CertificateValidationException, ResourceAlreadyExistsException, ServiceUnavailableException, InternalFailureException, InvalidRequestException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateDomainConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
createDynamicThingGroup
default CreateDynamicThingGroupResponse createDynamicThingGroup(CreateDynamicThingGroupRequest createDynamicThingGroupRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, ThrottlingException, InternalFailureException, InvalidQueryException, LimitExceededException, AwsServiceException, SdkClientException, IotException
Creates a dynamic thing group.
Requires permission to access the CreateDynamicThingGroup action.
- Parameters:
createDynamicThingGroupRequest
-- Returns:
- Result of the CreateDynamicThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
createDynamicThingGroup
default CreateDynamicThingGroupResponse createDynamicThingGroup(Consumer<CreateDynamicThingGroupRequest.Builder> createDynamicThingGroupRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ResourceNotFoundException, ThrottlingException, InternalFailureException, InvalidQueryException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateDynamicThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
createFleetMetric
default CreateFleetMetricResponse createFleetMetric(CreateFleetMetricRequest createFleetMetricRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
Creates a fleet metric.
Requires permission to access the CreateFleetMetric action.
- Parameters:
createFleetMetricRequest
-- Returns:
- Result of the CreateFleetMetric operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
createFleetMetric
default CreateFleetMetricResponse createFleetMetric(Consumer<CreateFleetMetricRequest.Builder> createFleetMetricRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateFleetMetric operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
createJob
default CreateJobResponse createJob(CreateJobRequest createJobRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Creates a job.
Requires permission to access the CreateJob action.
- Parameters:
createJobRequest
-- Returns:
- Result of the CreateJob operation returned by the service.
- Throws:
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.AwsServiceException
-
createJob
default CreateJobResponse createJob(Consumer<CreateJobRequest.Builder> createJobRequest) throws InvalidRequestException, ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateJob operation returned by the service.
- Throws:
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.AwsServiceException
-
createJobTemplate
default CreateJobTemplateResponse createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ConflictException, LimitExceededException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates a job template.
Requires permission to access the CreateJobTemplate action.
- Parameters:
createJobTemplateRequest
-- Returns:
- Result of the CreateJobTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
createJobTemplate
default CreateJobTemplateResponse createJobTemplate(Consumer<CreateJobTemplateRequest.Builder> createJobTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ConflictException, LimitExceededException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateJobTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
createKeysAndCertificate
default CreateKeysAndCertificateResponse createKeysAndCertificate(CreateKeysAndCertificateRequest createKeysAndCertificateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateKeysAndCertificate operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
createKeysAndCertificate
default CreateKeysAndCertificateResponse createKeysAndCertificate(Consumer<CreateKeysAndCertificateRequest.Builder> createKeysAndCertificateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateKeysAndCertificate operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
createKeysAndCertificate
default CreateKeysAndCertificateResponse createKeysAndCertificate() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateKeysAndCertificate operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
createKeysAndCertificate(CreateKeysAndCertificateRequest)
-
createMitigationAction
default CreateMitigationActionResponse createMitigationAction(CreateMitigationActionRequest createMitigationActionRequest) throws InvalidRequestException, ResourceAlreadyExistsException, LimitExceededException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateMitigationAction operation returned by the service.
- Throws:
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.AwsServiceException
-
createMitigationAction
default CreateMitigationActionResponse createMitigationAction(Consumer<CreateMitigationActionRequest.Builder> createMitigationActionRequest) throws InvalidRequestException, ResourceAlreadyExistsException, LimitExceededException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateMitigationAction operation returned by the service.
- Throws:
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.AwsServiceException
-
createOTAUpdate
default CreateOtaUpdateResponse createOTAUpdate(CreateOtaUpdateRequest createOtaUpdateRequest) throws InvalidRequestException, LimitExceededException, ResourceNotFoundException, ResourceAlreadyExistsException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Creates an IoT OTA update on a target group of things or groups.
Requires permission to access the CreateOTAUpdate action.
- Parameters:
createOtaUpdateRequest
-- Returns:
- Result of the CreateOTAUpdate operation returned by the service.
- Throws:
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.AwsServiceException
-
createOTAUpdate
default CreateOtaUpdateResponse createOTAUpdate(Consumer<CreateOtaUpdateRequest.Builder> createOtaUpdateRequest) throws InvalidRequestException, LimitExceededException, ResourceNotFoundException, ResourceAlreadyExistsException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateOTAUpdate operation returned by the service.
- Throws:
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.AwsServiceException
-
createPackage
default CreatePackageResponse createPackage(CreatePackageRequest createPackageRequest) throws ThrottlingException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotException
Creates an IoT software package that can be deployed to your fleet.
Requires permission to access the CreatePackage and GetIndexingConfiguration actions.
- Parameters:
createPackageRequest
-- Returns:
- Result of the CreatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
createPackage
default CreatePackageResponse createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest) throws ThrottlingException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
createPackageVersion
default CreatePackageVersionResponse createPackageVersion(CreatePackageVersionRequest createPackageVersionRequest) throws ThrottlingException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotException
Creates a new version for an existing IoT software package.
Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
- Parameters:
createPackageVersionRequest
-- Returns:
- Result of the CreatePackageVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
createPackageVersion
default CreatePackageVersionResponse createPackageVersion(Consumer<CreatePackageVersionRequest.Builder> createPackageVersionRequest) throws ThrottlingException, ConflictException, InternalServerException, ValidationException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreatePackageVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
createPolicy
default CreatePolicyResponse createPolicy(CreatePolicyRequest createPolicyRequest) throws ResourceAlreadyExistsException, MalformedPolicyException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreatePolicy operation returned by the service.
- Throws:
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.AwsServiceException
-
createPolicy
default CreatePolicyResponse createPolicy(Consumer<CreatePolicyRequest.Builder> createPolicyRequest) throws ResourceAlreadyExistsException, MalformedPolicyException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreatePolicy operation returned by the service.
- Throws:
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.AwsServiceException
-
createPolicyVersion
default CreatePolicyVersionResponse createPolicyVersion(CreatePolicyVersionRequest createPolicyVersionRequest) throws ResourceNotFoundException, MalformedPolicyException, VersionsLimitExceededException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreatePolicyVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
createPolicyVersion
default CreatePolicyVersionResponse createPolicyVersion(Consumer<CreatePolicyVersionRequest.Builder> createPolicyVersionRequest) throws ResourceNotFoundException, MalformedPolicyException, VersionsLimitExceededException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreatePolicyVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
createProvisioningClaim
default CreateProvisioningClaimResponse createProvisioningClaim(CreateProvisioningClaimRequest createProvisioningClaimRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates a provisioning claim.
Requires permission to access the CreateProvisioningClaim action.
- Parameters:
createProvisioningClaimRequest
-- Returns:
- Result of the CreateProvisioningClaim operation returned by the service.
- Throws:
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.AwsServiceException
-
createProvisioningClaim
default CreateProvisioningClaimResponse createProvisioningClaim(Consumer<CreateProvisioningClaimRequest.Builder> createProvisioningClaimRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateProvisioningClaim operation returned by the service.
- Throws:
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.AwsServiceException
-
createProvisioningTemplate
default CreateProvisioningTemplateResponse createProvisioningTemplate(CreateProvisioningTemplateRequest createProvisioningTemplateRequest) throws InternalFailureException, InvalidRequestException, LimitExceededException, ThrottlingException, UnauthorizedException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, IotException
Creates a provisioning template.
Requires permission to access the CreateProvisioningTemplate action.
- Parameters:
createProvisioningTemplateRequest
-- Returns:
- Result of the CreateProvisioningTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
createProvisioningTemplate
default CreateProvisioningTemplateResponse createProvisioningTemplate(Consumer<CreateProvisioningTemplateRequest.Builder> createProvisioningTemplateRequest) throws InternalFailureException, InvalidRequestException, LimitExceededException, ThrottlingException, UnauthorizedException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateProvisioningTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
createProvisioningTemplateVersion
default CreateProvisioningTemplateVersionResponse createProvisioningTemplateVersion(CreateProvisioningTemplateVersionRequest createProvisioningTemplateVersionRequest) throws VersionsLimitExceededException, InternalFailureException, InvalidRequestException, ThrottlingException, ResourceNotFoundException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
Creates a new version of a provisioning template.
Requires permission to access the CreateProvisioningTemplateVersion action.
- Parameters:
createProvisioningTemplateVersionRequest
-- Returns:
- Result of the CreateProvisioningTemplateVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
createProvisioningTemplateVersion
default CreateProvisioningTemplateVersionResponse createProvisioningTemplateVersion(Consumer<CreateProvisioningTemplateVersionRequest.Builder> createProvisioningTemplateVersionRequest) throws VersionsLimitExceededException, InternalFailureException, InvalidRequestException, ThrottlingException, ResourceNotFoundException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateProvisioningTemplateVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
createRoleAlias
default CreateRoleAliasResponse createRoleAlias(CreateRoleAliasRequest createRoleAliasRequest) throws ResourceAlreadyExistsException, InvalidRequestException, LimitExceededException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates a role alias.
Requires permission to access the CreateRoleAlias action.
- Parameters:
createRoleAliasRequest
-- Returns:
- Result of the CreateRoleAlias operation returned by the service.
- Throws:
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.AwsServiceException
-
createRoleAlias
default CreateRoleAliasResponse createRoleAlias(Consumer<CreateRoleAliasRequest.Builder> createRoleAliasRequest) throws ResourceAlreadyExistsException, InvalidRequestException, LimitExceededException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates a role alias.
Requires permission to access the CreateRoleAlias action.
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:
- Result of the CreateRoleAlias operation returned by the service.
- Throws:
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.AwsServiceException
-
createScheduledAudit
default CreateScheduledAuditResponse createScheduledAudit(CreateScheduledAuditRequest createScheduledAuditRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
- Parameters:
createScheduledAuditRequest
-- Returns:
- Result of the CreateScheduledAudit operation returned by the service.
- Throws:
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.AwsServiceException
-
createScheduledAudit
default CreateScheduledAuditResponse createScheduledAudit(Consumer<CreateScheduledAuditRequest.Builder> createScheduledAuditRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateScheduledAudit operation returned by the service.
- Throws:
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.AwsServiceException
-
createSecurityProfile
default CreateSecurityProfileResponse createSecurityProfile(CreateSecurityProfileRequest createSecurityProfileRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates a Device Defender security profile.
Requires permission to access the CreateSecurityProfile action.
- Parameters:
createSecurityProfileRequest
-- Returns:
- Result of the CreateSecurityProfile operation returned by the service.
- Throws:
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.AwsServiceException
-
createSecurityProfile
default CreateSecurityProfileResponse createSecurityProfile(Consumer<CreateSecurityProfileRequest.Builder> createSecurityProfileRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateSecurityProfile operation returned by the service.
- Throws:
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.AwsServiceException
-
createStream
default CreateStreamResponse createStream(CreateStreamRequest createStreamRequest) throws InvalidRequestException, LimitExceededException, ResourceNotFoundException, ResourceAlreadyExistsException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateStream operation returned by the service.
- Throws:
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.AwsServiceException
-
createStream
default CreateStreamResponse createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest) throws InvalidRequestException, LimitExceededException, ResourceNotFoundException, ResourceAlreadyExistsException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateStream operation returned by the service.
- Throws:
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.AwsServiceException
-
createThing
default CreateThingResponse createThing(CreateThingRequest createThingRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceAlreadyExistsException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateThing operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
createThing
default CreateThingResponse createThing(Consumer<CreateThingRequest.Builder> createThingRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceAlreadyExistsException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateThing operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
createThingGroup
default CreateThingGroupResponse createThingGroup(CreateThingGroupRequest createThingGroupRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
createThingGroup
default CreateThingGroupResponse createThingGroup(Consumer<CreateThingGroupRequest.Builder> createThingGroupRequest) throws InvalidRequestException, ResourceAlreadyExistsException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
createThingType
default CreateThingTypeResponse createThingType(CreateThingTypeRequest createThingTypeRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, IotException
Creates a new thing type.
Requires permission to access the CreateThingType action.
- Parameters:
createThingTypeRequest
- The input for the CreateThingType operation.- Returns:
- Result of the CreateThingType operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
createThingType
default CreateThingTypeResponse createThingType(Consumer<CreateThingTypeRequest.Builder> createThingTypeRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, IotException
Creates a new thing type.
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:
- Result of the CreateThingType operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
createTopicRule
default CreateTopicRuleResponse createTopicRule(CreateTopicRuleRequest createTopicRuleRequest) throws SqlParseException, InternalException, InvalidRequestException, ResourceAlreadyExistsException, ServiceUnavailableException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
createTopicRule
default CreateTopicRuleResponse createTopicRule(Consumer<CreateTopicRuleRequest.Builder> createTopicRuleRequest) throws SqlParseException, InternalException, InvalidRequestException, ResourceAlreadyExistsException, ServiceUnavailableException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
createTopicRuleDestination
default CreateTopicRuleDestinationResponse createTopicRuleDestination(CreateTopicRuleDestinationRequest createTopicRuleDestinationRequest) throws InternalException, InvalidRequestException, ResourceAlreadyExistsException, ServiceUnavailableException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
Creates a topic rule destination. The destination must be confirmed prior to use.
Requires permission to access the CreateTopicRuleDestination action.
- Parameters:
createTopicRuleDestinationRequest
-- Returns:
- Result of the CreateTopicRuleDestination operation returned by the service.
- Throws:
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.AwsServiceException
-
createTopicRuleDestination
default CreateTopicRuleDestinationResponse createTopicRuleDestination(Consumer<CreateTopicRuleDestinationRequest.Builder> createTopicRuleDestinationRequest) throws InternalException, InvalidRequestException, ResourceAlreadyExistsException, ServiceUnavailableException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the CreateTopicRuleDestination operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteAccountAuditConfiguration
default DeleteAccountAuditConfigurationResponse deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest deleteAccountAuditConfigurationRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteAccountAuditConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteAccountAuditConfiguration
default DeleteAccountAuditConfigurationResponse deleteAccountAuditConfiguration(Consumer<DeleteAccountAuditConfigurationRequest.Builder> deleteAccountAuditConfigurationRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteAccountAuditConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteAccountAuditConfiguration
default DeleteAccountAuditConfigurationResponse deleteAccountAuditConfiguration() throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteAccountAuditConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
deleteAccountAuditConfiguration(DeleteAccountAuditConfigurationRequest)
-
deleteAuditSuppression
default DeleteAuditSuppressionResponse deleteAuditSuppression(DeleteAuditSuppressionRequest deleteAuditSuppressionRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes a Device Defender audit suppression.
Requires permission to access the DeleteAuditSuppression action.
- Parameters:
deleteAuditSuppressionRequest
-- Returns:
- Result of the DeleteAuditSuppression operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteAuditSuppression
default DeleteAuditSuppressionResponse deleteAuditSuppression(Consumer<DeleteAuditSuppressionRequest.Builder> deleteAuditSuppressionRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteAuditSuppression operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteAuthorizer
default DeleteAuthorizerResponse deleteAuthorizer(DeleteAuthorizerRequest deleteAuthorizerRequest) throws DeleteConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes an authorizer.
Requires permission to access the DeleteAuthorizer action.
- Parameters:
deleteAuthorizerRequest
-- Returns:
- Result of the DeleteAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteAuthorizer
default DeleteAuthorizerResponse deleteAuthorizer(Consumer<DeleteAuthorizerRequest.Builder> deleteAuthorizerRequest) throws DeleteConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteBillingGroup
default DeleteBillingGroupResponse deleteBillingGroup(DeleteBillingGroupRequest deleteBillingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes the billing group.
Requires permission to access the DeleteBillingGroup action.
- Parameters:
deleteBillingGroupRequest
-- Returns:
- Result of the DeleteBillingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
deleteBillingGroup
default DeleteBillingGroupResponse deleteBillingGroup(Consumer<DeleteBillingGroupRequest.Builder> deleteBillingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteBillingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
deleteCACertificate
default DeleteCaCertificateResponse deleteCACertificate(DeleteCaCertificateRequest deleteCaCertificateRequest) throws InvalidRequestException, CertificateStateException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Deletes a registered CA certificate.
Requires permission to access the DeleteCACertificate action.
- Parameters:
deleteCaCertificateRequest
- Input for the DeleteCACertificate operation.- Returns:
- Result of the DeleteCACertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteCACertificate
default DeleteCaCertificateResponse deleteCACertificate(Consumer<DeleteCaCertificateRequest.Builder> deleteCaCertificateRequest) throws InvalidRequestException, CertificateStateException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteCACertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteCertificate
default DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws CertificateStateException, DeleteConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteCertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteCertificate
default DeleteCertificateResponse deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) throws CertificateStateException, DeleteConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteCertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteCustomMetric
default DeleteCustomMetricResponse deleteCustomMetric(DeleteCustomMetricRequest deleteCustomMetricRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteCustomMetric operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteCustomMetric
default DeleteCustomMetricResponse deleteCustomMetric(Consumer<DeleteCustomMetricRequest.Builder> deleteCustomMetricRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteCustomMetric operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteDimension
default DeleteDimensionResponse deleteDimension(DeleteDimensionRequest deleteDimensionRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Removes the specified dimension from your Amazon Web Services accounts.
Requires permission to access the DeleteDimension action.
- Parameters:
deleteDimensionRequest
-- Returns:
- Result of the DeleteDimension operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteDimension
default DeleteDimensionResponse deleteDimension(Consumer<DeleteDimensionRequest.Builder> deleteDimensionRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteDimension operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteDomainConfiguration
default DeleteDomainConfigurationResponse deleteDomainConfiguration(DeleteDomainConfigurationRequest deleteDomainConfigurationRequest) throws ResourceNotFoundException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, IotException
Deletes the specified domain configuration.
Requires permission to access the DeleteDomainConfiguration action.
- Parameters:
deleteDomainConfigurationRequest
-- Returns:
- Result of the DeleteDomainConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteDomainConfiguration
default DeleteDomainConfigurationResponse deleteDomainConfiguration(Consumer<DeleteDomainConfigurationRequest.Builder> deleteDomainConfigurationRequest) throws ResourceNotFoundException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteDomainConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteDynamicThingGroup
default DeleteDynamicThingGroupResponse deleteDynamicThingGroup(DeleteDynamicThingGroupRequest deleteDynamicThingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes a dynamic thing group.
Requires permission to access the DeleteDynamicThingGroup action.
- Parameters:
deleteDynamicThingGroupRequest
-- Returns:
- Result of the DeleteDynamicThingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
deleteDynamicThingGroup
default DeleteDynamicThingGroupResponse deleteDynamicThingGroup(Consumer<DeleteDynamicThingGroupRequest.Builder> deleteDynamicThingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteDynamicThingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
deleteFleetMetric
default DeleteFleetMetricResponse deleteFleetMetric(DeleteFleetMetricRequest deleteFleetMetricRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, VersionConflictException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteFleetMetric operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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 theexpectedVersion
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.AwsServiceException
-
deleteFleetMetric
default DeleteFleetMetricResponse deleteFleetMetric(Consumer<DeleteFleetMetricRequest.Builder> deleteFleetMetricRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, VersionConflictException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteFleetMetric operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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 theexpectedVersion
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.AwsServiceException
-
deleteJob
default DeleteJobResponse deleteJob(DeleteJobRequest deleteJobRequest) throws InvalidRequestException, InvalidStateTransitionException, ResourceNotFoundException, LimitExceededException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteJob operation returned by the service.
- Throws:
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 theforce
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.AwsServiceException
-
deleteJob
default DeleteJobResponse deleteJob(Consumer<DeleteJobRequest.Builder> deleteJobRequest) throws InvalidRequestException, InvalidStateTransitionException, ResourceNotFoundException, LimitExceededException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteJob operation returned by the service.
- Throws:
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 theforce
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.AwsServiceException
-
deleteJobExecution
default DeleteJobExecutionResponse deleteJobExecution(DeleteJobExecutionRequest deleteJobExecutionRequest) throws InvalidRequestException, InvalidStateTransitionException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Deletes a job execution.
Requires permission to access the DeleteJobExecution action.
- Parameters:
deleteJobExecutionRequest
-- Returns:
- Result of the DeleteJobExecution operation returned by the service.
- Throws:
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 theforce
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.AwsServiceException
-
deleteJobExecution
default DeleteJobExecutionResponse deleteJobExecution(Consumer<DeleteJobExecutionRequest.Builder> deleteJobExecutionRequest) throws InvalidRequestException, InvalidStateTransitionException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteJobExecution operation returned by the service.
- Throws:
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 theforce
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.AwsServiceException
-
deleteJobTemplate
default DeleteJobTemplateResponse deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes the specified job template.
- Parameters:
deleteJobTemplateRequest
-- Returns:
- Result of the DeleteJobTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteJobTemplate
default DeleteJobTemplateResponse deleteJobTemplate(Consumer<DeleteJobTemplateRequest.Builder> deleteJobTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteJobTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteMitigationAction
default DeleteMitigationActionResponse deleteMitigationAction(DeleteMitigationActionRequest deleteMitigationActionRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes a defined mitigation action from your Amazon Web Services accounts.
Requires permission to access the DeleteMitigationAction action.
- Parameters:
deleteMitigationActionRequest
-- Returns:
- Result of the DeleteMitigationAction operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteMitigationAction
default DeleteMitigationActionResponse deleteMitigationAction(Consumer<DeleteMitigationActionRequest.Builder> deleteMitigationActionRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteMitigationAction operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteOTAUpdate
default DeleteOtaUpdateResponse deleteOTAUpdate(DeleteOtaUpdateRequest deleteOtaUpdateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, VersionConflictException, AwsServiceException, SdkClientException, IotException
Delete an OTA update.
Requires permission to access the DeleteOTAUpdate action.
- Parameters:
deleteOtaUpdateRequest
-- Returns:
- Result of the DeleteOTAUpdate operation returned by the service.
- Throws:
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 theexpectedVersion
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.AwsServiceException
-
deleteOTAUpdate
default DeleteOtaUpdateResponse deleteOTAUpdate(Consumer<DeleteOtaUpdateRequest.Builder> deleteOtaUpdateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, VersionConflictException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteOTAUpdate operation returned by the service.
- Throws:
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 theexpectedVersion
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.AwsServiceException
-
deletePackage
default DeletePackageResponse deletePackage(DeletePackageRequest deletePackageRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeletePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
deletePackage
default DeletePackageResponse deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeletePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
deletePackageVersion
default DeletePackageVersionResponse deletePackageVersion(DeletePackageVersionRequest deletePackageVersionRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeletePackageVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
deletePackageVersion
default DeletePackageVersionResponse deletePackageVersion(Consumer<DeletePackageVersionRequest.Builder> deletePackageVersionRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeletePackageVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
deletePolicy
default DeletePolicyResponse deletePolicy(DeletePolicyRequest deletePolicyRequest) throws DeleteConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeletePolicy operation returned by the service.
- Throws:
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.AwsServiceException
-
deletePolicy
default DeletePolicyResponse deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) throws DeleteConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeletePolicy operation returned by the service.
- Throws:
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.AwsServiceException
-
deletePolicyVersion
default DeletePolicyVersionResponse deletePolicyVersion(DeletePolicyVersionRequest deletePolicyVersionRequest) throws DeleteConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeletePolicyVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
deletePolicyVersion
default DeletePolicyVersionResponse deletePolicyVersion(Consumer<DeletePolicyVersionRequest.Builder> deletePolicyVersionRequest) throws DeleteConflictException, ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeletePolicyVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteProvisioningTemplate
default DeleteProvisioningTemplateResponse deleteProvisioningTemplate(DeleteProvisioningTemplateRequest deleteProvisioningTemplateRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, DeleteConflictException, ThrottlingException, ConflictingResourceUpdateException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Deletes a provisioning template.
Requires permission to access the DeleteProvisioningTemplate action.
- Parameters:
deleteProvisioningTemplateRequest
-- Returns:
- Result of the DeleteProvisioningTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteProvisioningTemplate
default DeleteProvisioningTemplateResponse deleteProvisioningTemplate(Consumer<DeleteProvisioningTemplateRequest.Builder> deleteProvisioningTemplateRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, DeleteConflictException, ThrottlingException, ConflictingResourceUpdateException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteProvisioningTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteProvisioningTemplateVersion
default DeleteProvisioningTemplateVersionResponse deleteProvisioningTemplateVersion(DeleteProvisioningTemplateVersionRequest deleteProvisioningTemplateVersionRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, ResourceNotFoundException, UnauthorizedException, ConflictingResourceUpdateException, DeleteConflictException, AwsServiceException, SdkClientException, IotException
Deletes a provisioning template version.
Requires permission to access the DeleteProvisioningTemplateVersion action.
- Parameters:
deleteProvisioningTemplateVersionRequest
-- Returns:
- Result of the DeleteProvisioningTemplateVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteProvisioningTemplateVersion
default DeleteProvisioningTemplateVersionResponse deleteProvisioningTemplateVersion(Consumer<DeleteProvisioningTemplateVersionRequest.Builder> deleteProvisioningTemplateVersionRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, ResourceNotFoundException, UnauthorizedException, ConflictingResourceUpdateException, DeleteConflictException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteProvisioningTemplateVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteRegistrationCode
default DeleteRegistrationCodeResponse deleteRegistrationCode(DeleteRegistrationCodeRequest deleteRegistrationCodeRequest) throws ThrottlingException, ResourceNotFoundException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
- Parameters:
deleteRegistrationCodeRequest
- The input for the DeleteRegistrationCode operation.- Returns:
- Result of the DeleteRegistrationCode operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteRegistrationCode
default DeleteRegistrationCodeResponse deleteRegistrationCode(Consumer<DeleteRegistrationCodeRequest.Builder> deleteRegistrationCodeRequest) throws ThrottlingException, ResourceNotFoundException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteRegistrationCode operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteRegistrationCode
default DeleteRegistrationCodeResponse deleteRegistrationCode() throws ThrottlingException, ResourceNotFoundException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes a CA certificate registration code.
Requires permission to access the DeleteRegistrationCode action.
- Returns:
- Result of the DeleteRegistrationCode operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
deleteRegistrationCode(DeleteRegistrationCodeRequest)
-
deleteRoleAlias
default DeleteRoleAliasResponse deleteRoleAlias(DeleteRoleAliasRequest deleteRoleAliasRequest) throws DeleteConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Deletes a role alias
Requires permission to access the DeleteRoleAlias action.
- Parameters:
deleteRoleAliasRequest
-- Returns:
- Result of the DeleteRoleAlias operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteRoleAlias
default DeleteRoleAliasResponse deleteRoleAlias(Consumer<DeleteRoleAliasRequest.Builder> deleteRoleAliasRequest) throws DeleteConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteRoleAlias operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteScheduledAudit
default DeleteScheduledAuditResponse deleteScheduledAudit(DeleteScheduledAuditRequest deleteScheduledAuditRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes a scheduled audit.
Requires permission to access the DeleteScheduledAudit action.
- Parameters:
deleteScheduledAuditRequest
-- Returns:
- Result of the DeleteScheduledAudit operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteScheduledAudit
default DeleteScheduledAuditResponse deleteScheduledAudit(Consumer<DeleteScheduledAuditRequest.Builder> deleteScheduledAuditRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteScheduledAudit operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteSecurityProfile
default DeleteSecurityProfileResponse deleteSecurityProfile(DeleteSecurityProfileRequest deleteSecurityProfileRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, VersionConflictException, AwsServiceException, SdkClientException, IotException
Deletes a Device Defender security profile.
Requires permission to access the DeleteSecurityProfile action.
- Parameters:
deleteSecurityProfileRequest
-- Returns:
- Result of the DeleteSecurityProfile operation returned by the service.
- Throws:
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 theexpectedVersion
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.AwsServiceException
-
deleteSecurityProfile
default DeleteSecurityProfileResponse deleteSecurityProfile(Consumer<DeleteSecurityProfileRequest.Builder> deleteSecurityProfileRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, VersionConflictException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteSecurityProfile operation returned by the service.
- Throws:
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 theexpectedVersion
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.AwsServiceException
-
deleteStream
default DeleteStreamResponse deleteStream(DeleteStreamRequest deleteStreamRequest) throws ResourceNotFoundException, DeleteConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes a stream.
Requires permission to access the DeleteStream action.
- Parameters:
deleteStreamRequest
-- Returns:
- Result of the DeleteStream operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteStream
default DeleteStreamResponse deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest) throws ResourceNotFoundException, DeleteConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteStream operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteThing
default DeleteThingResponse deleteThing(DeleteThingRequest deleteThingRequest) throws ResourceNotFoundException, VersionConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteThing operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
deleteThing
default DeleteThingResponse deleteThing(Consumer<DeleteThingRequest.Builder> deleteThingRequest) throws ResourceNotFoundException, VersionConflictException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteThing operation returned by the service.
- Throws:
ResourceNotFoundException
- The specified resource does not exist.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
deleteThingGroup
default DeleteThingGroupResponse deleteThingGroup(DeleteThingGroupRequest deleteThingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Deletes a thing group.
Requires permission to access the DeleteThingGroup action.
- Parameters:
deleteThingGroupRequest
-- Returns:
- Result of the DeleteThingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
deleteThingGroup
default DeleteThingGroupResponse deleteThingGroup(Consumer<DeleteThingGroupRequest.Builder> deleteThingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteThingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
deleteThingType
default DeleteThingTypeResponse deleteThingType(DeleteThingTypeRequest deleteThingTypeRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteThingType operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteThingType
default DeleteThingTypeResponse deleteThingType(Consumer<DeleteThingTypeRequest.Builder> deleteThingTypeRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteThingType operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteTopicRule
default DeleteTopicRuleResponse deleteTopicRule(DeleteTopicRuleRequest deleteTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
Deletes the rule.
Requires permission to access the DeleteTopicRule action.
- Parameters:
deleteTopicRuleRequest
- The input for the DeleteTopicRule operation.- Returns:
- Result of the DeleteTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteTopicRule
default DeleteTopicRuleResponse deleteTopicRule(Consumer<DeleteTopicRuleRequest.Builder> deleteTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteTopicRuleDestination
default DeleteTopicRuleDestinationResponse deleteTopicRuleDestination(DeleteTopicRuleDestinationRequest deleteTopicRuleDestinationRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
Deletes a topic rule destination.
Requires permission to access the DeleteTopicRuleDestination action.
- Parameters:
deleteTopicRuleDestinationRequest
-- Returns:
- Result of the DeleteTopicRuleDestination operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteTopicRuleDestination
default DeleteTopicRuleDestinationResponse deleteTopicRuleDestination(Consumer<DeleteTopicRuleDestinationRequest.Builder> deleteTopicRuleDestinationRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteTopicRuleDestination operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteV2LoggingLevel
default DeleteV2LoggingLevelResponse deleteV2LoggingLevel(DeleteV2LoggingLevelRequest deleteV2LoggingLevelRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Deletes a logging level.
Requires permission to access the DeleteV2LoggingLevel action.
- Parameters:
deleteV2LoggingLevelRequest
-- Returns:
- Result of the DeleteV2LoggingLevel operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteV2LoggingLevel
default DeleteV2LoggingLevelResponse deleteV2LoggingLevel(Consumer<DeleteV2LoggingLevelRequest.Builder> deleteV2LoggingLevelRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeleteV2LoggingLevel operation returned by the service.
- Throws:
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.AwsServiceException
-
deprecateThingType
default DeprecateThingTypeResponse deprecateThingType(DeprecateThingTypeRequest deprecateThingTypeRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeprecateThingType operation returned by the service.
- Throws:
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.AwsServiceException
-
deprecateThingType
default DeprecateThingTypeResponse deprecateThingType(Consumer<DeprecateThingTypeRequest.Builder> deprecateThingTypeRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DeprecateThingType operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAccountAuditConfiguration
default DescribeAccountAuditConfigurationResponse describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest describeAccountAuditConfigurationRequest) throws ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeAccountAuditConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAccountAuditConfiguration
default DescribeAccountAuditConfigurationResponse describeAccountAuditConfiguration(Consumer<DescribeAccountAuditConfigurationRequest.Builder> describeAccountAuditConfigurationRequest) throws ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeAccountAuditConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAccountAuditConfiguration
default DescribeAccountAuditConfigurationResponse describeAccountAuditConfiguration() throws ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeAccountAuditConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
describeAccountAuditConfiguration(DescribeAccountAuditConfigurationRequest)
-
describeAuditFinding
default DescribeAuditFindingResponse describeAuditFinding(DescribeAuditFindingRequest describeAuditFindingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeAuditFinding operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAuditFinding
default DescribeAuditFindingResponse describeAuditFinding(Consumer<DescribeAuditFindingRequest.Builder> describeAuditFindingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeAuditFinding operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAuditMitigationActionsTask
default DescribeAuditMitigationActionsTaskResponse describeAuditMitigationActionsTask(DescribeAuditMitigationActionsTaskRequest describeAuditMitigationActionsTaskRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeAuditMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAuditMitigationActionsTask
default DescribeAuditMitigationActionsTaskResponse describeAuditMitigationActionsTask(Consumer<DescribeAuditMitigationActionsTaskRequest.Builder> describeAuditMitigationActionsTaskRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeAuditMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAuditSuppression
default DescribeAuditSuppressionResponse describeAuditSuppression(DescribeAuditSuppressionRequest describeAuditSuppressionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about a Device Defender audit suppression.
- Parameters:
describeAuditSuppressionRequest
-- Returns:
- Result of the DescribeAuditSuppression operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAuditSuppression
default DescribeAuditSuppressionResponse describeAuditSuppression(Consumer<DescribeAuditSuppressionRequest.Builder> describeAuditSuppressionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeAuditSuppression operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAuditTask
default DescribeAuditTaskResponse describeAuditTask(DescribeAuditTaskRequest describeAuditTaskRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about a Device Defender audit.
Requires permission to access the DescribeAuditTask action.
- Parameters:
describeAuditTaskRequest
-- Returns:
- Result of the DescribeAuditTask operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAuditTask
default DescribeAuditTaskResponse describeAuditTask(Consumer<DescribeAuditTaskRequest.Builder> describeAuditTaskRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeAuditTask operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAuthorizer
default DescribeAuthorizerResponse describeAuthorizer(DescribeAuthorizerRequest describeAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Describes an authorizer.
Requires permission to access the DescribeAuthorizer action.
- Parameters:
describeAuthorizerRequest
-- Returns:
- Result of the DescribeAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
describeAuthorizer
default DescribeAuthorizerResponse describeAuthorizer(Consumer<DescribeAuthorizerRequest.Builder> describeAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
describeBillingGroup
default DescribeBillingGroupResponse describeBillingGroup(DescribeBillingGroupRequest describeBillingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Returns information about a billing group.
Requires permission to access the DescribeBillingGroup action.
- Parameters:
describeBillingGroupRequest
-- Returns:
- Result of the DescribeBillingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
describeBillingGroup
default DescribeBillingGroupResponse describeBillingGroup(Consumer<DescribeBillingGroupRequest.Builder> describeBillingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeBillingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
describeCACertificate
default DescribeCaCertificateResponse describeCACertificate(DescribeCaCertificateRequest describeCaCertificateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Describes a registered CA certificate.
Requires permission to access the DescribeCACertificate action.
- Parameters:
describeCaCertificateRequest
- The input for the DescribeCACertificate operation.- Returns:
- Result of the DescribeCACertificate operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
describeCACertificate
default DescribeCaCertificateResponse describeCACertificate(Consumer<DescribeCaCertificateRequest.Builder> describeCaCertificateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeCACertificate operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
describeCertificate
default DescribeCertificateResponse describeCertificate(DescribeCertificateRequest describeCertificateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Gets information about the specified certificate.
Requires permission to access the DescribeCertificate action.
- Parameters:
describeCertificateRequest
- The input for the DescribeCertificate operation.- Returns:
- Result of the DescribeCertificate operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
describeCertificate
default DescribeCertificateResponse describeCertificate(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeCertificate operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
describeCustomMetric
default DescribeCustomMetricResponse describeCustomMetric(DescribeCustomMetricRequest describeCustomMetricRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about a Device Defender detect custom metric.
Requires permission to access the DescribeCustomMetric action.
- Parameters:
describeCustomMetricRequest
-- Returns:
- Result of the DescribeCustomMetric operation returned by the service.
- Throws:
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.AwsServiceException
-
describeCustomMetric
default DescribeCustomMetricResponse describeCustomMetric(Consumer<DescribeCustomMetricRequest.Builder> describeCustomMetricRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeCustomMetric operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDefaultAuthorizer
default DescribeDefaultAuthorizerResponse describeDefaultAuthorizer(DescribeDefaultAuthorizerRequest describeDefaultAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Describes the default authorizer.
Requires permission to access the DescribeDefaultAuthorizer action.
- Parameters:
describeDefaultAuthorizerRequest
-- Returns:
- Result of the DescribeDefaultAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDefaultAuthorizer
default DescribeDefaultAuthorizerResponse describeDefaultAuthorizer(Consumer<DescribeDefaultAuthorizerRequest.Builder> describeDefaultAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeDefaultAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDetectMitigationActionsTask
default DescribeDetectMitigationActionsTaskResponse describeDetectMitigationActionsTask(DescribeDetectMitigationActionsTaskRequest describeDetectMitigationActionsTaskRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about a Device Defender ML Detect mitigation action.
Requires permission to access the DescribeDetectMitigationActionsTask action.
- Parameters:
describeDetectMitigationActionsTaskRequest
-- Returns:
- Result of the DescribeDetectMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDetectMitigationActionsTask
default DescribeDetectMitigationActionsTaskResponse describeDetectMitigationActionsTask(Consumer<DescribeDetectMitigationActionsTaskRequest.Builder> describeDetectMitigationActionsTaskRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeDetectMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDimension
default DescribeDimensionResponse describeDimension(DescribeDimensionRequest describeDimensionRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Provides details about a dimension that is defined in your Amazon Web Services accounts.
Requires permission to access the DescribeDimension action.
- Parameters:
describeDimensionRequest
-- Returns:
- Result of the DescribeDimension operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDimension
default DescribeDimensionResponse describeDimension(Consumer<DescribeDimensionRequest.Builder> describeDimensionRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeDimension operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDomainConfiguration
default DescribeDomainConfigurationResponse describeDomainConfiguration(DescribeDomainConfigurationRequest describeDomainConfigurationRequest) throws ResourceNotFoundException, ThrottlingException, InvalidRequestException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
- Parameters:
describeDomainConfigurationRequest
-- Returns:
- Result of the DescribeDomainConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDomainConfiguration
default DescribeDomainConfigurationResponse describeDomainConfiguration(Consumer<DescribeDomainConfigurationRequest.Builder> describeDomainConfigurationRequest) throws ResourceNotFoundException, ThrottlingException, InvalidRequestException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeDomainConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
describeEndpoint
default DescribeEndpointResponse describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws InternalFailureException, InvalidRequestException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Returns a unique endpoint specific to the Amazon Web Services account making the call.
Requires permission to access the DescribeEndpoint action.
- Parameters:
describeEndpointRequest
- The input for the DescribeEndpoint operation.- Returns:
- Result of the DescribeEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
-
describeEndpoint
default DescribeEndpointResponse describeEndpoint(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest) throws InternalFailureException, InvalidRequestException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Returns a unique endpoint specific to the Amazon Web Services account making the call.
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:
- Result of the DescribeEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
-
describeEndpoint
default DescribeEndpointResponse describeEndpoint() throws InternalFailureException, InvalidRequestException, UnauthorizedException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Returns a unique endpoint specific to the Amazon Web Services account making the call.
Requires permission to access the DescribeEndpoint action.
- Returns:
- Result of the DescribeEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
describeEndpoint(DescribeEndpointRequest)
-
describeEventConfigurations
default DescribeEventConfigurationsResponse describeEventConfigurations(DescribeEventConfigurationsRequest describeEventConfigurationsRequest) throws InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Describes event configurations.
Requires permission to access the DescribeEventConfigurations action.
- Parameters:
describeEventConfigurationsRequest
-- Returns:
- Result of the DescribeEventConfigurations operation returned by the service.
- Throws:
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.AwsServiceException
-
describeEventConfigurations
default DescribeEventConfigurationsResponse describeEventConfigurations(Consumer<DescribeEventConfigurationsRequest.Builder> describeEventConfigurationsRequest) throws InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeEventConfigurations operation returned by the service.
- Throws:
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.AwsServiceException
-
describeEventConfigurations
default DescribeEventConfigurationsResponse describeEventConfigurations() throws InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Describes event configurations.
Requires permission to access the DescribeEventConfigurations action.
- Returns:
- Result of the DescribeEventConfigurations operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
describeEventConfigurations(DescribeEventConfigurationsRequest)
-
describeFleetMetric
default DescribeFleetMetricResponse describeFleetMetric(DescribeFleetMetricRequest describeFleetMetricRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Gets information about the specified fleet metric.
Requires permission to access the DescribeFleetMetric action.
- Parameters:
describeFleetMetricRequest
-- Returns:
- Result of the DescribeFleetMetric operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
describeFleetMetric
default DescribeFleetMetricResponse describeFleetMetric(Consumer<DescribeFleetMetricRequest.Builder> describeFleetMetricRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeFleetMetric operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
describeIndex
default DescribeIndexResponse describeIndex(DescribeIndexRequest describeIndexRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Describes a search index.
Requires permission to access the DescribeIndex action.
- Parameters:
describeIndexRequest
-- Returns:
- Result of the DescribeIndex operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
describeIndex
default DescribeIndexResponse describeIndex(Consumer<DescribeIndexRequest.Builder> describeIndexRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeIndex operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
describeJob
default DescribeJobResponse describeJob(DescribeJobRequest describeJobRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Describes a job.
Requires permission to access the DescribeJob action.
- Parameters:
describeJobRequest
-- Returns:
- Result of the DescribeJob operation returned by the service.
- Throws:
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.AwsServiceException
-
describeJob
default DescribeJobResponse describeJob(Consumer<DescribeJobRequest.Builder> describeJobRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeJob operation returned by the service.
- Throws:
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.AwsServiceException
-
describeJobExecution
default DescribeJobExecutionResponse describeJobExecution(DescribeJobExecutionRequest describeJobExecutionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Describes a job execution.
Requires permission to access the DescribeJobExecution action.
- Parameters:
describeJobExecutionRequest
-- Returns:
- Result of the DescribeJobExecution operation returned by the service.
- Throws:
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.AwsServiceException
-
describeJobExecution
default DescribeJobExecutionResponse describeJobExecution(Consumer<DescribeJobExecutionRequest.Builder> describeJobExecutionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeJobExecution operation returned by the service.
- Throws:
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.AwsServiceException
-
describeJobTemplate
default DescribeJobTemplateResponse describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Returns information about a job template.
- Parameters:
describeJobTemplateRequest
-- Returns:
- Result of the DescribeJobTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
describeJobTemplate
default DescribeJobTemplateResponse describeJobTemplate(Consumer<DescribeJobTemplateRequest.Builder> describeJobTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeJobTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
describeManagedJobTemplate
default DescribeManagedJobTemplateResponse describeManagedJobTemplate(DescribeManagedJobTemplateRequest describeManagedJobTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotException
View details of a managed job template.
- Parameters:
describeManagedJobTemplateRequest
-- Returns:
- Result of the DescribeManagedJobTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
describeManagedJobTemplate
default DescribeManagedJobTemplateResponse describeManagedJobTemplate(Consumer<DescribeManagedJobTemplateRequest.Builder> describeManagedJobTemplateRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeManagedJobTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
describeMitigationAction
default DescribeMitigationActionResponse describeMitigationAction(DescribeMitigationActionRequest describeMitigationActionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about a mitigation action.
Requires permission to access the DescribeMitigationAction action.
- Parameters:
describeMitigationActionRequest
-- Returns:
- Result of the DescribeMitigationAction operation returned by the service.
- Throws:
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.AwsServiceException
-
describeMitigationAction
default DescribeMitigationActionResponse describeMitigationAction(Consumer<DescribeMitigationActionRequest.Builder> describeMitigationActionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeMitigationAction operation returned by the service.
- Throws:
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.AwsServiceException
-
describeProvisioningTemplate
default DescribeProvisioningTemplateResponse describeProvisioningTemplate(DescribeProvisioningTemplateRequest describeProvisioningTemplateRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Returns information about a provisioning template.
Requires permission to access the DescribeProvisioningTemplate action.
- Parameters:
describeProvisioningTemplateRequest
-- Returns:
- Result of the DescribeProvisioningTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
describeProvisioningTemplate
default DescribeProvisioningTemplateResponse describeProvisioningTemplate(Consumer<DescribeProvisioningTemplateRequest.Builder> describeProvisioningTemplateRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeProvisioningTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
describeProvisioningTemplateVersion
default DescribeProvisioningTemplateVersionResponse describeProvisioningTemplateVersion(DescribeProvisioningTemplateVersionRequest describeProvisioningTemplateVersionRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, ResourceNotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Returns information about a provisioning template version.
Requires permission to access the DescribeProvisioningTemplateVersion action.
- Parameters:
describeProvisioningTemplateVersionRequest
-- Returns:
- Result of the DescribeProvisioningTemplateVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
describeProvisioningTemplateVersion
default DescribeProvisioningTemplateVersionResponse describeProvisioningTemplateVersion(Consumer<DescribeProvisioningTemplateVersionRequest.Builder> describeProvisioningTemplateVersionRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, ResourceNotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeProvisioningTemplateVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
describeRoleAlias
default DescribeRoleAliasResponse describeRoleAlias(DescribeRoleAliasRequest describeRoleAliasRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Describes a role alias.
Requires permission to access the DescribeRoleAlias action.
- Parameters:
describeRoleAliasRequest
-- Returns:
- Result of the DescribeRoleAlias operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
describeRoleAlias
default DescribeRoleAliasResponse describeRoleAlias(Consumer<DescribeRoleAliasRequest.Builder> describeRoleAliasRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeRoleAlias operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
describeScheduledAudit
default DescribeScheduledAuditResponse describeScheduledAudit(DescribeScheduledAuditRequest describeScheduledAuditRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about a scheduled audit.
Requires permission to access the DescribeScheduledAudit action.
- Parameters:
describeScheduledAuditRequest
-- Returns:
- Result of the DescribeScheduledAudit operation returned by the service.
- Throws:
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.AwsServiceException
-
describeScheduledAudit
default DescribeScheduledAuditResponse describeScheduledAudit(Consumer<DescribeScheduledAuditRequest.Builder> describeScheduledAuditRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeScheduledAudit operation returned by the service.
- Throws:
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.AwsServiceException
-
describeSecurityProfile
default DescribeSecurityProfileResponse describeSecurityProfile(DescribeSecurityProfileRequest describeSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
- Parameters:
describeSecurityProfileRequest
-- Returns:
- Result of the DescribeSecurityProfile operation returned by the service.
- Throws:
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.AwsServiceException
-
describeSecurityProfile
default DescribeSecurityProfileResponse describeSecurityProfile(Consumer<DescribeSecurityProfileRequest.Builder> describeSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeSecurityProfile operation returned by the service.
- Throws:
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.AwsServiceException
-
describeStream
default DescribeStreamResponse describeStream(DescribeStreamRequest describeStreamRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about a stream.
Requires permission to access the DescribeStream action.
- Parameters:
describeStreamRequest
-- Returns:
- Result of the DescribeStream operation returned by the service.
- Throws:
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.AwsServiceException
-
describeStream
default DescribeStreamResponse describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeStream operation returned by the service.
- Throws:
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.AwsServiceException
-
describeThing
default DescribeThingResponse describeThing(DescribeThingRequest describeThingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about the specified thing.
Requires permission to access the DescribeThing action.
- Parameters:
describeThingRequest
- The input for the DescribeThing operation.- Returns:
- Result of the DescribeThing operation returned by the service.
- Throws:
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.AwsServiceException
-
describeThing
default DescribeThingResponse describeThing(Consumer<DescribeThingRequest.Builder> describeThingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeThing operation returned by the service.
- Throws:
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.AwsServiceException
-
describeThingGroup
default DescribeThingGroupResponse describeThingGroup(DescribeThingGroupRequest describeThingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Describe a thing group.
Requires permission to access the DescribeThingGroup action.
- Parameters:
describeThingGroupRequest
-- Returns:
- Result of the DescribeThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
describeThingGroup
default DescribeThingGroupResponse describeThingGroup(Consumer<DescribeThingGroupRequest.Builder> describeThingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
describeThingRegistrationTask
default DescribeThingRegistrationTaskResponse describeThingRegistrationTask(DescribeThingRegistrationTaskRequest describeThingRegistrationTaskRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Describes a bulk thing provisioning task.
Requires permission to access the DescribeThingRegistrationTask action.
- Parameters:
describeThingRegistrationTaskRequest
-- Returns:
- Result of the DescribeThingRegistrationTask operation returned by the service.
- Throws:
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.AwsServiceException
-
describeThingRegistrationTask
default DescribeThingRegistrationTaskResponse describeThingRegistrationTask(Consumer<DescribeThingRegistrationTaskRequest.Builder> describeThingRegistrationTaskRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeThingRegistrationTask operation returned by the service.
- Throws:
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.AwsServiceException
-
describeThingType
default DescribeThingTypeResponse describeThingType(DescribeThingTypeRequest describeThingTypeRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about the specified thing type.
Requires permission to access the DescribeThingType action.
- Parameters:
describeThingTypeRequest
- The input for the DescribeThingType operation.- Returns:
- Result of the DescribeThingType operation returned by the service.
- Throws:
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.AwsServiceException
-
describeThingType
default DescribeThingTypeResponse describeThingType(Consumer<DescribeThingTypeRequest.Builder> describeThingTypeRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DescribeThingType operation returned by the service.
- Throws:
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.AwsServiceException
-
detachPolicy
default DetachPolicyResponse detachPolicy(DetachPolicyRequest detachPolicyRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DetachPolicy operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
detachPolicy
default DetachPolicyResponse detachPolicy(Consumer<DetachPolicyRequest.Builder> detachPolicyRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DetachPolicy operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
detachSecurityProfile
default DetachSecurityProfileResponse detachSecurityProfile(DetachSecurityProfileRequest detachSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Disassociates a Device Defender security profile from a thing group or from this account.
Requires permission to access the DetachSecurityProfile action.
- Parameters:
detachSecurityProfileRequest
-- Returns:
- Result of the DetachSecurityProfile operation returned by the service.
- Throws:
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.AwsServiceException
-
detachSecurityProfile
default DetachSecurityProfileResponse detachSecurityProfile(Consumer<DetachSecurityProfileRequest.Builder> detachSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DetachSecurityProfile operation returned by the service.
- Throws:
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.AwsServiceException
-
detachThingPrincipal
default DetachThingPrincipalResponse detachThingPrincipal(DetachThingPrincipalRequest detachThingPrincipalRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DetachThingPrincipal operation returned by the service.
- Throws:
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.AwsServiceException
-
detachThingPrincipal
default DetachThingPrincipalResponse detachThingPrincipal(Consumer<DetachThingPrincipalRequest.Builder> detachThingPrincipalRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DetachThingPrincipal operation returned by the service.
- Throws:
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.AwsServiceException
-
disableTopicRule
default DisableTopicRuleResponse disableTopicRule(DisableTopicRuleRequest disableTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
Disables the rule.
Requires permission to access the DisableTopicRule action.
- Parameters:
disableTopicRuleRequest
- The input for the DisableTopicRuleRequest operation.- Returns:
- Result of the DisableTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
disableTopicRule
default DisableTopicRuleResponse disableTopicRule(Consumer<DisableTopicRuleRequest.Builder> disableTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the DisableTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
enableTopicRule
default EnableTopicRuleResponse enableTopicRule(EnableTopicRuleRequest enableTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
Enables the rule.
Requires permission to access the EnableTopicRule action.
- Parameters:
enableTopicRuleRequest
- The input for the EnableTopicRuleRequest operation.- Returns:
- Result of the EnableTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
enableTopicRule
default EnableTopicRuleResponse enableTopicRule(Consumer<EnableTopicRuleRequest.Builder> enableTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the EnableTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
getBehaviorModelTrainingSummaries
default GetBehaviorModelTrainingSummariesResponse getBehaviorModelTrainingSummaries(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Returns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
- Parameters:
getBehaviorModelTrainingSummariesRequest
-- Returns:
- Result of the GetBehaviorModelTrainingSummaries operation returned by the service.
- Throws:
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.AwsServiceException
-
getBehaviorModelTrainingSummaries
default GetBehaviorModelTrainingSummariesResponse getBehaviorModelTrainingSummaries(Consumer<GetBehaviorModelTrainingSummariesRequest.Builder> getBehaviorModelTrainingSummariesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetBehaviorModelTrainingSummaries operation returned by the service.
- Throws:
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.AwsServiceException
-
getBehaviorModelTrainingSummariesPaginator
default GetBehaviorModelTrainingSummariesIterable getBehaviorModelTrainingSummariesPaginator(GetBehaviorModelTrainingSummariesRequest getBehaviorModelTrainingSummariesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Returns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
This is a variant of
getBehaviorModelTrainingSummaries(software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.GetBehaviorModelTrainingSummariesIterable responses = client.getBehaviorModelTrainingSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.GetBehaviorModelTrainingSummariesIterable responses = client .getBehaviorModelTrainingSummariesPaginator(request); for (software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.GetBehaviorModelTrainingSummariesIterable responses = client.getBehaviorModelTrainingSummariesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
getBehaviorModelTrainingSummariesPaginator
default GetBehaviorModelTrainingSummariesIterable getBehaviorModelTrainingSummariesPaginator(Consumer<GetBehaviorModelTrainingSummariesRequest.Builder> getBehaviorModelTrainingSummariesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Returns a Device Defender's ML Detect Security Profile training model's status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
This is a variant of
getBehaviorModelTrainingSummaries(software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.GetBehaviorModelTrainingSummariesIterable responses = client.getBehaviorModelTrainingSummariesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.GetBehaviorModelTrainingSummariesIterable responses = client .getBehaviorModelTrainingSummariesPaginator(request); for (software.amazon.awssdk.services.iot.model.GetBehaviorModelTrainingSummariesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.GetBehaviorModelTrainingSummariesIterable responses = client.getBehaviorModelTrainingSummariesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
getBucketsAggregation
default GetBucketsAggregationResponse getBucketsAggregation(GetBucketsAggregationRequest getBucketsAggregationRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
Aggregates on indexed data with search queries pertaining to particular fields.
Requires permission to access the GetBucketsAggregation action.
- Parameters:
getBucketsAggregationRequest
-- Returns:
- Result of the GetBucketsAggregation operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
getBucketsAggregation
default GetBucketsAggregationResponse getBucketsAggregation(Consumer<GetBucketsAggregationRequest.Builder> getBucketsAggregationRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetBucketsAggregation operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
getCardinality
default GetCardinalityResponse getCardinality(GetCardinalityRequest getCardinalityRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
Returns the approximate count of unique values that match the query.
Requires permission to access the GetCardinality action.
- Parameters:
getCardinalityRequest
-- Returns:
- Result of the GetCardinality operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
getCardinality
default GetCardinalityResponse getCardinality(Consumer<GetCardinalityRequest.Builder> getCardinalityRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetCardinality operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
getEffectivePolicies
default GetEffectivePoliciesResponse getEffectivePolicies(GetEffectivePoliciesRequest getEffectivePoliciesRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetEffectivePolicies operation returned by the service.
- Throws:
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.AwsServiceException
-
getEffectivePolicies
default GetEffectivePoliciesResponse getEffectivePolicies(Consumer<GetEffectivePoliciesRequest.Builder> getEffectivePoliciesRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetEffectivePolicies operation returned by the service.
- Throws:
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.AwsServiceException
-
getIndexingConfiguration
default GetIndexingConfigurationResponse getIndexingConfiguration(GetIndexingConfigurationRequest getIndexingConfigurationRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
- Parameters:
getIndexingConfigurationRequest
-- Returns:
- Result of the GetIndexingConfiguration operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
getIndexingConfiguration
default GetIndexingConfigurationResponse getIndexingConfiguration(Consumer<GetIndexingConfigurationRequest.Builder> getIndexingConfigurationRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetIndexingConfiguration operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
getIndexingConfiguration
default GetIndexingConfigurationResponse getIndexingConfiguration() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets the indexing configuration.
Requires permission to access the GetIndexingConfiguration action.
- Returns:
- Result of the GetIndexingConfiguration operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
getIndexingConfiguration(GetIndexingConfigurationRequest)
-
getJobDocument
default GetJobDocumentResponse getJobDocument(GetJobDocumentRequest getJobDocumentRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Gets a job document.
Requires permission to access the GetJobDocument action.
- Parameters:
getJobDocumentRequest
-- Returns:
- Result of the GetJobDocument operation returned by the service.
- Throws:
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.AwsServiceException
-
getJobDocument
default GetJobDocumentResponse getJobDocument(Consumer<GetJobDocumentRequest.Builder> getJobDocumentRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetJobDocument operation returned by the service.
- Throws:
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.AwsServiceException
-
getLoggingOptions
default GetLoggingOptionsResponse getLoggingOptions(GetLoggingOptionsRequest getLoggingOptionsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetLoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException
-
getLoggingOptions
default GetLoggingOptionsResponse getLoggingOptions(Consumer<GetLoggingOptionsRequest.Builder> getLoggingOptionsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetLoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException
-
getLoggingOptions
default GetLoggingOptionsResponse getLoggingOptions() throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Gets the logging options.
NOTE: use of this command is not recommended. Use
GetV2LoggingOptions
instead.Requires permission to access the GetLoggingOptions action.
- Returns:
- Result of the GetLoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
getLoggingOptions(GetLoggingOptionsRequest)
-
getOTAUpdate
default GetOtaUpdateResponse getOTAUpdate(GetOtaUpdateRequest getOtaUpdateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Gets an OTA update.
Requires permission to access the GetOTAUpdate action.
- Parameters:
getOtaUpdateRequest
-- Returns:
- Result of the GetOTAUpdate operation returned by the service.
- Throws:
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.AwsServiceException
-
getOTAUpdate
default GetOtaUpdateResponse getOTAUpdate(Consumer<GetOtaUpdateRequest.Builder> getOtaUpdateRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetOTAUpdate operation returned by the service.
- Throws:
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.AwsServiceException
-
getPackage
default GetPackageResponse getPackage(GetPackageRequest getPackageRequest) throws ThrottlingException, InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Gets information about the specified software package.
Requires permission to access the GetPackage action.
- Parameters:
getPackageRequest
-- Returns:
- Result of the GetPackage operation returned by the service.
- Throws:
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.AwsServiceException
-
getPackage
default GetPackageResponse getPackage(Consumer<GetPackageRequest.Builder> getPackageRequest) throws ThrottlingException, InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetPackage operation returned by the service.
- Throws:
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.AwsServiceException
-
getPackageConfiguration
default GetPackageConfigurationResponse getPackageConfiguration(GetPackageConfigurationRequest getPackageConfigurationRequest) throws ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotException
Gets information about the specified software package's configuration.
Requires permission to access the GetPackageConfiguration action.
- Parameters:
getPackageConfigurationRequest
-- Returns:
- Result of the GetPackageConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
getPackageConfiguration
default GetPackageConfigurationResponse getPackageConfiguration(Consumer<GetPackageConfigurationRequest.Builder> getPackageConfigurationRequest) throws ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetPackageConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
getPackageVersion
default GetPackageVersionResponse getPackageVersion(GetPackageVersionRequest getPackageVersionRequest) throws ThrottlingException, InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Gets information about the specified package version.
Requires permission to access the GetPackageVersion action.
- Parameters:
getPackageVersionRequest
-- Returns:
- Result of the GetPackageVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
getPackageVersion
default GetPackageVersionResponse getPackageVersion(Consumer<GetPackageVersionRequest.Builder> getPackageVersionRequest) throws ThrottlingException, InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetPackageVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
getPercentiles
default GetPercentilesResponse getPercentiles(GetPercentilesRequest getPercentilesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetPercentiles operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
getPercentiles
default GetPercentilesResponse getPercentiles(Consumer<GetPercentilesRequest.Builder> getPercentilesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetPercentiles operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
getPolicy
default GetPolicyResponse getPolicy(GetPolicyRequest getPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetPolicy operation returned by the service.
- Throws:
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.AwsServiceException
-
getPolicy
default GetPolicyResponse getPolicy(Consumer<GetPolicyRequest.Builder> getPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetPolicy operation returned by the service.
- Throws:
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.AwsServiceException
-
getPolicyVersion
default GetPolicyVersionResponse getPolicyVersion(GetPolicyVersionRequest getPolicyVersionRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets information about the specified policy version.
Requires permission to access the GetPolicyVersion action.
- Parameters:
getPolicyVersionRequest
- The input for the GetPolicyVersion operation.- Returns:
- Result of the GetPolicyVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
getPolicyVersion
default GetPolicyVersionResponse getPolicyVersion(Consumer<GetPolicyVersionRequest.Builder> getPolicyVersionRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetPolicyVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
getRegistrationCode
default GetRegistrationCodeResponse getRegistrationCode(GetRegistrationCodeRequest getRegistrationCodeRequest) throws ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, IotException
Gets a registration code used to register a CA certificate with IoT.
Requires permission to access the GetRegistrationCode action.
- Parameters:
getRegistrationCodeRequest
- The input to the GetRegistrationCode operation.- Returns:
- Result of the GetRegistrationCode operation returned by the service.
- Throws:
ThrottlingException
- The rate 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.AwsServiceException
-
getRegistrationCode
default GetRegistrationCodeResponse getRegistrationCode(Consumer<GetRegistrationCodeRequest.Builder> getRegistrationCodeRequest) throws ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, IotException
Gets a registration code used to register a CA certificate with IoT.
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:
- Result of the GetRegistrationCode operation returned by the service.
- Throws:
ThrottlingException
- The rate 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.AwsServiceException
-
getRegistrationCode
default GetRegistrationCodeResponse getRegistrationCode() throws ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, InvalidRequestException, AwsServiceException, SdkClientException, IotException
Gets a registration code used to register a CA certificate with IoT.
Requires permission to access the GetRegistrationCode action.
- Returns:
- Result of the GetRegistrationCode operation returned by the service.
- Throws:
ThrottlingException
- The rate 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.AwsServiceException
- See Also:
getRegistrationCode(GetRegistrationCodeRequest)
-
getStatistics
default GetStatisticsResponse getStatistics(GetStatisticsRequest getStatisticsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetStatistics operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
getStatistics
default GetStatisticsResponse getStatistics(Consumer<GetStatisticsRequest.Builder> getStatisticsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetStatistics operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
getTopicRule
default GetTopicRuleResponse getTopicRule(GetTopicRuleRequest getTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Gets information about the rule.
Requires permission to access the GetTopicRule action.
- Parameters:
getTopicRuleRequest
- The input for the GetTopicRule operation.- Returns:
- Result of the GetTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
getTopicRule
default GetTopicRuleResponse getTopicRule(Consumer<GetTopicRuleRequest.Builder> getTopicRuleRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
getTopicRuleDestination
default GetTopicRuleDestinationResponse getTopicRuleDestination(GetTopicRuleDestinationRequest getTopicRuleDestinationRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Gets information about a topic rule destination.
Requires permission to access the GetTopicRuleDestination action.
- Parameters:
getTopicRuleDestinationRequest
-- Returns:
- Result of the GetTopicRuleDestination operation returned by the service.
- Throws:
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.AwsServiceException
-
getTopicRuleDestination
default GetTopicRuleDestinationResponse getTopicRuleDestination(Consumer<GetTopicRuleDestinationRequest.Builder> getTopicRuleDestinationRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetTopicRuleDestination operation returned by the service.
- Throws:
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.AwsServiceException
-
getV2LoggingOptions
default GetV2LoggingOptionsResponse getV2LoggingOptions(GetV2LoggingOptionsRequest getV2LoggingOptionsRequest) throws InternalException, NotConfiguredException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Gets the fine grained logging options.
Requires permission to access the GetV2LoggingOptions action.
- Parameters:
getV2LoggingOptionsRequest
-- Returns:
- Result of the GetV2LoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException
-
getV2LoggingOptions
default GetV2LoggingOptionsResponse getV2LoggingOptions(Consumer<GetV2LoggingOptionsRequest.Builder> getV2LoggingOptionsRequest) throws InternalException, NotConfiguredException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the GetV2LoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException
-
listActiveViolations
default ListActiveViolationsResponse listActiveViolations(ListActiveViolationsRequest listActiveViolationsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
- Parameters:
listActiveViolationsRequest
-- Returns:
- Result of the ListActiveViolations operation returned by the service.
- Throws:
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.AwsServiceException
-
listActiveViolations
default ListActiveViolationsResponse listActiveViolations(Consumer<ListActiveViolationsRequest.Builder> listActiveViolationsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListActiveViolations operation returned by the service.
- Throws:
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.AwsServiceException
-
listActiveViolations
default ListActiveViolationsResponse listActiveViolations() throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
- Returns:
- Result of the ListActiveViolations operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
listActiveViolations(ListActiveViolationsRequest)
-
listActiveViolationsPaginator
default ListActiveViolationsIterable listActiveViolationsPaginator() throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
This is a variant of
listActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListActiveViolationsIterable responses = client.listActiveViolationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListActiveViolationsIterable responses = client .listActiveViolationsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListActiveViolationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListActiveViolationsIterable responses = client.listActiveViolationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
listActiveViolationsPaginator(ListActiveViolationsRequest)
-
listActiveViolationsPaginator
default ListActiveViolationsIterable listActiveViolationsPaginator(ListActiveViolationsRequest listActiveViolationsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
This is a variant of
listActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListActiveViolationsIterable responses = client.listActiveViolationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListActiveViolationsIterable responses = client .listActiveViolationsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListActiveViolationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListActiveViolationsIterable responses = client.listActiveViolationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listActiveViolationsPaginator
default ListActiveViolationsIterable listActiveViolationsPaginator(Consumer<ListActiveViolationsRequest.Builder> listActiveViolationsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
This is a variant of
listActiveViolations(software.amazon.awssdk.services.iot.model.ListActiveViolationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListActiveViolationsIterable responses = client.listActiveViolationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListActiveViolationsIterable responses = client .listActiveViolationsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListActiveViolationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListActiveViolationsIterable responses = client.listActiveViolationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAttachedPolicies
default ListAttachedPoliciesResponse listAttachedPolicies(ListAttachedPoliciesRequest listAttachedPoliciesRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
Lists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
- Parameters:
listAttachedPoliciesRequest
-- Returns:
- Result of the ListAttachedPolicies operation returned by the service.
- Throws:
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.AwsServiceException
-
listAttachedPolicies
default ListAttachedPoliciesResponse listAttachedPolicies(Consumer<ListAttachedPoliciesRequest.Builder> listAttachedPoliciesRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListAttachedPolicies operation returned by the service.
- Throws:
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.AwsServiceException
-
listAttachedPoliciesPaginator
default ListAttachedPoliciesIterable listAttachedPoliciesPaginator(ListAttachedPoliciesRequest listAttachedPoliciesRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
Lists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
This is a variant of
listAttachedPolicies(software.amazon.awssdk.services.iot.model.ListAttachedPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAttachedPoliciesIterable responses = client.listAttachedPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAttachedPoliciesIterable responses = client .listAttachedPoliciesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAttachedPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAttachedPoliciesIterable responses = client.listAttachedPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAttachedPoliciesPaginator
default ListAttachedPoliciesIterable listAttachedPoliciesPaginator(Consumer<ListAttachedPoliciesRequest.Builder> listAttachedPoliciesRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
Lists the policies attached to the specified thing group.
Requires permission to access the ListAttachedPolicies action.
This is a variant of
listAttachedPolicies(software.amazon.awssdk.services.iot.model.ListAttachedPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAttachedPoliciesIterable responses = client.listAttachedPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAttachedPoliciesIterable responses = client .listAttachedPoliciesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAttachedPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAttachedPoliciesIterable responses = client.listAttachedPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuditFindings
default ListAuditFindingsResponse listAuditFindings(ListAuditFindingsRequest listAuditFindingsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListAuditFindings operation returned by the service.
- Throws:
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.AwsServiceException
-
listAuditFindings
default ListAuditFindingsResponse listAuditFindings(Consumer<ListAuditFindingsRequest.Builder> listAuditFindingsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListAuditFindings operation returned by the service.
- Throws:
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.AwsServiceException
-
listAuditFindingsPaginator
default ListAuditFindingsIterable listAuditFindingsPaginator(ListAuditFindingsRequest listAuditFindingsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listAuditFindings(software.amazon.awssdk.services.iot.model.ListAuditFindingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuditFindingsIterable responses = client.listAuditFindingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuditFindingsIterable responses = client .listAuditFindingsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuditFindingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuditFindingsIterable responses = client.listAuditFindingsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuditFindingsPaginator
default ListAuditFindingsIterable listAuditFindingsPaginator(Consumer<ListAuditFindingsRequest.Builder> listAuditFindingsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listAuditFindings(software.amazon.awssdk.services.iot.model.ListAuditFindingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuditFindingsIterable responses = client.listAuditFindingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuditFindingsIterable responses = client .listAuditFindingsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuditFindingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuditFindingsIterable responses = client.listAuditFindingsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuditMitigationActionsExecutions
default ListAuditMitigationActionsExecutionsResponse listAuditMitigationActionsExecutions(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
- Parameters:
listAuditMitigationActionsExecutionsRequest
-- Returns:
- Result of the ListAuditMitigationActionsExecutions operation returned by the service.
- Throws:
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.AwsServiceException
-
listAuditMitigationActionsExecutions
default ListAuditMitigationActionsExecutionsResponse listAuditMitigationActionsExecutions(Consumer<ListAuditMitigationActionsExecutionsRequest.Builder> listAuditMitigationActionsExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListAuditMitigationActionsExecutions operation returned by the service.
- Throws:
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.AwsServiceException
-
listAuditMitigationActionsExecutionsPaginator
default ListAuditMitigationActionsExecutionsIterable listAuditMitigationActionsExecutionsPaginator(ListAuditMitigationActionsExecutionsRequest listAuditMitigationActionsExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
This is a variant of
listAuditMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsExecutionsIterable responses = client.listAuditMitigationActionsExecutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsExecutionsIterable responses = client .listAuditMitigationActionsExecutionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsExecutionsIterable responses = client.listAuditMitigationActionsExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuditMitigationActionsExecutionsPaginator
default ListAuditMitigationActionsExecutionsIterable listAuditMitigationActionsExecutionsPaginator(Consumer<ListAuditMitigationActionsExecutionsRequest.Builder> listAuditMitigationActionsExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets the status of audit mitigation action tasks that were executed.
Requires permission to access the ListAuditMitigationActionsExecutions action.
This is a variant of
listAuditMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsExecutionsIterable responses = client.listAuditMitigationActionsExecutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsExecutionsIterable responses = client .listAuditMitigationActionsExecutionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsExecutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsExecutionsIterable responses = client.listAuditMitigationActionsExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuditMitigationActionsTasks
default ListAuditMitigationActionsTasksResponse listAuditMitigationActionsTasks(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
- Parameters:
listAuditMitigationActionsTasksRequest
-- Returns:
- Result of the ListAuditMitigationActionsTasks operation returned by the service.
- Throws:
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.AwsServiceException
-
listAuditMitigationActionsTasks
default ListAuditMitigationActionsTasksResponse listAuditMitigationActionsTasks(Consumer<ListAuditMitigationActionsTasksRequest.Builder> listAuditMitigationActionsTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListAuditMitigationActionsTasks operation returned by the service.
- Throws:
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.AwsServiceException
-
listAuditMitigationActionsTasksPaginator
default ListAuditMitigationActionsTasksIterable listAuditMitigationActionsTasksPaginator(ListAuditMitigationActionsTasksRequest listAuditMitigationActionsTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
This is a variant of
listAuditMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsTasksIterable responses = client.listAuditMitigationActionsTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsTasksIterable responses = client .listAuditMitigationActionsTasksPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsTasksIterable responses = client.listAuditMitigationActionsTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuditMitigationActionsTasksPaginator
default ListAuditMitigationActionsTasksIterable listAuditMitigationActionsTasksPaginator(Consumer<ListAuditMitigationActionsTasksRequest.Builder> listAuditMitigationActionsTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets a list of audit mitigation action tasks that match the specified filters.
Requires permission to access the ListAuditMitigationActionsTasks action.
This is a variant of
listAuditMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsTasksIterable responses = client.listAuditMitigationActionsTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsTasksIterable responses = client .listAuditMitigationActionsTasksPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuditMitigationActionsTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuditMitigationActionsTasksIterable responses = client.listAuditMitigationActionsTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuditSuppressions
default ListAuditSuppressionsResponse listAuditSuppressions(ListAuditSuppressionsRequest listAuditSuppressionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
- Parameters:
listAuditSuppressionsRequest
-- Returns:
- Result of the ListAuditSuppressions operation returned by the service.
- Throws:
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.AwsServiceException
-
listAuditSuppressions
default ListAuditSuppressionsResponse listAuditSuppressions(Consumer<ListAuditSuppressionsRequest.Builder> listAuditSuppressionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListAuditSuppressions operation returned by the service.
- Throws:
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.AwsServiceException
-
listAuditSuppressionsPaginator
default ListAuditSuppressionsIterable listAuditSuppressionsPaginator(ListAuditSuppressionsRequest listAuditSuppressionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
This is a variant of
listAuditSuppressions(software.amazon.awssdk.services.iot.model.ListAuditSuppressionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuditSuppressionsIterable responses = client.listAuditSuppressionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuditSuppressionsIterable responses = client .listAuditSuppressionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuditSuppressionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuditSuppressionsIterable responses = client.listAuditSuppressionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuditSuppressionsPaginator
default ListAuditSuppressionsIterable listAuditSuppressionsPaginator(Consumer<ListAuditSuppressionsRequest.Builder> listAuditSuppressionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your Device Defender audit listings.
Requires permission to access the ListAuditSuppressions action.
This is a variant of
listAuditSuppressions(software.amazon.awssdk.services.iot.model.ListAuditSuppressionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuditSuppressionsIterable responses = client.listAuditSuppressionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuditSuppressionsIterable responses = client .listAuditSuppressionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuditSuppressionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuditSuppressionsIterable responses = client.listAuditSuppressionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuditTasks
default ListAuditTasksResponse listAuditTasks(ListAuditTasksRequest listAuditTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
- Parameters:
listAuditTasksRequest
-- Returns:
- Result of the ListAuditTasks operation returned by the service.
- Throws:
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.AwsServiceException
-
listAuditTasks
default ListAuditTasksResponse listAuditTasks(Consumer<ListAuditTasksRequest.Builder> listAuditTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListAuditTasks operation returned by the service.
- Throws:
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.AwsServiceException
-
listAuditTasksPaginator
default ListAuditTasksIterable listAuditTasksPaginator(ListAuditTasksRequest listAuditTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
This is a variant of
listAuditTasks(software.amazon.awssdk.services.iot.model.ListAuditTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuditTasksIterable responses = client.listAuditTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuditTasksIterable responses = client.listAuditTasksPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuditTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuditTasksIterable responses = client.listAuditTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuditTasksPaginator
default ListAuditTasksIterable listAuditTasksPaginator(Consumer<ListAuditTasksRequest.Builder> listAuditTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the Device Defender audits that have been performed during a given time period.
Requires permission to access the ListAuditTasks action.
This is a variant of
listAuditTasks(software.amazon.awssdk.services.iot.model.ListAuditTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuditTasksIterable responses = client.listAuditTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuditTasksIterable responses = client.listAuditTasksPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuditTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuditTasksIterable responses = client.listAuditTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listAuthorizers
default ListAuthorizersResponse listAuthorizers(ListAuthorizersRequest listAuthorizersRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
- Parameters:
listAuthorizersRequest
-- Returns:
- Result of the ListAuthorizers operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listAuthorizers
default ListAuthorizersResponse listAuthorizers(Consumer<ListAuthorizersRequest.Builder> listAuthorizersRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListAuthorizers operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listAuthorizers
default ListAuthorizersResponse listAuthorizers() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
- Returns:
- Result of the ListAuthorizers operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listAuthorizers(ListAuthorizersRequest)
-
listAuthorizersPaginator
default ListAuthorizersIterable listAuthorizersPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
This is a variant of
listAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuthorizersIterable responses = client.listAuthorizersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuthorizersIterable responses = client.listAuthorizersPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuthorizersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuthorizersIterable responses = client.listAuthorizersPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listAuthorizersPaginator(ListAuthorizersRequest)
-
listAuthorizersPaginator
default ListAuthorizersIterable listAuthorizersPaginator(ListAuthorizersRequest listAuthorizersRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
This is a variant of
listAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuthorizersIterable responses = client.listAuthorizersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuthorizersIterable responses = client.listAuthorizersPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuthorizersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuthorizersIterable responses = client.listAuthorizersPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listAuthorizersPaginator
default ListAuthorizersIterable listAuthorizersPaginator(Consumer<ListAuthorizersRequest.Builder> listAuthorizersRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the authorizers registered in your account.
Requires permission to access the ListAuthorizers action.
This is a variant of
listAuthorizers(software.amazon.awssdk.services.iot.model.ListAuthorizersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListAuthorizersIterable responses = client.listAuthorizersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListAuthorizersIterable responses = client.listAuthorizersPaginator(request); for (software.amazon.awssdk.services.iot.model.ListAuthorizersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListAuthorizersIterable responses = client.listAuthorizersPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listBillingGroups
default ListBillingGroupsResponse listBillingGroups(ListBillingGroupsRequest listBillingGroupsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
- Parameters:
listBillingGroupsRequest
-- Returns:
- Result of the ListBillingGroups operation returned by the service.
- Throws:
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.AwsServiceException
-
listBillingGroups
default ListBillingGroupsResponse listBillingGroups(Consumer<ListBillingGroupsRequest.Builder> listBillingGroupsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListBillingGroups operation returned by the service.
- Throws:
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.AwsServiceException
-
listBillingGroups
default ListBillingGroupsResponse listBillingGroups() throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
- Returns:
- Result of the ListBillingGroups operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
listBillingGroups(ListBillingGroupsRequest)
-
listBillingGroupsPaginator
default ListBillingGroupsIterable listBillingGroupsPaginator() throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
This is a variant of
listBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListBillingGroupsIterable responses = client.listBillingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListBillingGroupsIterable responses = client .listBillingGroupsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListBillingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListBillingGroupsIterable responses = client.listBillingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
listBillingGroupsPaginator(ListBillingGroupsRequest)
-
listBillingGroupsPaginator
default ListBillingGroupsIterable listBillingGroupsPaginator(ListBillingGroupsRequest listBillingGroupsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
This is a variant of
listBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListBillingGroupsIterable responses = client.listBillingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListBillingGroupsIterable responses = client .listBillingGroupsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListBillingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListBillingGroupsIterable responses = client.listBillingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listBillingGroupsPaginator
default ListBillingGroupsIterable listBillingGroupsPaginator(Consumer<ListBillingGroupsRequest.Builder> listBillingGroupsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the billing groups you have created.
Requires permission to access the ListBillingGroups action.
This is a variant of
listBillingGroups(software.amazon.awssdk.services.iot.model.ListBillingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListBillingGroupsIterable responses = client.listBillingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListBillingGroupsIterable responses = client .listBillingGroupsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListBillingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListBillingGroupsIterable responses = client.listBillingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listCACertificates
default ListCaCertificatesResponse listCACertificates(ListCaCertificatesRequest listCaCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListCACertificates operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCACertificates
default ListCaCertificatesResponse listCACertificates(Consumer<ListCaCertificatesRequest.Builder> listCaCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListCACertificates operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCACertificates
default ListCaCertificatesResponse listCACertificates() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListCACertificates operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listCACertificates(ListCaCertificatesRequest)
-
listCACertificatesPaginator
default ListCACertificatesIterable listCACertificatesPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListCACertificatesIterable responses = client.listCACertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListCACertificatesIterable responses = client .listCACertificatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListCaCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListCACertificatesIterable responses = client.listCACertificatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listCACertificatesPaginator(ListCaCertificatesRequest)
-
listCACertificatesPaginator
default ListCACertificatesIterable listCACertificatesPaginator(ListCaCertificatesRequest listCaCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListCACertificatesIterable responses = client.listCACertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListCACertificatesIterable responses = client .listCACertificatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListCaCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListCACertificatesIterable responses = client.listCACertificatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCACertificatesPaginator
default ListCACertificatesIterable listCACertificatesPaginator(Consumer<ListCaCertificatesRequest.Builder> listCaCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listCACertificates(software.amazon.awssdk.services.iot.model.ListCaCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListCACertificatesIterable responses = client.listCACertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListCACertificatesIterable responses = client .listCACertificatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListCaCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListCACertificatesIterable responses = client.listCACertificatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCertificates
default ListCertificatesResponse listCertificates(ListCertificatesRequest listCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListCertificates operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCertificates
default ListCertificatesResponse listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListCertificates operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCertificates
default ListCertificatesResponse listCertificates() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListCertificates operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listCertificates(ListCertificatesRequest)
-
listCertificatesPaginator
default ListCertificatesIterable listCertificatesPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listCertificatesPaginator(ListCertificatesRequest)
-
listCertificatesPaginator
default ListCertificatesIterable listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCertificatesPaginator
default ListCertificatesIterable listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listCertificates(software.amazon.awssdk.services.iot.model.ListCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListCertificatesIterable responses = client.listCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCertificatesByCA
default ListCertificatesByCaResponse listCertificatesByCA(ListCertificatesByCaRequest listCertificatesByCaRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListCertificatesByCA operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCertificatesByCA
default ListCertificatesByCaResponse listCertificatesByCA(Consumer<ListCertificatesByCaRequest.Builder> listCertificatesByCaRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListCertificatesByCA operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCertificatesByCAPaginator
default ListCertificatesByCAIterable listCertificatesByCAPaginator(ListCertificatesByCaRequest listCertificatesByCaRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
List the device certificates signed by the specified CA certificate.
Requires permission to access the ListCertificatesByCA action.
This is a variant of
listCertificatesByCA(software.amazon.awssdk.services.iot.model.ListCertificatesByCaRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListCertificatesByCAIterable responses = client.listCertificatesByCAPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListCertificatesByCAIterable responses = client .listCertificatesByCAPaginator(request); for (software.amazon.awssdk.services.iot.model.ListCertificatesByCaResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListCertificatesByCAIterable responses = client.listCertificatesByCAPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCertificatesByCAPaginator
default ListCertificatesByCAIterable listCertificatesByCAPaginator(Consumer<ListCertificatesByCaRequest.Builder> listCertificatesByCaRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
List the device certificates signed by the specified CA certificate.
Requires permission to access the ListCertificatesByCA action.
This is a variant of
listCertificatesByCA(software.amazon.awssdk.services.iot.model.ListCertificatesByCaRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListCertificatesByCAIterable responses = client.listCertificatesByCAPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListCertificatesByCAIterable responses = client .listCertificatesByCAPaginator(request); for (software.amazon.awssdk.services.iot.model.ListCertificatesByCaResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListCertificatesByCAIterable responses = client.listCertificatesByCAPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listCustomMetrics
default ListCustomMetricsResponse listCustomMetrics(ListCustomMetricsRequest listCustomMetricsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
- Parameters:
listCustomMetricsRequest
-- Returns:
- Result of the ListCustomMetrics operation returned by the service.
- Throws:
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.AwsServiceException
-
listCustomMetrics
default ListCustomMetricsResponse listCustomMetrics(Consumer<ListCustomMetricsRequest.Builder> listCustomMetricsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListCustomMetrics operation returned by the service.
- Throws:
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.AwsServiceException
-
listCustomMetricsPaginator
default ListCustomMetricsIterable listCustomMetricsPaginator(ListCustomMetricsRequest listCustomMetricsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
This is a variant of
listCustomMetrics(software.amazon.awssdk.services.iot.model.ListCustomMetricsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListCustomMetricsIterable responses = client.listCustomMetricsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListCustomMetricsIterable responses = client .listCustomMetricsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListCustomMetricsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListCustomMetricsIterable responses = client.listCustomMetricsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listCustomMetricsPaginator
default ListCustomMetricsIterable listCustomMetricsPaginator(Consumer<ListCustomMetricsRequest.Builder> listCustomMetricsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your Device Defender detect custom metrics.
Requires permission to access the ListCustomMetrics action.
This is a variant of
listCustomMetrics(software.amazon.awssdk.services.iot.model.ListCustomMetricsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListCustomMetricsIterable responses = client.listCustomMetricsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListCustomMetricsIterable responses = client .listCustomMetricsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListCustomMetricsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListCustomMetricsIterable responses = client.listCustomMetricsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listDetectMitigationActionsExecutions
default ListDetectMitigationActionsExecutionsResponse listDetectMitigationActionsExecutions(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
- Parameters:
listDetectMitigationActionsExecutionsRequest
-- Returns:
- Result of the ListDetectMitigationActionsExecutions operation returned by the service.
- Throws:
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.AwsServiceException
-
listDetectMitigationActionsExecutions
default ListDetectMitigationActionsExecutionsResponse listDetectMitigationActionsExecutions(Consumer<ListDetectMitigationActionsExecutionsRequest.Builder> listDetectMitigationActionsExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListDetectMitigationActionsExecutions operation returned by the service.
- Throws:
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.AwsServiceException
-
listDetectMitigationActionsExecutionsPaginator
default ListDetectMitigationActionsExecutionsIterable listDetectMitigationActionsExecutionsPaginator(ListDetectMitigationActionsExecutionsRequest listDetectMitigationActionsExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
This is a variant of
listDetectMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsExecutionsIterable responses = client.listDetectMitigationActionsExecutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsExecutionsIterable responses = client .listDetectMitigationActionsExecutionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsExecutionsIterable responses = client.listDetectMitigationActionsExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listDetectMitigationActionsExecutionsPaginator
default ListDetectMitigationActionsExecutionsIterable listDetectMitigationActionsExecutionsPaginator(Consumer<ListDetectMitigationActionsExecutionsRequest.Builder> listDetectMitigationActionsExecutionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Requires permission to access the ListDetectMitigationActionsExecutions action.
This is a variant of
listDetectMitigationActionsExecutions(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsExecutionsIterable responses = client.listDetectMitigationActionsExecutionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsExecutionsIterable responses = client .listDetectMitigationActionsExecutionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsExecutionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsExecutionsIterable responses = client.listDetectMitigationActionsExecutionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listDetectMitigationActionsTasks
default ListDetectMitigationActionsTasksResponse listDetectMitigationActionsTasks(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
- Parameters:
listDetectMitigationActionsTasksRequest
-- Returns:
- Result of the ListDetectMitigationActionsTasks operation returned by the service.
- Throws:
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.AwsServiceException
-
listDetectMitigationActionsTasks
default ListDetectMitigationActionsTasksResponse listDetectMitigationActionsTasks(Consumer<ListDetectMitigationActionsTasksRequest.Builder> listDetectMitigationActionsTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListDetectMitigationActionsTasks operation returned by the service.
- Throws:
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.AwsServiceException
-
listDetectMitigationActionsTasksPaginator
default ListDetectMitigationActionsTasksIterable listDetectMitigationActionsTasksPaginator(ListDetectMitigationActionsTasksRequest listDetectMitigationActionsTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
This is a variant of
listDetectMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsTasksIterable responses = client.listDetectMitigationActionsTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsTasksIterable responses = client .listDetectMitigationActionsTasksPaginator(request); for (software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsTasksIterable responses = client.listDetectMitigationActionsTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listDetectMitigationActionsTasksPaginator
default ListDetectMitigationActionsTasksIterable listDetectMitigationActionsTasksPaginator(Consumer<ListDetectMitigationActionsTasksRequest.Builder> listDetectMitigationActionsTasksRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
List of Device Defender ML Detect mitigation actions tasks.
Requires permission to access the ListDetectMitigationActionsTasks action.
This is a variant of
listDetectMitigationActionsTasks(software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsTasksIterable responses = client.listDetectMitigationActionsTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsTasksIterable responses = client .listDetectMitigationActionsTasksPaginator(request); for (software.amazon.awssdk.services.iot.model.ListDetectMitigationActionsTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListDetectMitigationActionsTasksIterable responses = client.listDetectMitigationActionsTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listDimensions
default ListDimensionsResponse listDimensions(ListDimensionsRequest listDimensionsRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
- Parameters:
listDimensionsRequest
-- Returns:
- Result of the ListDimensions operation returned by the service.
- Throws:
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.AwsServiceException
-
listDimensions
default ListDimensionsResponse listDimensions(Consumer<ListDimensionsRequest.Builder> listDimensionsRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListDimensions operation returned by the service.
- Throws:
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.AwsServiceException
-
listDimensionsPaginator
default ListDimensionsIterable listDimensionsPaginator(ListDimensionsRequest listDimensionsRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
This is a variant of
listDimensions(software.amazon.awssdk.services.iot.model.ListDimensionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListDimensionsIterable responses = client.listDimensionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListDimensionsIterable responses = client.listDimensionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListDimensionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListDimensionsIterable responses = client.listDimensionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listDimensionsPaginator
default ListDimensionsIterable listDimensionsPaginator(Consumer<ListDimensionsRequest.Builder> listDimensionsRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the set of dimensions that are defined for your Amazon Web Services accounts.
Requires permission to access the ListDimensions action.
This is a variant of
listDimensions(software.amazon.awssdk.services.iot.model.ListDimensionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListDimensionsIterable responses = client.listDimensionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListDimensionsIterable responses = client.listDimensionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListDimensionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListDimensionsIterable responses = client.listDimensionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listDomainConfigurations
default ListDomainConfigurationsResponse listDomainConfigurations(ListDomainConfigurationsRequest listDomainConfigurationsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListDomainConfigurations operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listDomainConfigurations
default ListDomainConfigurationsResponse listDomainConfigurations(Consumer<ListDomainConfigurationsRequest.Builder> listDomainConfigurationsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListDomainConfigurations operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listDomainConfigurationsPaginator
default ListDomainConfigurationsIterable listDomainConfigurationsPaginator(ListDomainConfigurationsRequest listDomainConfigurationsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listDomainConfigurations(software.amazon.awssdk.services.iot.model.ListDomainConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListDomainConfigurationsIterable responses = client.listDomainConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListDomainConfigurationsIterable responses = client .listDomainConfigurationsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListDomainConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListDomainConfigurationsIterable responses = client.listDomainConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listDomainConfigurationsPaginator
default ListDomainConfigurationsIterable listDomainConfigurationsPaginator(Consumer<ListDomainConfigurationsRequest.Builder> listDomainConfigurationsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listDomainConfigurations(software.amazon.awssdk.services.iot.model.ListDomainConfigurationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListDomainConfigurationsIterable responses = client.listDomainConfigurationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListDomainConfigurationsIterable responses = client .listDomainConfigurationsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListDomainConfigurationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListDomainConfigurationsIterable responses = client.listDomainConfigurationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listFleetMetrics
default ListFleetMetricsResponse listFleetMetrics(ListFleetMetricsRequest listFleetMetricsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
- Parameters:
listFleetMetricsRequest
-- Returns:
- Result of the ListFleetMetrics operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listFleetMetrics
default ListFleetMetricsResponse listFleetMetrics(Consumer<ListFleetMetricsRequest.Builder> listFleetMetricsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListFleetMetrics operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listFleetMetricsPaginator
default ListFleetMetricsIterable listFleetMetricsPaginator(ListFleetMetricsRequest listFleetMetricsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
This is a variant of
listFleetMetrics(software.amazon.awssdk.services.iot.model.ListFleetMetricsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListFleetMetricsIterable responses = client.listFleetMetricsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListFleetMetricsIterable responses = client.listFleetMetricsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListFleetMetricsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListFleetMetricsIterable responses = client.listFleetMetricsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listFleetMetricsPaginator
default ListFleetMetricsIterable listFleetMetricsPaginator(Consumer<ListFleetMetricsRequest.Builder> listFleetMetricsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all your fleet metrics.
Requires permission to access the ListFleetMetrics action.
This is a variant of
listFleetMetrics(software.amazon.awssdk.services.iot.model.ListFleetMetricsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListFleetMetricsIterable responses = client.listFleetMetricsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListFleetMetricsIterable responses = client.listFleetMetricsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListFleetMetricsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListFleetMetricsIterable responses = client.listFleetMetricsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listIndices
default ListIndicesResponse listIndices(ListIndicesRequest listIndicesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the search indices.
Requires permission to access the ListIndices action.
- Parameters:
listIndicesRequest
-- Returns:
- Result of the ListIndices operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listIndices
default ListIndicesResponse listIndices(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListIndices operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listIndices
default ListIndicesResponse listIndices() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the search indices.
Requires permission to access the ListIndices action.
- Returns:
- Result of the ListIndices operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listIndices(ListIndicesRequest)
-
listIndicesPaginator
default ListIndicesIterable listIndicesPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the search indices.
Requires permission to access the ListIndices action.
This is a variant of
listIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListIndicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listIndicesPaginator(ListIndicesRequest)
-
listIndicesPaginator
default ListIndicesIterable listIndicesPaginator(ListIndicesRequest listIndicesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the search indices.
Requires permission to access the ListIndices action.
This is a variant of
listIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListIndicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listIndicesPaginator
default ListIndicesIterable listIndicesPaginator(Consumer<ListIndicesRequest.Builder> listIndicesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the search indices.
Requires permission to access the ListIndices action.
This is a variant of
listIndices(software.amazon.awssdk.services.iot.model.ListIndicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListIndicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListIndicesIterable responses = client.listIndicesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listJobExecutionsForJob
default ListJobExecutionsForJobResponse listJobExecutionsForJob(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
- Parameters:
listJobExecutionsForJobRequest
-- Returns:
- Result of the ListJobExecutionsForJob operation returned by the service.
- Throws:
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.AwsServiceException
-
listJobExecutionsForJob
default ListJobExecutionsForJobResponse listJobExecutionsForJob(Consumer<ListJobExecutionsForJobRequest.Builder> listJobExecutionsForJobRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListJobExecutionsForJob operation returned by the service.
- Throws:
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.AwsServiceException
-
listJobExecutionsForJobPaginator
default ListJobExecutionsForJobIterable listJobExecutionsForJobPaginator(ListJobExecutionsForJobRequest listJobExecutionsForJobRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
This is a variant of
listJobExecutionsForJob(software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForJobIterable responses = client.listJobExecutionsForJobPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListJobExecutionsForJobIterable responses = client .listJobExecutionsForJobPaginator(request); for (software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForJobIterable responses = client.listJobExecutionsForJobPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listJobExecutionsForJobPaginator
default ListJobExecutionsForJobIterable listJobExecutionsForJobPaginator(Consumer<ListJobExecutionsForJobRequest.Builder> listJobExecutionsForJobRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the job executions for a job.
Requires permission to access the ListJobExecutionsForJob action.
This is a variant of
listJobExecutionsForJob(software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForJobIterable responses = client.listJobExecutionsForJobPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListJobExecutionsForJobIterable responses = client .listJobExecutionsForJobPaginator(request); for (software.amazon.awssdk.services.iot.model.ListJobExecutionsForJobResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForJobIterable responses = client.listJobExecutionsForJobPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listJobExecutionsForThing
default ListJobExecutionsForThingResponse listJobExecutionsForThing(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
- Parameters:
listJobExecutionsForThingRequest
-- Returns:
- Result of the ListJobExecutionsForThing operation returned by the service.
- Throws:
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.AwsServiceException
-
listJobExecutionsForThing
default ListJobExecutionsForThingResponse listJobExecutionsForThing(Consumer<ListJobExecutionsForThingRequest.Builder> listJobExecutionsForThingRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListJobExecutionsForThing operation returned by the service.
- Throws:
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.AwsServiceException
-
listJobExecutionsForThingPaginator
default ListJobExecutionsForThingIterable listJobExecutionsForThingPaginator(ListJobExecutionsForThingRequest listJobExecutionsForThingRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
This is a variant of
listJobExecutionsForThing(software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForThingIterable responses = client.listJobExecutionsForThingPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListJobExecutionsForThingIterable responses = client .listJobExecutionsForThingPaginator(request); for (software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForThingIterable responses = client.listJobExecutionsForThingPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listJobExecutionsForThingPaginator
default ListJobExecutionsForThingIterable listJobExecutionsForThingPaginator(Consumer<ListJobExecutionsForThingRequest.Builder> listJobExecutionsForThingRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
This is a variant of
listJobExecutionsForThing(software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForThingIterable responses = client.listJobExecutionsForThingPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListJobExecutionsForThingIterable responses = client .listJobExecutionsForThingPaginator(request); for (software.amazon.awssdk.services.iot.model.ListJobExecutionsForThingResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListJobExecutionsForThingIterable responses = client.listJobExecutionsForThingPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listJobTemplates
default ListJobTemplatesResponse listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
- Parameters:
listJobTemplatesRequest
-- Returns:
- Result of the ListJobTemplates operation returned by the service.
- Throws:
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.AwsServiceException
-
listJobTemplates
default ListJobTemplatesResponse listJobTemplates(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListJobTemplates operation returned by the service.
- Throws:
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.AwsServiceException
-
listJobTemplatesPaginator
default ListJobTemplatesIterable listJobTemplatesPaginator(ListJobTemplatesRequest listJobTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
This is a variant of
listJobTemplates(software.amazon.awssdk.services.iot.model.ListJobTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListJobTemplatesIterable responses = client.listJobTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListJobTemplatesIterable responses = client.listJobTemplatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListJobTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListJobTemplatesIterable responses = client.listJobTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listJobTemplatesPaginator
default ListJobTemplatesIterable listJobTemplatesPaginator(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Returns a list of job templates.
Requires permission to access the ListJobTemplates action.
This is a variant of
listJobTemplates(software.amazon.awssdk.services.iot.model.ListJobTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListJobTemplatesIterable responses = client.listJobTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListJobTemplatesIterable responses = client.listJobTemplatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListJobTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListJobTemplatesIterable responses = client.listJobTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listJobs
default ListJobsResponse listJobs(ListJobsRequest listJobsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists jobs.
Requires permission to access the ListJobs action.
- Parameters:
listJobsRequest
-- Returns:
- Result of the ListJobs operation returned by the service.
- Throws:
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.AwsServiceException
-
listJobs
default ListJobsResponse listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListJobs operation returned by the service.
- Throws:
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.AwsServiceException
-
listJobs
default ListJobsResponse listJobs() throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists jobs.
Requires permission to access the ListJobs action.
- Returns:
- Result of the ListJobs operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
listJobs(ListJobsRequest)
-
listJobsPaginator
default ListJobsIterable listJobsPaginator() throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists jobs.
Requires permission to access the ListJobs action.
This is a variant of
listJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListJobsIterable responses = client.listJobsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
listJobsPaginator(ListJobsRequest)
-
listJobsPaginator
default ListJobsIterable listJobsPaginator(ListJobsRequest listJobsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists jobs.
Requires permission to access the ListJobs action.
This is a variant of
listJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListJobsIterable responses = client.listJobsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listJobsPaginator
default ListJobsIterable listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists jobs.
Requires permission to access the ListJobs action.
This is a variant of
listJobs(software.amazon.awssdk.services.iot.model.ListJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListJobsIterable responses = client.listJobsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListJobsIterable responses = client.listJobsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listManagedJobTemplates
default ListManagedJobTemplatesResponse listManagedJobTemplates(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotException
Returns a list of managed job templates.
- Parameters:
listManagedJobTemplatesRequest
-- Returns:
- Result of the ListManagedJobTemplates operation returned by the service.
- Throws:
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.AwsServiceException
-
listManagedJobTemplates
default ListManagedJobTemplatesResponse listManagedJobTemplates(Consumer<ListManagedJobTemplatesRequest.Builder> listManagedJobTemplatesRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListManagedJobTemplates operation returned by the service.
- Throws:
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.AwsServiceException
-
listManagedJobTemplatesPaginator
default ListManagedJobTemplatesIterable listManagedJobTemplatesPaginator(ListManagedJobTemplatesRequest listManagedJobTemplatesRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotException
Returns a list of managed job templates.
This is a variant of
listManagedJobTemplates(software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListManagedJobTemplatesIterable responses = client.listManagedJobTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListManagedJobTemplatesIterable responses = client .listManagedJobTemplatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListManagedJobTemplatesIterable responses = client.listManagedJobTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listManagedJobTemplatesPaginator
default ListManagedJobTemplatesIterable listManagedJobTemplatesPaginator(Consumer<ListManagedJobTemplatesRequest.Builder> listManagedJobTemplatesRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, IotException
Returns a list of managed job templates.
This is a variant of
listManagedJobTemplates(software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListManagedJobTemplatesIterable responses = client.listManagedJobTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListManagedJobTemplatesIterable responses = client .listManagedJobTemplatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListManagedJobTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListManagedJobTemplatesIterable responses = client.listManagedJobTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listMetricValues
default ListMetricValuesResponse listMetricValues(ListMetricValuesRequest listMetricValuesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListMetricValues operation returned by the service.
- Throws:
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.AwsServiceException
-
listMetricValues
default ListMetricValuesResponse listMetricValues(Consumer<ListMetricValuesRequest.Builder> listMetricValuesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListMetricValues operation returned by the service.
- Throws:
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.AwsServiceException
-
listMetricValuesPaginator
default ListMetricValuesIterable listMetricValuesPaginator(ListMetricValuesRequest listMetricValuesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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 variant of
listMetricValues(software.amazon.awssdk.services.iot.model.ListMetricValuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListMetricValuesIterable responses = client.listMetricValuesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListMetricValuesIterable responses = client.listMetricValuesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListMetricValuesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListMetricValuesIterable responses = client.listMetricValuesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listMetricValuesPaginator
default ListMetricValuesIterable listMetricValuesPaginator(Consumer<ListMetricValuesRequest.Builder> listMetricValuesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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 variant of
listMetricValues(software.amazon.awssdk.services.iot.model.ListMetricValuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListMetricValuesIterable responses = client.listMetricValuesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListMetricValuesIterable responses = client.listMetricValuesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListMetricValuesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListMetricValuesIterable responses = client.listMetricValuesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listMitigationActions
default ListMitigationActionsResponse listMitigationActions(ListMitigationActionsRequest listMitigationActionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
- Parameters:
listMitigationActionsRequest
-- Returns:
- Result of the ListMitigationActions operation returned by the service.
- Throws:
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.AwsServiceException
-
listMitigationActions
default ListMitigationActionsResponse listMitigationActions(Consumer<ListMitigationActionsRequest.Builder> listMitigationActionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListMitigationActions operation returned by the service.
- Throws:
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.AwsServiceException
-
listMitigationActionsPaginator
default ListMitigationActionsIterable listMitigationActionsPaginator(ListMitigationActionsRequest listMitigationActionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
This is a variant of
listMitigationActions(software.amazon.awssdk.services.iot.model.ListMitigationActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListMitigationActionsIterable responses = client.listMitigationActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListMitigationActionsIterable responses = client .listMitigationActionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListMitigationActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListMitigationActionsIterable responses = client.listMitigationActionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listMitigationActionsPaginator
default ListMitigationActionsIterable listMitigationActionsPaginator(Consumer<ListMitigationActionsRequest.Builder> listMitigationActionsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Gets a list of all mitigation actions that match the specified filter criteria.
Requires permission to access the ListMitigationActions action.
This is a variant of
listMitigationActions(software.amazon.awssdk.services.iot.model.ListMitigationActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListMitigationActionsIterable responses = client.listMitigationActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListMitigationActionsIterable responses = client .listMitigationActionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListMitigationActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListMitigationActionsIterable responses = client.listMitigationActionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listOTAUpdates
default ListOtaUpdatesResponse listOTAUpdates(ListOtaUpdatesRequest listOtaUpdatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
- Parameters:
listOtaUpdatesRequest
-- Returns:
- Result of the ListOTAUpdates operation returned by the service.
- Throws:
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.AwsServiceException
-
listOTAUpdates
default ListOtaUpdatesResponse listOTAUpdates(Consumer<ListOtaUpdatesRequest.Builder> listOtaUpdatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListOTAUpdates operation returned by the service.
- Throws:
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.AwsServiceException
-
listOTAUpdates
default ListOtaUpdatesResponse listOTAUpdates() throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
- Returns:
- Result of the ListOTAUpdates operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
listOTAUpdates(ListOtaUpdatesRequest)
-
listOTAUpdatesPaginator
default ListOTAUpdatesIterable listOTAUpdatesPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
This is a variant of
listOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListOTAUpdatesIterable responses = client.listOTAUpdatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListOTAUpdatesIterable responses = client.listOTAUpdatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListOtaUpdatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListOTAUpdatesIterable responses = client.listOTAUpdatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
listOTAUpdatesPaginator(ListOtaUpdatesRequest)
-
listOTAUpdatesPaginator
default ListOTAUpdatesIterable listOTAUpdatesPaginator(ListOtaUpdatesRequest listOtaUpdatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
This is a variant of
listOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListOTAUpdatesIterable responses = client.listOTAUpdatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListOTAUpdatesIterable responses = client.listOTAUpdatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListOtaUpdatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListOTAUpdatesIterable responses = client.listOTAUpdatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listOTAUpdatesPaginator
default ListOTAUpdatesIterable listOTAUpdatesPaginator(Consumer<ListOtaUpdatesRequest.Builder> listOtaUpdatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists OTA updates.
Requires permission to access the ListOTAUpdates action.
This is a variant of
listOTAUpdates(software.amazon.awssdk.services.iot.model.ListOtaUpdatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListOTAUpdatesIterable responses = client.listOTAUpdatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListOTAUpdatesIterable responses = client.listOTAUpdatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListOtaUpdatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListOTAUpdatesIterable responses = client.listOTAUpdatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listOutgoingCertificates
default ListOutgoingCertificatesResponse listOutgoingCertificates(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListOutgoingCertificates operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listOutgoingCertificates
default ListOutgoingCertificatesResponse listOutgoingCertificates(Consumer<ListOutgoingCertificatesRequest.Builder> listOutgoingCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListOutgoingCertificates operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listOutgoingCertificates
default ListOutgoingCertificatesResponse listOutgoingCertificates() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
- Returns:
- Result of the ListOutgoingCertificates operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listOutgoingCertificates(ListOutgoingCertificatesRequest)
-
listOutgoingCertificatesPaginator
default ListOutgoingCertificatesIterable listOutgoingCertificatesPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
This is a variant of
listOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesIterable responses = client.listOutgoingCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesIterable responses = client .listOutgoingCertificatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesIterable responses = client.listOutgoingCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listOutgoingCertificatesPaginator(ListOutgoingCertificatesRequest)
-
listOutgoingCertificatesPaginator
default ListOutgoingCertificatesIterable listOutgoingCertificatesPaginator(ListOutgoingCertificatesRequest listOutgoingCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
This is a variant of
listOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesIterable responses = client.listOutgoingCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesIterable responses = client .listOutgoingCertificatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesIterable responses = client.listOutgoingCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listOutgoingCertificatesPaginator
default ListOutgoingCertificatesIterable listOutgoingCertificatesPaginator(Consumer<ListOutgoingCertificatesRequest.Builder> listOutgoingCertificatesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists certificates that are being transferred but not yet accepted.
Requires permission to access the ListOutgoingCertificates action.
This is a variant of
listOutgoingCertificates(software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesIterable responses = client.listOutgoingCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesIterable responses = client .listOutgoingCertificatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListOutgoingCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListOutgoingCertificatesIterable responses = client.listOutgoingCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listPackageVersions
default ListPackageVersionsResponse listPackageVersions(ListPackageVersionsRequest listPackageVersionsRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
- Parameters:
listPackageVersionsRequest
-- Returns:
- Result of the ListPackageVersions operation returned by the service.
- Throws:
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.AwsServiceException
-
listPackageVersions
default ListPackageVersionsResponse listPackageVersions(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListPackageVersions operation returned by the service.
- Throws:
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.AwsServiceException
-
listPackageVersionsPaginator
default ListPackageVersionsIterable listPackageVersionsPaginator(ListPackageVersionsRequest listPackageVersionsRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
This is a variant of
listPackageVersions(software.amazon.awssdk.services.iot.model.ListPackageVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListPackageVersionsIterable responses = client.listPackageVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListPackageVersionsIterable responses = client .listPackageVersionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListPackageVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListPackageVersionsIterable responses = client.listPackageVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listPackageVersionsPaginator
default ListPackageVersionsIterable listPackageVersionsPaginator(Consumer<ListPackageVersionsRequest.Builder> listPackageVersionsRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
Lists the software package versions associated to the account.
Requires permission to access the ListPackageVersions action.
This is a variant of
listPackageVersions(software.amazon.awssdk.services.iot.model.ListPackageVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListPackageVersionsIterable responses = client.listPackageVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListPackageVersionsIterable responses = client .listPackageVersionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListPackageVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListPackageVersionsIterable responses = client.listPackageVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listPackages
default ListPackagesResponse listPackages(ListPackagesRequest listPackagesRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
- Parameters:
listPackagesRequest
-- Returns:
- Result of the ListPackages operation returned by the service.
- Throws:
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.AwsServiceException
-
listPackages
default ListPackagesResponse listPackages(Consumer<ListPackagesRequest.Builder> listPackagesRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListPackages operation returned by the service.
- Throws:
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.AwsServiceException
-
listPackagesPaginator
default ListPackagesIterable listPackagesPaginator(ListPackagesRequest listPackagesRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
This is a variant of
listPackages(software.amazon.awssdk.services.iot.model.ListPackagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListPackagesIterable responses = client.listPackagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListPackagesIterable responses = client.listPackagesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListPackagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListPackagesIterable responses = client.listPackagesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listPackagesPaginator
default ListPackagesIterable listPackagesPaginator(Consumer<ListPackagesRequest.Builder> listPackagesRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
Lists the software packages associated to the account.
Requires permission to access the ListPackages action.
This is a variant of
listPackages(software.amazon.awssdk.services.iot.model.ListPackagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListPackagesIterable responses = client.listPackagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListPackagesIterable responses = client.listPackagesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListPackagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListPackagesIterable responses = client.listPackagesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listPolicies
default ListPoliciesResponse listPolicies(ListPoliciesRequest listPoliciesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your policies.
Requires permission to access the ListPolicies action.
- Parameters:
listPoliciesRequest
- The input for the ListPolicies operation.- Returns:
- Result of the ListPolicies operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listPolicies
default ListPoliciesResponse listPolicies(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListPolicies operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listPolicies
default ListPoliciesResponse listPolicies() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your policies.
Requires permission to access the ListPolicies action.
- Returns:
- Result of the ListPolicies operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listPolicies(ListPoliciesRequest)
-
listPoliciesPaginator
default ListPoliciesIterable listPoliciesPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your policies.
Requires permission to access the ListPolicies action.
This is a variant of
listPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listPoliciesPaginator(ListPoliciesRequest)
-
listPoliciesPaginator
default ListPoliciesIterable listPoliciesPaginator(ListPoliciesRequest listPoliciesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your policies.
Requires permission to access the ListPolicies action.
This is a variant of
listPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listPoliciesPaginator
default ListPoliciesIterable listPoliciesPaginator(Consumer<ListPoliciesRequest.Builder> listPoliciesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists your policies.
Requires permission to access the ListPolicies action.
This is a variant of
listPolicies(software.amazon.awssdk.services.iot.model.ListPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListPoliciesIterable responses = client.listPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listPolicyVersions
default ListPolicyVersionsResponse listPolicyVersions(ListPolicyVersionsRequest listPolicyVersionsRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListPolicyVersions operation returned by the service.
- Throws:
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.AwsServiceException
-
listPolicyVersions
default ListPolicyVersionsResponse listPolicyVersions(Consumer<ListPolicyVersionsRequest.Builder> listPolicyVersionsRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListPolicyVersions operation returned by the service.
- Throws:
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.AwsServiceException
-
listPrincipalThings
default ListPrincipalThingsResponse listPrincipalThings(ListPrincipalThingsRequest listPrincipalThingsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListPrincipalThings operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listPrincipalThings
default ListPrincipalThingsResponse listPrincipalThings(Consumer<ListPrincipalThingsRequest.Builder> listPrincipalThingsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListPrincipalThings operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listPrincipalThingsPaginator
default ListPrincipalThingsIterable listPrincipalThingsPaginator(ListPrincipalThingsRequest listPrincipalThingsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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 variant of
listPrincipalThings(software.amazon.awssdk.services.iot.model.ListPrincipalThingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListPrincipalThingsIterable responses = client.listPrincipalThingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListPrincipalThingsIterable responses = client .listPrincipalThingsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListPrincipalThingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListPrincipalThingsIterable responses = client.listPrincipalThingsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listPrincipalThingsPaginator
default ListPrincipalThingsIterable listPrincipalThingsPaginator(Consumer<ListPrincipalThingsRequest.Builder> listPrincipalThingsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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 variant of
listPrincipalThings(software.amazon.awssdk.services.iot.model.ListPrincipalThingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListPrincipalThingsIterable responses = client.listPrincipalThingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListPrincipalThingsIterable responses = client .listPrincipalThingsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListPrincipalThingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListPrincipalThingsIterable responses = client.listPrincipalThingsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listProvisioningTemplateVersions
default ListProvisioningTemplateVersionsResponse listProvisioningTemplateVersions(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, ResourceNotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
- Parameters:
listProvisioningTemplateVersionsRequest
-- Returns:
- Result of the ListProvisioningTemplateVersions operation returned by the service.
- Throws:
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.AwsServiceException
-
listProvisioningTemplateVersions
default ListProvisioningTemplateVersionsResponse listProvisioningTemplateVersions(Consumer<ListProvisioningTemplateVersionsRequest.Builder> listProvisioningTemplateVersionsRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, ResourceNotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListProvisioningTemplateVersions operation returned by the service.
- Throws:
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.AwsServiceException
-
listProvisioningTemplateVersionsPaginator
default ListProvisioningTemplateVersionsIterable listProvisioningTemplateVersionsPaginator(ListProvisioningTemplateVersionsRequest listProvisioningTemplateVersionsRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, ResourceNotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
This is a variant of
listProvisioningTemplateVersions(software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplateVersionsIterable responses = client.listProvisioningTemplateVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListProvisioningTemplateVersionsIterable responses = client .listProvisioningTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplateVersionsIterable responses = client.listProvisioningTemplateVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listProvisioningTemplateVersionsPaginator
default ListProvisioningTemplateVersionsIterable listProvisioningTemplateVersionsPaginator(Consumer<ListProvisioningTemplateVersionsRequest.Builder> listProvisioningTemplateVersionsRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, ResourceNotFoundException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
A list of provisioning template versions.
Requires permission to access the ListProvisioningTemplateVersions action.
This is a variant of
listProvisioningTemplateVersions(software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplateVersionsIterable responses = client.listProvisioningTemplateVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListProvisioningTemplateVersionsIterable responses = client .listProvisioningTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListProvisioningTemplateVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplateVersionsIterable responses = client.listProvisioningTemplateVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listProvisioningTemplates
default ListProvisioningTemplatesResponse listProvisioningTemplates(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Lists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
- Parameters:
listProvisioningTemplatesRequest
-- Returns:
- Result of the ListProvisioningTemplates operation returned by the service.
- Throws:
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.AwsServiceException
-
listProvisioningTemplates
default ListProvisioningTemplatesResponse listProvisioningTemplates(Consumer<ListProvisioningTemplatesRequest.Builder> listProvisioningTemplatesRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListProvisioningTemplates operation returned by the service.
- Throws:
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.AwsServiceException
-
listProvisioningTemplatesPaginator
default ListProvisioningTemplatesIterable listProvisioningTemplatesPaginator(ListProvisioningTemplatesRequest listProvisioningTemplatesRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Lists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
This is a variant of
listProvisioningTemplates(software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplatesIterable responses = client.listProvisioningTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListProvisioningTemplatesIterable responses = client .listProvisioningTemplatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplatesIterable responses = client.listProvisioningTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listProvisioningTemplatesPaginator
default ListProvisioningTemplatesIterable listProvisioningTemplatesPaginator(Consumer<ListProvisioningTemplatesRequest.Builder> listProvisioningTemplatesRequest) throws InternalFailureException, InvalidRequestException, ThrottlingException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Lists the provisioning templates in your Amazon Web Services account.
Requires permission to access the ListProvisioningTemplates action.
This is a variant of
listProvisioningTemplates(software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplatesIterable responses = client.listProvisioningTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListProvisioningTemplatesIterable responses = client .listProvisioningTemplatesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListProvisioningTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListProvisioningTemplatesIterable responses = client.listProvisioningTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listRelatedResourcesForAuditFinding
default ListRelatedResourcesForAuditFindingResponse listRelatedResourcesForAuditFinding(ListRelatedResourcesForAuditFindingRequest listRelatedResourcesForAuditFindingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListRelatedResourcesForAuditFinding operation returned by the service.
- Throws:
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.AwsServiceException
-
-
listRelatedResourcesForAuditFinding
default ListRelatedResourcesForAuditFindingResponse listRelatedResourcesForAuditFinding(Consumer<ListRelatedResourcesForAuditFindingRequest.Builder> listRelatedResourcesForAuditFindingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListRelatedResourcesForAuditFinding operation returned by the service.
- Throws:
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.AwsServiceException
-
-
listRelatedResourcesForAuditFindingPaginator
default ListRelatedResourcesForAuditFindingIterable listRelatedResourcesForAuditFindingPaginator(ListRelatedResourcesForAuditFindingRequest listRelatedResourcesForAuditFindingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listRelatedResourcesForAuditFinding(software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListRelatedResourcesForAuditFindingIterable responses = client.listRelatedResourcesForAuditFindingPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListRelatedResourcesForAuditFindingIterable responses = client .listRelatedResourcesForAuditFindingPaginator(request); for (software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListRelatedResourcesForAuditFindingIterable responses = client.listRelatedResourcesForAuditFindingPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
-
listRelatedResourcesForAuditFindingPaginator
default ListRelatedResourcesForAuditFindingIterable listRelatedResourcesForAuditFindingPaginator(Consumer<ListRelatedResourcesForAuditFindingRequest.Builder> listRelatedResourcesForAuditFindingRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listRelatedResourcesForAuditFinding(software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListRelatedResourcesForAuditFindingIterable responses = client.listRelatedResourcesForAuditFindingPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListRelatedResourcesForAuditFindingIterable responses = client .listRelatedResourcesForAuditFindingPaginator(request); for (software.amazon.awssdk.services.iot.model.ListRelatedResourcesForAuditFindingResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListRelatedResourcesForAuditFindingIterable responses = client.listRelatedResourcesForAuditFindingPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
-
listRoleAliases
default ListRoleAliasesResponse listRoleAliases(ListRoleAliasesRequest listRoleAliasesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
- Parameters:
listRoleAliasesRequest
-- Returns:
- Result of the ListRoleAliases operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listRoleAliases
default ListRoleAliasesResponse listRoleAliases(Consumer<ListRoleAliasesRequest.Builder> listRoleAliasesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListRoleAliases operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listRoleAliases
default ListRoleAliasesResponse listRoleAliases() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
- Returns:
- Result of the ListRoleAliases operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listRoleAliases(ListRoleAliasesRequest)
-
listRoleAliasesPaginator
default ListRoleAliasesIterable listRoleAliasesPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
This is a variant of
listRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListRoleAliasesIterable responses = client.listRoleAliasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListRoleAliasesIterable responses = client.listRoleAliasesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListRoleAliasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListRoleAliasesIterable responses = client.listRoleAliasesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listRoleAliasesPaginator(ListRoleAliasesRequest)
-
listRoleAliasesPaginator
default ListRoleAliasesIterable listRoleAliasesPaginator(ListRoleAliasesRequest listRoleAliasesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
This is a variant of
listRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListRoleAliasesIterable responses = client.listRoleAliasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListRoleAliasesIterable responses = client.listRoleAliasesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListRoleAliasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListRoleAliasesIterable responses = client.listRoleAliasesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listRoleAliasesPaginator
default ListRoleAliasesIterable listRoleAliasesPaginator(Consumer<ListRoleAliasesRequest.Builder> listRoleAliasesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the role aliases registered in your account.
Requires permission to access the ListRoleAliases action.
This is a variant of
listRoleAliases(software.amazon.awssdk.services.iot.model.ListRoleAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListRoleAliasesIterable responses = client.listRoleAliasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListRoleAliasesIterable responses = client.listRoleAliasesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListRoleAliasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListRoleAliasesIterable responses = client.listRoleAliasesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listScheduledAudits
default ListScheduledAuditsResponse listScheduledAudits(ListScheduledAuditsRequest listScheduledAuditsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
- Parameters:
listScheduledAuditsRequest
-- Returns:
- Result of the ListScheduledAudits operation returned by the service.
- Throws:
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.AwsServiceException
-
listScheduledAudits
default ListScheduledAuditsResponse listScheduledAudits(Consumer<ListScheduledAuditsRequest.Builder> listScheduledAuditsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListScheduledAudits operation returned by the service.
- Throws:
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.AwsServiceException
-
listScheduledAudits
default ListScheduledAuditsResponse listScheduledAudits() throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
- Returns:
- Result of the ListScheduledAudits operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
listScheduledAudits(ListScheduledAuditsRequest)
-
listScheduledAuditsPaginator
default ListScheduledAuditsIterable listScheduledAuditsPaginator() throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
This is a variant of
listScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListScheduledAuditsIterable responses = client.listScheduledAuditsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListScheduledAuditsIterable responses = client .listScheduledAuditsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListScheduledAuditsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListScheduledAuditsIterable responses = client.listScheduledAuditsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
listScheduledAuditsPaginator(ListScheduledAuditsRequest)
-
listScheduledAuditsPaginator
default ListScheduledAuditsIterable listScheduledAuditsPaginator(ListScheduledAuditsRequest listScheduledAuditsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
This is a variant of
listScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListScheduledAuditsIterable responses = client.listScheduledAuditsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListScheduledAuditsIterable responses = client .listScheduledAuditsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListScheduledAuditsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListScheduledAuditsIterable responses = client.listScheduledAuditsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listScheduledAuditsPaginator
default ListScheduledAuditsIterable listScheduledAuditsPaginator(Consumer<ListScheduledAuditsRequest.Builder> listScheduledAuditsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all of your scheduled audits.
Requires permission to access the ListScheduledAudits action.
This is a variant of
listScheduledAudits(software.amazon.awssdk.services.iot.model.ListScheduledAuditsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListScheduledAuditsIterable responses = client.listScheduledAuditsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListScheduledAuditsIterable responses = client .listScheduledAuditsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListScheduledAuditsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListScheduledAuditsIterable responses = client.listScheduledAuditsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listSecurityProfiles
default ListSecurityProfilesResponse listSecurityProfiles(ListSecurityProfilesRequest listSecurityProfilesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListSecurityProfiles operation returned by the service.
- Throws:
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.AwsServiceException
-
listSecurityProfiles
default ListSecurityProfilesResponse listSecurityProfiles(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListSecurityProfiles operation returned by the service.
- Throws:
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.AwsServiceException
-
listSecurityProfiles
default ListSecurityProfilesResponse listSecurityProfiles() throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListSecurityProfiles operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
listSecurityProfiles(ListSecurityProfilesRequest)
-
listSecurityProfilesPaginator
default ListSecurityProfilesIterable listSecurityProfilesPaginator() throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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 variant of
listSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListSecurityProfilesIterable responses = client .listSecurityProfilesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListSecurityProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
listSecurityProfilesPaginator(ListSecurityProfilesRequest)
-
listSecurityProfilesPaginator
default ListSecurityProfilesIterable listSecurityProfilesPaginator(ListSecurityProfilesRequest listSecurityProfilesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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 variant of
listSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListSecurityProfilesIterable responses = client .listSecurityProfilesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListSecurityProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listSecurityProfilesPaginator
default ListSecurityProfilesIterable listSecurityProfilesPaginator(Consumer<ListSecurityProfilesRequest.Builder> listSecurityProfilesRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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 variant of
listSecurityProfiles(software.amazon.awssdk.services.iot.model.ListSecurityProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListSecurityProfilesIterable responses = client .listSecurityProfilesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListSecurityProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesIterable responses = client.listSecurityProfilesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listSecurityProfilesForTarget
default ListSecurityProfilesForTargetResponse listSecurityProfilesForTarget(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
- Parameters:
listSecurityProfilesForTargetRequest
-- Returns:
- Result of the ListSecurityProfilesForTarget operation returned by the service.
- Throws:
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.AwsServiceException
-
listSecurityProfilesForTarget
default ListSecurityProfilesForTargetResponse listSecurityProfilesForTarget(Consumer<ListSecurityProfilesForTargetRequest.Builder> listSecurityProfilesForTargetRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListSecurityProfilesForTarget operation returned by the service.
- Throws:
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.AwsServiceException
-
listSecurityProfilesForTargetPaginator
default ListSecurityProfilesForTargetIterable listSecurityProfilesForTargetPaginator(ListSecurityProfilesForTargetRequest listSecurityProfilesForTargetRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
This is a variant of
listSecurityProfilesForTarget(software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesForTargetIterable responses = client.listSecurityProfilesForTargetPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListSecurityProfilesForTargetIterable responses = client .listSecurityProfilesForTargetPaginator(request); for (software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesForTargetIterable responses = client.listSecurityProfilesForTargetPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listSecurityProfilesForTargetPaginator
default ListSecurityProfilesForTargetIterable listSecurityProfilesForTargetPaginator(Consumer<ListSecurityProfilesForTargetRequest.Builder> listSecurityProfilesForTargetRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Lists the Device Defender security profiles attached to a target (thing group).
Requires permission to access the ListSecurityProfilesForTarget action.
This is a variant of
listSecurityProfilesForTarget(software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesForTargetIterable responses = client.listSecurityProfilesForTargetPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListSecurityProfilesForTargetIterable responses = client .listSecurityProfilesForTargetPaginator(request); for (software.amazon.awssdk.services.iot.model.ListSecurityProfilesForTargetResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListSecurityProfilesForTargetIterable responses = client.listSecurityProfilesForTargetPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listStreams
default ListStreamsResponse listStreams(ListStreamsRequest listStreamsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
- Parameters:
listStreamsRequest
-- Returns:
- Result of the ListStreams operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listStreams
default ListStreamsResponse listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListStreams operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listStreams
default ListStreamsResponse listStreams() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
- Returns:
- Result of the ListStreams operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listStreams(ListStreamsRequest)
-
listStreamsPaginator
default ListStreamsIterable listStreamsPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
This is a variant of
listStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListStreamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listStreamsPaginator(ListStreamsRequest)
-
listStreamsPaginator
default ListStreamsIterable listStreamsPaginator(ListStreamsRequest listStreamsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
This is a variant of
listStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListStreamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listStreamsPaginator
default ListStreamsIterable listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists all of the streams in your Amazon Web Services account.
Requires permission to access the ListStreams action.
This is a variant of
listStreams(software.amazon.awssdk.services.iot.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListStreamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.iot.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.iot.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the tags (metadata) you have assigned to the resource.
Requires permission to access the ListTagsForResource action.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.iot.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.iot.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listTargetsForPolicy
default ListTargetsForPolicyResponse listTargetsForPolicy(ListTargetsForPolicyRequest listTargetsForPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
List targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
- Parameters:
listTargetsForPolicyRequest
-- Returns:
- Result of the ListTargetsForPolicy operation returned by the service.
- Throws:
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.AwsServiceException
-
listTargetsForPolicy
default ListTargetsForPolicyResponse listTargetsForPolicy(Consumer<ListTargetsForPolicyRequest.Builder> listTargetsForPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListTargetsForPolicy operation returned by the service.
- Throws:
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.AwsServiceException
-
listTargetsForPolicyPaginator
default ListTargetsForPolicyIterable listTargetsForPolicyPaginator(ListTargetsForPolicyRequest listTargetsForPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
List targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
This is a variant of
listTargetsForPolicy(software.amazon.awssdk.services.iot.model.ListTargetsForPolicyRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTargetsForPolicyIterable responses = client.listTargetsForPolicyPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTargetsForPolicyIterable responses = client .listTargetsForPolicyPaginator(request); for (software.amazon.awssdk.services.iot.model.ListTargetsForPolicyResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTargetsForPolicyIterable responses = client.listTargetsForPolicyPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listTargetsForPolicyPaginator
default ListTargetsForPolicyIterable listTargetsForPolicyPaginator(Consumer<ListTargetsForPolicyRequest.Builder> listTargetsForPolicyRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
List targets for the specified policy.
Requires permission to access the ListTargetsForPolicy action.
This is a variant of
listTargetsForPolicy(software.amazon.awssdk.services.iot.model.ListTargetsForPolicyRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTargetsForPolicyIterable responses = client.listTargetsForPolicyPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTargetsForPolicyIterable responses = client .listTargetsForPolicyPaginator(request); for (software.amazon.awssdk.services.iot.model.ListTargetsForPolicyResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTargetsForPolicyIterable responses = client.listTargetsForPolicyPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listTargetsForSecurityProfile
default ListTargetsForSecurityProfileResponse listTargetsForSecurityProfile(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
- Parameters:
listTargetsForSecurityProfileRequest
-- Returns:
- Result of the ListTargetsForSecurityProfile operation returned by the service.
- Throws:
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.AwsServiceException
-
listTargetsForSecurityProfile
default ListTargetsForSecurityProfileResponse listTargetsForSecurityProfile(Consumer<ListTargetsForSecurityProfileRequest.Builder> listTargetsForSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListTargetsForSecurityProfile operation returned by the service.
- Throws:
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.AwsServiceException
-
listTargetsForSecurityProfilePaginator
default ListTargetsForSecurityProfileIterable listTargetsForSecurityProfilePaginator(ListTargetsForSecurityProfileRequest listTargetsForSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
This is a variant of
listTargetsForSecurityProfile(software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTargetsForSecurityProfileIterable responses = client.listTargetsForSecurityProfilePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTargetsForSecurityProfileIterable responses = client .listTargetsForSecurityProfilePaginator(request); for (software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTargetsForSecurityProfileIterable responses = client.listTargetsForSecurityProfilePaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listTargetsForSecurityProfilePaginator
default ListTargetsForSecurityProfileIterable listTargetsForSecurityProfilePaginator(Consumer<ListTargetsForSecurityProfileRequest.Builder> listTargetsForSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the targets (thing groups) associated with a given Device Defender security profile.
Requires permission to access the ListTargetsForSecurityProfile action.
This is a variant of
listTargetsForSecurityProfile(software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTargetsForSecurityProfileIterable responses = client.listTargetsForSecurityProfilePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTargetsForSecurityProfileIterable responses = client .listTargetsForSecurityProfilePaginator(request); for (software.amazon.awssdk.services.iot.model.ListTargetsForSecurityProfileResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTargetsForSecurityProfileIterable responses = client.listTargetsForSecurityProfilePaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingGroups
default ListThingGroupsResponse listThingGroups(ListThingGroupsRequest listThingGroupsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the thing groups in your account.
Requires permission to access the ListThingGroups action.
- Parameters:
listThingGroupsRequest
-- Returns:
- Result of the ListThingGroups operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingGroups
default ListThingGroupsResponse listThingGroups(Consumer<ListThingGroupsRequest.Builder> listThingGroupsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThingGroups operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingGroups
default ListThingGroupsResponse listThingGroups() throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the thing groups in your account.
Requires permission to access the ListThingGroups action.
- Returns:
- Result of the ListThingGroups operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
listThingGroups(ListThingGroupsRequest)
-
listThingGroupsPaginator
default ListThingGroupsIterable listThingGroupsPaginator() throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the thing groups in your account.
Requires permission to access the ListThingGroups action.
This is a variant of
listThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsIterable responses = client.listThingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingGroupsIterable responses = client.listThingGroupsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsIterable responses = client.listThingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
listThingGroupsPaginator(ListThingGroupsRequest)
-
listThingGroupsPaginator
default ListThingGroupsIterable listThingGroupsPaginator(ListThingGroupsRequest listThingGroupsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the thing groups in your account.
Requires permission to access the ListThingGroups action.
This is a variant of
listThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsIterable responses = client.listThingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingGroupsIterable responses = client.listThingGroupsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsIterable responses = client.listThingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingGroupsPaginator
default ListThingGroupsIterable listThingGroupsPaginator(Consumer<ListThingGroupsRequest.Builder> listThingGroupsRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the thing groups in your account.
Requires permission to access the ListThingGroups action.
This is a variant of
listThingGroups(software.amazon.awssdk.services.iot.model.ListThingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsIterable responses = client.listThingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingGroupsIterable responses = client.listThingGroupsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsIterable responses = client.listThingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingGroupsForThing
default ListThingGroupsForThingResponse listThingGroupsForThing(ListThingGroupsForThingRequest listThingGroupsForThingRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
- Parameters:
listThingGroupsForThingRequest
-- Returns:
- Result of the ListThingGroupsForThing operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingGroupsForThing
default ListThingGroupsForThingResponse listThingGroupsForThing(Consumer<ListThingGroupsForThingRequest.Builder> listThingGroupsForThingRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThingGroupsForThing operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingGroupsForThingPaginator
default ListThingGroupsForThingIterable listThingGroupsForThingPaginator(ListThingGroupsForThingRequest listThingGroupsForThingRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
This is a variant of
listThingGroupsForThing(software.amazon.awssdk.services.iot.model.ListThingGroupsForThingRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsForThingIterable responses = client.listThingGroupsForThingPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingGroupsForThingIterable responses = client .listThingGroupsForThingPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingGroupsForThingResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsForThingIterable responses = client.listThingGroupsForThingPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingGroupsForThingPaginator
default ListThingGroupsForThingIterable listThingGroupsForThingPaginator(Consumer<ListThingGroupsForThingRequest.Builder> listThingGroupsForThingRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
List the thing groups to which the specified thing belongs.
Requires permission to access the ListThingGroupsForThing action.
This is a variant of
listThingGroupsForThing(software.amazon.awssdk.services.iot.model.ListThingGroupsForThingRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsForThingIterable responses = client.listThingGroupsForThingPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingGroupsForThingIterable responses = client .listThingGroupsForThingPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingGroupsForThingResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingGroupsForThingIterable responses = client.listThingGroupsForThingPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingPrincipals
default ListThingPrincipalsResponse listThingPrincipals(ListThingPrincipalsRequest listThingPrincipalsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThingPrincipals operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThingPrincipals
default ListThingPrincipalsResponse listThingPrincipals(Consumer<ListThingPrincipalsRequest.Builder> listThingPrincipalsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThingPrincipals operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThingPrincipalsPaginator
default ListThingPrincipalsIterable listThingPrincipalsPaginator(ListThingPrincipalsRequest listThingPrincipalsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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 variant of
listThingPrincipals(software.amazon.awssdk.services.iot.model.ListThingPrincipalsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingPrincipalsIterable responses = client.listThingPrincipalsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingPrincipalsIterable responses = client .listThingPrincipalsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingPrincipalsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingPrincipalsIterable responses = client.listThingPrincipalsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThingPrincipalsPaginator
default ListThingPrincipalsIterable listThingPrincipalsPaginator(Consumer<ListThingPrincipalsRequest.Builder> listThingPrincipalsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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 variant of
listThingPrincipals(software.amazon.awssdk.services.iot.model.ListThingPrincipalsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingPrincipalsIterable responses = client.listThingPrincipalsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingPrincipalsIterable responses = client .listThingPrincipalsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingPrincipalsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingPrincipalsIterable responses = client.listThingPrincipalsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThingRegistrationTaskReports
default ListThingRegistrationTaskReportsResponse listThingRegistrationTaskReports(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Information about the thing registration tasks.
- Parameters:
listThingRegistrationTaskReportsRequest
-- Returns:
- Result of the ListThingRegistrationTaskReports operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingRegistrationTaskReports
default ListThingRegistrationTaskReportsResponse listThingRegistrationTaskReports(Consumer<ListThingRegistrationTaskReportsRequest.Builder> listThingRegistrationTaskReportsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThingRegistrationTaskReports operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingRegistrationTaskReportsPaginator
default ListThingRegistrationTaskReportsIterable listThingRegistrationTaskReportsPaginator(ListThingRegistrationTaskReportsRequest listThingRegistrationTaskReportsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Information about the thing registration tasks.
This is a variant of
listThingRegistrationTaskReports(software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTaskReportsIterable responses = client.listThingRegistrationTaskReportsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingRegistrationTaskReportsIterable responses = client .listThingRegistrationTaskReportsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTaskReportsIterable responses = client.listThingRegistrationTaskReportsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingRegistrationTaskReportsPaginator
default ListThingRegistrationTaskReportsIterable listThingRegistrationTaskReportsPaginator(Consumer<ListThingRegistrationTaskReportsRequest.Builder> listThingRegistrationTaskReportsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Information about the thing registration tasks.
This is a variant of
listThingRegistrationTaskReports(software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTaskReportsIterable responses = client.listThingRegistrationTaskReportsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingRegistrationTaskReportsIterable responses = client .listThingRegistrationTaskReportsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingRegistrationTaskReportsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTaskReportsIterable responses = client.listThingRegistrationTaskReportsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingRegistrationTasks
default ListThingRegistrationTasksResponse listThingRegistrationTasks(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
- Parameters:
listThingRegistrationTasksRequest
-- Returns:
- Result of the ListThingRegistrationTasks operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingRegistrationTasks
default ListThingRegistrationTasksResponse listThingRegistrationTasks(Consumer<ListThingRegistrationTasksRequest.Builder> listThingRegistrationTasksRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThingRegistrationTasks operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingRegistrationTasks
default ListThingRegistrationTasksResponse listThingRegistrationTasks() throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
- Returns:
- Result of the ListThingRegistrationTasks operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
listThingRegistrationTasks(ListThingRegistrationTasksRequest)
-
listThingRegistrationTasksPaginator
default ListThingRegistrationTasksIterable listThingRegistrationTasksPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
This is a variant of
listThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksIterable responses = client.listThingRegistrationTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksIterable responses = client .listThingRegistrationTasksPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksIterable responses = client.listThingRegistrationTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
listThingRegistrationTasksPaginator(ListThingRegistrationTasksRequest)
-
listThingRegistrationTasksPaginator
default ListThingRegistrationTasksIterable listThingRegistrationTasksPaginator(ListThingRegistrationTasksRequest listThingRegistrationTasksRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
This is a variant of
listThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksIterable responses = client.listThingRegistrationTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksIterable responses = client .listThingRegistrationTasksPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksIterable responses = client.listThingRegistrationTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingRegistrationTasksPaginator
default ListThingRegistrationTasksIterable listThingRegistrationTasksPaginator(Consumer<ListThingRegistrationTasksRequest.Builder> listThingRegistrationTasksRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
List bulk thing provisioning tasks.
Requires permission to access the ListThingRegistrationTasks action.
This is a variant of
listThingRegistrationTasks(software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksIterable responses = client.listThingRegistrationTasksPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksIterable responses = client .listThingRegistrationTasksPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingRegistrationTasksResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingRegistrationTasksIterable responses = client.listThingRegistrationTasksPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingTypes
default ListThingTypesResponse listThingTypes(ListThingTypesRequest listThingTypesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the existing thing types.
Requires permission to access the ListThingTypes action.
- Parameters:
listThingTypesRequest
- The input for the ListThingTypes operation.- Returns:
- Result of the ListThingTypes operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThingTypes
default ListThingTypesResponse listThingTypes(Consumer<ListThingTypesRequest.Builder> listThingTypesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThingTypes operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThingTypes
default ListThingTypesResponse listThingTypes() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the existing thing types.
Requires permission to access the ListThingTypes action.
- Returns:
- Result of the ListThingTypes operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listThingTypes(ListThingTypesRequest)
-
listThingTypesPaginator
default ListThingTypesIterable listThingTypesPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the existing thing types.
Requires permission to access the ListThingTypes action.
This is a variant of
listThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingTypesIterable responses = client.listThingTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingTypesIterable responses = client.listThingTypesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingTypesIterable responses = client.listThingTypesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listThingTypesPaginator(ListThingTypesRequest)
-
listThingTypesPaginator
default ListThingTypesIterable listThingTypesPaginator(ListThingTypesRequest listThingTypesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the existing thing types.
Requires permission to access the ListThingTypes action.
This is a variant of
listThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingTypesIterable responses = client.listThingTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingTypesIterable responses = client.listThingTypesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingTypesIterable responses = client.listThingTypesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThingTypesPaginator
default ListThingTypesIterable listThingTypesPaginator(Consumer<ListThingTypesRequest.Builder> listThingTypesRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Lists the existing thing types.
Requires permission to access the ListThingTypes action.
This is a variant of
listThingTypes(software.amazon.awssdk.services.iot.model.ListThingTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingTypesIterable responses = client.listThingTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingTypesIterable responses = client.listThingTypesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingTypesIterable responses = client.listThingTypesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThings
default ListThingsResponse listThings(ListThingsRequest listThingsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThings operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThings
default ListThingsResponse listThings(Consumer<ListThingsRequest.Builder> listThingsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThings operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThings
default ListThingsResponse listThings() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThings operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listThings(ListThingsRequest)
-
listThingsPaginator
default ListThingsIterable listThingsPaginator() throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingsIterable responses = client.listThingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingsIterable responses = client.listThingsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingsIterable responses = client.listThingsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
- See Also:
listThingsPaginator(ListThingsRequest)
-
listThingsPaginator
default ListThingsIterable listThingsPaginator(ListThingsRequest listThingsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingsIterable responses = client.listThingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingsIterable responses = client.listThingsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingsIterable responses = client.listThingsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThingsPaginator
default ListThingsIterable listThingsPaginator(Consumer<ListThingsRequest.Builder> listThingsRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listThings(software.amazon.awssdk.services.iot.model.ListThingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingsIterable responses = client.listThingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingsIterable responses = client.listThingsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingsIterable responses = client.listThingsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
listThingsInBillingGroup
default ListThingsInBillingGroupResponse listThingsInBillingGroup(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
- Parameters:
listThingsInBillingGroupRequest
-- Returns:
- Result of the ListThingsInBillingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingsInBillingGroup
default ListThingsInBillingGroupResponse listThingsInBillingGroup(Consumer<ListThingsInBillingGroupRequest.Builder> listThingsInBillingGroupRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThingsInBillingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingsInBillingGroupPaginator
default ListThingsInBillingGroupIterable listThingsInBillingGroupPaginator(ListThingsInBillingGroupRequest listThingsInBillingGroupRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
This is a variant of
listThingsInBillingGroup(software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingsInBillingGroupIterable responses = client.listThingsInBillingGroupPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingsInBillingGroupIterable responses = client .listThingsInBillingGroupPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingsInBillingGroupIterable responses = client.listThingsInBillingGroupPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingsInBillingGroupPaginator
default ListThingsInBillingGroupIterable listThingsInBillingGroupPaginator(Consumer<ListThingsInBillingGroupRequest.Builder> listThingsInBillingGroupRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the things you have added to the given billing group.
Requires permission to access the ListThingsInBillingGroup action.
This is a variant of
listThingsInBillingGroup(software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingsInBillingGroupIterable responses = client.listThingsInBillingGroupPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingsInBillingGroupIterable responses = client .listThingsInBillingGroupPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingsInBillingGroupResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingsInBillingGroupIterable responses = client.listThingsInBillingGroupPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingsInThingGroup
default ListThingsInThingGroupResponse listThingsInThingGroup(ListThingsInThingGroupRequest listThingsInThingGroupRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
- Parameters:
listThingsInThingGroupRequest
-- Returns:
- Result of the ListThingsInThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingsInThingGroup
default ListThingsInThingGroupResponse listThingsInThingGroup(Consumer<ListThingsInThingGroupRequest.Builder> listThingsInThingGroupRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListThingsInThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
listThingsInThingGroupPaginator
default ListThingsInThingGroupIterable listThingsInThingGroupPaginator(ListThingsInThingGroupRequest listThingsInThingGroupRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
This is a variant of
listThingsInThingGroup(software.amazon.awssdk.services.iot.model.ListThingsInThingGroupRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingsInThingGroupIterable responses = client.listThingsInThingGroupPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingsInThingGroupIterable responses = client .listThingsInThingGroupPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingsInThingGroupResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingsInThingGroupIterable responses = client.listThingsInThingGroupPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listThingsInThingGroupPaginator
default ListThingsInThingGroupIterable listThingsInThingGroupPaginator(Consumer<ListThingsInThingGroupRequest.Builder> listThingsInThingGroupRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Lists the things in the specified group.
Requires permission to access the ListThingsInThingGroup action.
This is a variant of
listThingsInThingGroup(software.amazon.awssdk.services.iot.model.ListThingsInThingGroupRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListThingsInThingGroupIterable responses = client.listThingsInThingGroupPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListThingsInThingGroupIterable responses = client .listThingsInThingGroupPaginator(request); for (software.amazon.awssdk.services.iot.model.ListThingsInThingGroupResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListThingsInThingGroupIterable responses = client.listThingsInThingGroupPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listTopicRuleDestinations
default ListTopicRuleDestinationsResponse listTopicRuleDestinations(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
- Parameters:
listTopicRuleDestinationsRequest
-- Returns:
- Result of the ListTopicRuleDestinations operation returned by the service.
- Throws:
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.AwsServiceException
-
listTopicRuleDestinations
default ListTopicRuleDestinationsResponse listTopicRuleDestinations(Consumer<ListTopicRuleDestinationsRequest.Builder> listTopicRuleDestinationsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListTopicRuleDestinations operation returned by the service.
- Throws:
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.AwsServiceException
-
listTopicRuleDestinationsPaginator
default ListTopicRuleDestinationsIterable listTopicRuleDestinationsPaginator(ListTopicRuleDestinationsRequest listTopicRuleDestinationsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
This is a variant of
listTopicRuleDestinations(software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTopicRuleDestinationsIterable responses = client.listTopicRuleDestinationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTopicRuleDestinationsIterable responses = client .listTopicRuleDestinationsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTopicRuleDestinationsIterable responses = client.listTopicRuleDestinationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listTopicRuleDestinationsPaginator
default ListTopicRuleDestinationsIterable listTopicRuleDestinationsPaginator(Consumer<ListTopicRuleDestinationsRequest.Builder> listTopicRuleDestinationsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, AwsServiceException, SdkClientException, IotException
Lists all the topic rule destinations in your Amazon Web Services account.
Requires permission to access the ListTopicRuleDestinations action.
This is a variant of
listTopicRuleDestinations(software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTopicRuleDestinationsIterable responses = client.listTopicRuleDestinationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTopicRuleDestinationsIterable responses = client .listTopicRuleDestinationsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListTopicRuleDestinationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTopicRuleDestinationsIterable responses = client.listTopicRuleDestinationsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listTopicRules
default ListTopicRulesResponse listTopicRules(ListTopicRulesRequest listTopicRulesRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
- Parameters:
listTopicRulesRequest
- The input for the ListTopicRules operation.- Returns:
- Result of the ListTopicRules operation returned by the service.
- Throws:
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.AwsServiceException
-
listTopicRules
default ListTopicRulesResponse listTopicRules(Consumer<ListTopicRulesRequest.Builder> listTopicRulesRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListTopicRules operation returned by the service.
- Throws:
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.AwsServiceException
-
listTopicRules
default ListTopicRulesResponse listTopicRules() throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
- Returns:
- Result of the ListTopicRules operation returned by the service.
- Throws:
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.AwsServiceException
- See Also:
listTopicRules(ListTopicRulesRequest)
-
listTopicRulesPaginator
default ListTopicRulesIterable listTopicRulesPaginator() throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
This is a variant of
listTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTopicRulesIterable responses = client.listTopicRulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTopicRulesIterable responses = client.listTopicRulesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListTopicRulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTopicRulesIterable responses = client.listTopicRulesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
- See Also:
listTopicRulesPaginator(ListTopicRulesRequest)
-
listTopicRulesPaginator
default ListTopicRulesIterable listTopicRulesPaginator(ListTopicRulesRequest listTopicRulesRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
This is a variant of
listTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTopicRulesIterable responses = client.listTopicRulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTopicRulesIterable responses = client.listTopicRulesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListTopicRulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTopicRulesIterable responses = client.listTopicRulesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listTopicRulesPaginator
default ListTopicRulesIterable listTopicRulesPaginator(Consumer<ListTopicRulesRequest.Builder> listTopicRulesRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists the rules for the specific topic.
Requires permission to access the ListTopicRules action.
This is a variant of
listTopicRules(software.amazon.awssdk.services.iot.model.ListTopicRulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListTopicRulesIterable responses = client.listTopicRulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListTopicRulesIterable responses = client.listTopicRulesPaginator(request); for (software.amazon.awssdk.services.iot.model.ListTopicRulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListTopicRulesIterable responses = client.listTopicRulesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listV2LoggingLevels
default ListV2LoggingLevelsResponse listV2LoggingLevels(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest) throws InternalException, NotConfiguredException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.
- Parameters:
listV2LoggingLevelsRequest
-- Returns:
- Result of the ListV2LoggingLevels operation returned by the service.
- Throws:
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.AwsServiceException
-
listV2LoggingLevels
default ListV2LoggingLevelsResponse listV2LoggingLevels(Consumer<ListV2LoggingLevelsRequest.Builder> listV2LoggingLevelsRequest) throws InternalException, NotConfiguredException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListV2LoggingLevels operation returned by the service.
- Throws:
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.AwsServiceException
-
listV2LoggingLevelsPaginator
default ListV2LoggingLevelsIterable listV2LoggingLevelsPaginator(ListV2LoggingLevelsRequest listV2LoggingLevelsRequest) throws InternalException, NotConfiguredException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.
This is a variant of
listV2LoggingLevels(software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListV2LoggingLevelsIterable responses = client.listV2LoggingLevelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListV2LoggingLevelsIterable responses = client .listV2LoggingLevelsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListV2LoggingLevelsIterable responses = client.listV2LoggingLevelsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listV2LoggingLevelsPaginator
default ListV2LoggingLevelsIterable listV2LoggingLevelsPaginator(Consumer<ListV2LoggingLevelsRequest.Builder> listV2LoggingLevelsRequest) throws InternalException, NotConfiguredException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Lists logging levels.
Requires permission to access the ListV2LoggingLevels action.
This is a variant of
listV2LoggingLevels(software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListV2LoggingLevelsIterable responses = client.listV2LoggingLevelsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListV2LoggingLevelsIterable responses = client .listV2LoggingLevelsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListV2LoggingLevelsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListV2LoggingLevelsIterable responses = client.listV2LoggingLevelsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listViolationEvents
default ListViolationEventsResponse listViolationEvents(ListViolationEventsRequest listViolationEventsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListViolationEvents operation returned by the service.
- Throws:
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.AwsServiceException
-
listViolationEvents
default ListViolationEventsResponse listViolationEvents(Consumer<ListViolationEventsRequest.Builder> listViolationEventsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ListViolationEvents operation returned by the service.
- Throws:
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.AwsServiceException
-
listViolationEventsPaginator
default ListViolationEventsIterable listViolationEventsPaginator(ListViolationEventsRequest listViolationEventsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listViolationEvents(software.amazon.awssdk.services.iot.model.ListViolationEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListViolationEventsIterable responses = client.listViolationEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListViolationEventsIterable responses = client .listViolationEventsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListViolationEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListViolationEventsIterable responses = client.listViolationEventsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listViolationEventsPaginator
default ListViolationEventsIterable listViolationEventsPaginator(Consumer<ListViolationEventsRequest.Builder> listViolationEventsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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 variant of
listViolationEvents(software.amazon.awssdk.services.iot.model.ListViolationEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.iot.paginators.ListViolationEventsIterable responses = client.listViolationEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.iot.paginators.ListViolationEventsIterable responses = client .listViolationEventsPaginator(request); for (software.amazon.awssdk.services.iot.model.ListViolationEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.iot.paginators.ListViolationEventsIterable responses = client.listViolationEventsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
putVerificationStateOnViolation
default PutVerificationStateOnViolationResponse putVerificationStateOnViolation(PutVerificationStateOnViolationRequest putVerificationStateOnViolationRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Set a verification state and provide a description of that verification state on a violation (detect alarm).
- Parameters:
putVerificationStateOnViolationRequest
-- Returns:
- Result of the PutVerificationStateOnViolation operation returned by the service.
- Throws:
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.AwsServiceException
-
putVerificationStateOnViolation
default PutVerificationStateOnViolationResponse putVerificationStateOnViolation(Consumer<PutVerificationStateOnViolationRequest.Builder> putVerificationStateOnViolationRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the PutVerificationStateOnViolation operation returned by the service.
- Throws:
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.AwsServiceException
-
registerCACertificate
default RegisterCaCertificateResponse registerCACertificate(RegisterCaCertificateRequest registerCaCertificateRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, RegistrationCodeValidationException, InvalidRequestException, CertificateValidationException, ThrottlingException, LimitExceededException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RegisterCACertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
registerCACertificate
default RegisterCaCertificateResponse registerCACertificate(Consumer<RegisterCaCertificateRequest.Builder> registerCaCertificateRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, RegistrationCodeValidationException, InvalidRequestException, CertificateValidationException, ThrottlingException, LimitExceededException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RegisterCACertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
registerCertificate
default RegisterCertificateResponse registerCertificate(RegisterCertificateRequest registerCertificateRequest) throws ResourceAlreadyExistsException, InvalidRequestException, CertificateValidationException, CertificateStateException, CertificateConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RegisterCertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
registerCertificate
default RegisterCertificateResponse registerCertificate(Consumer<RegisterCertificateRequest.Builder> registerCertificateRequest) throws ResourceAlreadyExistsException, InvalidRequestException, CertificateValidationException, CertificateStateException, CertificateConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RegisterCertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
registerCertificateWithoutCA
default RegisterCertificateWithoutCaResponse registerCertificateWithoutCA(RegisterCertificateWithoutCaRequest registerCertificateWithoutCaRequest) throws ResourceAlreadyExistsException, InvalidRequestException, CertificateStateException, CertificateValidationException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.
- Parameters:
registerCertificateWithoutCaRequest
-- Returns:
- Result of the RegisterCertificateWithoutCA operation returned by the service.
- Throws:
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.AwsServiceException
-
registerCertificateWithoutCA
default RegisterCertificateWithoutCaResponse registerCertificateWithoutCA(Consumer<RegisterCertificateWithoutCaRequest.Builder> registerCertificateWithoutCaRequest) throws ResourceAlreadyExistsException, InvalidRequestException, CertificateStateException, CertificateValidationException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RegisterCertificateWithoutCA operation returned by the service.
- Throws:
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.AwsServiceException
-
registerThing
default RegisterThingResponse registerThing(RegisterThingRequest registerThingRequest) throws InternalFailureException, ServiceUnavailableException, InvalidRequestException, UnauthorizedException, ThrottlingException, ConflictingResourceUpdateException, ResourceRegistrationFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RegisterThing operation returned by the service.
- Throws:
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.AwsServiceException
-
registerThing
default RegisterThingResponse registerThing(Consumer<RegisterThingRequest.Builder> registerThingRequest) throws InternalFailureException, ServiceUnavailableException, InvalidRequestException, UnauthorizedException, ThrottlingException, ConflictingResourceUpdateException, ResourceRegistrationFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RegisterThing operation returned by the service.
- Throws:
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.AwsServiceException
-
rejectCertificateTransfer
default RejectCertificateTransferResponse rejectCertificateTransfer(RejectCertificateTransferRequest rejectCertificateTransferRequest) throws ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RejectCertificateTransfer operation returned by the service.
- Throws:
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.AwsServiceException
-
rejectCertificateTransfer
default RejectCertificateTransferResponse rejectCertificateTransfer(Consumer<RejectCertificateTransferRequest.Builder> rejectCertificateTransferRequest) throws ResourceNotFoundException, TransferAlreadyCompletedException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RejectCertificateTransfer operation returned by the service.
- Throws:
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.AwsServiceException
-
removeThingFromBillingGroup
default RemoveThingFromBillingGroupResponse removeThingFromBillingGroup(RemoveThingFromBillingGroupRequest removeThingFromBillingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RemoveThingFromBillingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
removeThingFromBillingGroup
default RemoveThingFromBillingGroupResponse removeThingFromBillingGroup(Consumer<RemoveThingFromBillingGroupRequest.Builder> removeThingFromBillingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RemoveThingFromBillingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
removeThingFromThingGroup
default RemoveThingFromThingGroupResponse removeThingFromThingGroup(RemoveThingFromThingGroupRequest removeThingFromThingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RemoveThingFromThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
removeThingFromThingGroup
default RemoveThingFromThingGroupResponse removeThingFromThingGroup(Consumer<RemoveThingFromThingGroupRequest.Builder> removeThingFromThingGroupRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the RemoveThingFromThingGroup operation returned by the service.
- Throws:
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.AwsServiceException
-
replaceTopicRule
default ReplaceTopicRuleResponse replaceTopicRule(ReplaceTopicRuleRequest replaceTopicRuleRequest) throws SqlParseException, InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ReplaceTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
replaceTopicRule
default ReplaceTopicRuleResponse replaceTopicRule(Consumer<ReplaceTopicRuleRequest.Builder> replaceTopicRuleRequest) throws SqlParseException, InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ReplaceTopicRule operation returned by the service.
- Throws:
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.AwsServiceException
-
searchIndex
default SearchIndexResponse searchIndex(SearchIndexRequest searchIndexRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
The query search index.
Requires permission to access the SearchIndex action.
- Parameters:
searchIndexRequest
-- Returns:
- Result of the SearchIndex operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
searchIndex
default SearchIndexResponse searchIndex(Consumer<SearchIndexRequest.Builder> searchIndexRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
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:
- Result of the SearchIndex operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
setDefaultAuthorizer
default SetDefaultAuthorizerResponse setDefaultAuthorizer(SetDefaultAuthorizerRequest setDefaultAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, IotException
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:
- Result of the SetDefaultAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
setDefaultAuthorizer
default SetDefaultAuthorizerResponse setDefaultAuthorizer(Consumer<SetDefaultAuthorizerRequest.Builder> setDefaultAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, IotException
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:
- Result of the SetDefaultAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
setDefaultPolicyVersion
default SetDefaultPolicyVersionResponse setDefaultPolicyVersion(SetDefaultPolicyVersionRequest setDefaultPolicyVersionRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the SetDefaultPolicyVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
setDefaultPolicyVersion
default SetDefaultPolicyVersionResponse setDefaultPolicyVersion(Consumer<SetDefaultPolicyVersionRequest.Builder> setDefaultPolicyVersionRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the SetDefaultPolicyVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
setLoggingOptions
default SetLoggingOptionsResponse setLoggingOptions(SetLoggingOptionsRequest setLoggingOptionsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the SetLoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException
-
setLoggingOptions
default SetLoggingOptionsResponse setLoggingOptions(Consumer<SetLoggingOptionsRequest.Builder> setLoggingOptionsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the SetLoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException
-
setV2LoggingLevel
default SetV2LoggingLevelResponse setV2LoggingLevel(SetV2LoggingLevelRequest setV2LoggingLevelRequest) throws InternalException, NotConfiguredException, InvalidRequestException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, IotException
Sets the logging level.
Requires permission to access the SetV2LoggingLevel action.
- Parameters:
setV2LoggingLevelRequest
-- Returns:
- Result of the SetV2LoggingLevel operation returned by the service.
- Throws:
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.AwsServiceException
-
setV2LoggingLevel
default SetV2LoggingLevelResponse setV2LoggingLevel(Consumer<SetV2LoggingLevelRequest.Builder> setV2LoggingLevelRequest) throws InternalException, NotConfiguredException, InvalidRequestException, ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the SetV2LoggingLevel operation returned by the service.
- Throws:
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.AwsServiceException
-
setV2LoggingOptions
default SetV2LoggingOptionsResponse setV2LoggingOptions(SetV2LoggingOptionsRequest setV2LoggingOptionsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Sets the logging options for the V2 logging service.
Requires permission to access the SetV2LoggingOptions action.
- Parameters:
setV2LoggingOptionsRequest
-- Returns:
- Result of the SetV2LoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException
-
setV2LoggingOptions
default SetV2LoggingOptionsResponse setV2LoggingOptions(Consumer<SetV2LoggingOptionsRequest.Builder> setV2LoggingOptionsRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the SetV2LoggingOptions operation returned by the service.
- Throws:
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.AwsServiceException
-
startAuditMitigationActionsTask
default StartAuditMitigationActionsTaskResponse startAuditMitigationActionsTask(StartAuditMitigationActionsTaskRequest startAuditMitigationActionsTaskRequest) throws InvalidRequestException, TaskAlreadyExistsException, LimitExceededException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Starts a task that applies a set of mitigation actions to the specified target.
Requires permission to access the StartAuditMitigationActionsTask action.
- Parameters:
startAuditMitigationActionsTaskRequest
-- Returns:
- Result of the StartAuditMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
startAuditMitigationActionsTask
default StartAuditMitigationActionsTaskResponse startAuditMitigationActionsTask(Consumer<StartAuditMitigationActionsTaskRequest.Builder> startAuditMitigationActionsTaskRequest) throws InvalidRequestException, TaskAlreadyExistsException, LimitExceededException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the StartAuditMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
startDetectMitigationActionsTask
default StartDetectMitigationActionsTaskResponse startDetectMitigationActionsTask(StartDetectMitigationActionsTaskRequest startDetectMitigationActionsTaskRequest) throws InvalidRequestException, TaskAlreadyExistsException, LimitExceededException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Starts a Device Defender ML Detect mitigation actions task.
Requires permission to access the StartDetectMitigationActionsTask action.
- Parameters:
startDetectMitigationActionsTaskRequest
-- Returns:
- Result of the StartDetectMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
startDetectMitigationActionsTask
default StartDetectMitigationActionsTaskResponse startDetectMitigationActionsTask(Consumer<StartDetectMitigationActionsTaskRequest.Builder> startDetectMitigationActionsTaskRequest) throws InvalidRequestException, TaskAlreadyExistsException, LimitExceededException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the StartDetectMitigationActionsTask operation returned by the service.
- Throws:
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.AwsServiceException
-
startOnDemandAuditTask
default StartOnDemandAuditTaskResponse startOnDemandAuditTask(StartOnDemandAuditTaskRequest startOnDemandAuditTaskRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
Starts an on-demand Device Defender audit.
Requires permission to access the StartOnDemandAuditTask action.
- Parameters:
startOnDemandAuditTaskRequest
-- Returns:
- Result of the StartOnDemandAuditTask operation returned by the service.
- Throws:
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.AwsServiceException
-
startOnDemandAuditTask
default StartOnDemandAuditTaskResponse startOnDemandAuditTask(Consumer<StartOnDemandAuditTaskRequest.Builder> startOnDemandAuditTaskRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the StartOnDemandAuditTask operation returned by the service.
- Throws:
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.AwsServiceException
-
startThingRegistrationTask
default StartThingRegistrationTaskResponse startThingRegistrationTask(StartThingRegistrationTaskRequest startThingRegistrationTaskRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Creates a bulk thing provisioning task.
Requires permission to access the StartThingRegistrationTask action.
- Parameters:
startThingRegistrationTaskRequest
-- Returns:
- Result of the StartThingRegistrationTask operation returned by the service.
- Throws:
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.AwsServiceException
-
startThingRegistrationTask
default StartThingRegistrationTaskResponse startThingRegistrationTask(Consumer<StartThingRegistrationTaskRequest.Builder> startThingRegistrationTaskRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the StartThingRegistrationTask operation returned by the service.
- Throws:
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.AwsServiceException
-
stopThingRegistrationTask
default StopThingRegistrationTaskResponse stopThingRegistrationTask(StopThingRegistrationTaskRequest stopThingRegistrationTaskRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Cancels a bulk thing provisioning task.
Requires permission to access the StopThingRegistrationTask action.
- Parameters:
stopThingRegistrationTaskRequest
-- Returns:
- Result of the StopThingRegistrationTask operation returned by the service.
- Throws:
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.AwsServiceException
-
stopThingRegistrationTask
default StopThingRegistrationTaskResponse stopThingRegistrationTask(Consumer<StopThingRegistrationTaskRequest.Builder> stopThingRegistrationTaskRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the StopThingRegistrationTask operation returned by the service.
- Throws:
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.AwsServiceException
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException
-
testAuthorization
default TestAuthorizationResponse testAuthorization(TestAuthorizationRequest testAuthorizationRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the TestAuthorization operation returned by the service.
- Throws:
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.AwsServiceException
-
testAuthorization
default TestAuthorizationResponse testAuthorization(Consumer<TestAuthorizationRequest.Builder> testAuthorizationRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, IotException
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:
- Result of the TestAuthorization operation returned by the service.
- Throws:
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.AwsServiceException
-
testInvokeAuthorizer
default TestInvokeAuthorizerResponse testInvokeAuthorizer(TestInvokeAuthorizerRequest testInvokeAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, InvalidResponseException, AwsServiceException, SdkClientException, IotException
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:
- Result of the TestInvokeAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
testInvokeAuthorizer
default TestInvokeAuthorizerResponse testInvokeAuthorizer(Consumer<TestInvokeAuthorizerRequest.Builder> testInvokeAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, InvalidResponseException, AwsServiceException, SdkClientException, IotException
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:
- Result of the TestInvokeAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
transferCertificate
default TransferCertificateResponse transferCertificate(TransferCertificateRequest transferCertificateRequest) throws InvalidRequestException, ResourceNotFoundException, CertificateStateException, TransferConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the TransferCertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
transferCertificate
default TransferCertificateResponse transferCertificate(Consumer<TransferCertificateRequest.Builder> transferCertificateRequest) throws InvalidRequestException, ResourceNotFoundException, CertificateStateException, TransferConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the TransferCertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Removes the given tags (metadata) from the resource.
Requires permission to access the UntagResource action.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidRequestException, InternalFailureException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException
-
updateAccountAuditConfiguration
default UpdateAccountAuditConfigurationResponse updateAccountAuditConfiguration(UpdateAccountAuditConfigurationRequest updateAccountAuditConfigurationRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateAccountAuditConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
updateAccountAuditConfiguration
default UpdateAccountAuditConfigurationResponse updateAccountAuditConfiguration(Consumer<UpdateAccountAuditConfigurationRequest.Builder> updateAccountAuditConfigurationRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateAccountAuditConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
updateAuditSuppression
default UpdateAuditSuppressionResponse updateAuditSuppression(UpdateAuditSuppressionRequest updateAuditSuppressionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Updates a Device Defender audit suppression.
- Parameters:
updateAuditSuppressionRequest
-- Returns:
- Result of the UpdateAuditSuppression operation returned by the service.
- Throws:
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.AwsServiceException
-
updateAuditSuppression
default UpdateAuditSuppressionResponse updateAuditSuppression(Consumer<UpdateAuditSuppressionRequest.Builder> updateAuditSuppressionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateAuditSuppression operation returned by the service.
- Throws:
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.AwsServiceException
-
updateAuthorizer
default UpdateAuthorizerResponse updateAuthorizer(UpdateAuthorizerRequest updateAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, LimitExceededException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Updates an authorizer.
Requires permission to access the UpdateAuthorizer action.
- Parameters:
updateAuthorizerRequest
-- Returns:
- Result of the UpdateAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
updateAuthorizer
default UpdateAuthorizerResponse updateAuthorizer(Consumer<UpdateAuthorizerRequest.Builder> updateAuthorizerRequest) throws ResourceNotFoundException, InvalidRequestException, LimitExceededException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateAuthorizer operation returned by the service.
- Throws:
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.AwsServiceException
-
updateBillingGroup
default UpdateBillingGroupResponse updateBillingGroup(UpdateBillingGroupRequest updateBillingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Updates information about the billing group.
Requires permission to access the UpdateBillingGroup action.
- Parameters:
updateBillingGroupRequest
-- Returns:
- Result of the UpdateBillingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
updateBillingGroup
default UpdateBillingGroupResponse updateBillingGroup(Consumer<UpdateBillingGroupRequest.Builder> updateBillingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateBillingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
updateCACertificate
default UpdateCaCertificateResponse updateCACertificate(UpdateCaCertificateRequest updateCaCertificateRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Updates a registered CA certificate.
Requires permission to access the UpdateCACertificate action.
- Parameters:
updateCaCertificateRequest
- The input to the UpdateCACertificate operation.- Returns:
- Result of the UpdateCACertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
updateCACertificate
default UpdateCaCertificateResponse updateCACertificate(Consumer<UpdateCaCertificateRequest.Builder> updateCaCertificateRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateCACertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
updateCertificate
default UpdateCertificateResponse updateCertificate(UpdateCertificateRequest updateCertificateRequest) throws ResourceNotFoundException, CertificateStateException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateCertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
updateCertificate
default UpdateCertificateResponse updateCertificate(Consumer<UpdateCertificateRequest.Builder> updateCertificateRequest) throws ResourceNotFoundException, CertificateStateException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateCertificate operation returned by the service.
- Throws:
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.AwsServiceException
-
updateCustomMetric
default UpdateCustomMetricResponse updateCustomMetric(UpdateCustomMetricRequest updateCustomMetricRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Updates a Device Defender detect custom metric.
Requires permission to access the UpdateCustomMetric action.
- Parameters:
updateCustomMetricRequest
-- Returns:
- Result of the UpdateCustomMetric operation returned by the service.
- Throws:
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.AwsServiceException
-
updateCustomMetric
default UpdateCustomMetricResponse updateCustomMetric(Consumer<UpdateCustomMetricRequest.Builder> updateCustomMetricRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateCustomMetric operation returned by the service.
- Throws:
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.AwsServiceException
-
updateDimension
default UpdateDimensionResponse updateDimension(UpdateDimensionRequest updateDimensionRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateDimension operation returned by the service.
- Throws:
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.AwsServiceException
-
updateDimension
default UpdateDimensionResponse updateDimension(Consumer<UpdateDimensionRequest.Builder> updateDimensionRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateDimension operation returned by the service.
- Throws:
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.AwsServiceException
-
updateDomainConfiguration
default UpdateDomainConfigurationResponse updateDomainConfiguration(UpdateDomainConfigurationRequest updateDomainConfigurationRequest) throws ResourceNotFoundException, CertificateValidationException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateDomainConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
updateDomainConfiguration
default UpdateDomainConfigurationResponse updateDomainConfiguration(Consumer<UpdateDomainConfigurationRequest.Builder> updateDomainConfigurationRequest) throws ResourceNotFoundException, CertificateValidationException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateDomainConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
updateDynamicThingGroup
default UpdateDynamicThingGroupResponse updateDynamicThingGroup(UpdateDynamicThingGroupRequest updateDynamicThingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, AwsServiceException, SdkClientException, IotException
Updates a dynamic thing group.
Requires permission to access the UpdateDynamicThingGroup action.
- Parameters:
updateDynamicThingGroupRequest
-- Returns:
- Result of the UpdateDynamicThingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
updateDynamicThingGroup
default UpdateDynamicThingGroupResponse updateDynamicThingGroup(Consumer<UpdateDynamicThingGroupRequest.Builder> updateDynamicThingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateDynamicThingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
updateEventConfigurations
default UpdateEventConfigurationsResponse updateEventConfigurations(UpdateEventConfigurationsRequest updateEventConfigurationsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IotException
Updates the event configurations.
Requires permission to access the UpdateEventConfigurations action.
- Parameters:
updateEventConfigurationsRequest
-- Returns:
- Result of the UpdateEventConfigurations operation returned by the service.
- Throws:
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.AwsServiceException
-
updateEventConfigurations
default UpdateEventConfigurationsResponse updateEventConfigurations(Consumer<UpdateEventConfigurationsRequest.Builder> updateEventConfigurationsRequest) throws InvalidRequestException, InternalFailureException, ThrottlingException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateEventConfigurations operation returned by the service.
- Throws:
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.AwsServiceException
-
updateFleetMetric
default UpdateFleetMetricResponse updateFleetMetric(UpdateFleetMetricRequest updateFleetMetricRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, VersionConflictException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
Updates the data for a fleet metric.
Requires permission to access the UpdateFleetMetric action.
- Parameters:
updateFleetMetricRequest
-- Returns:
- Result of the UpdateFleetMetric operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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 theexpectedVersion
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.AwsServiceException
-
updateFleetMetric
default UpdateFleetMetricResponse updateFleetMetric(Consumer<UpdateFleetMetricRequest.Builder> updateFleetMetricRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, InvalidQueryException, InvalidAggregationException, VersionConflictException, IndexNotReadyException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateFleetMetric operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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 theexpectedVersion
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.AwsServiceException
-
updateIndexingConfiguration
default UpdateIndexingConfigurationResponse updateIndexingConfiguration(UpdateIndexingConfigurationRequest updateIndexingConfigurationRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Updates the search configuration.
Requires permission to access the UpdateIndexingConfiguration action.
- Parameters:
updateIndexingConfigurationRequest
-- Returns:
- Result of the UpdateIndexingConfiguration operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
updateIndexingConfiguration
default UpdateIndexingConfigurationResponse updateIndexingConfiguration(Consumer<UpdateIndexingConfigurationRequest.Builder> updateIndexingConfigurationRequest) throws InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateIndexingConfiguration operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.ThrottlingException
- The rate 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.AwsServiceException
-
updateJob
default UpdateJobResponse updateJob(UpdateJobRequest updateJobRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
Updates supported fields of the specified job.
Requires permission to access the UpdateJob action.
- Parameters:
updateJobRequest
-- Returns:
- Result of the UpdateJob operation returned by the service.
- Throws:
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.AwsServiceException
-
updateJob
default UpdateJobResponse updateJob(Consumer<UpdateJobRequest.Builder> updateJobRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateJob operation returned by the service.
- Throws:
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.AwsServiceException
-
updateMitigationAction
default UpdateMitigationActionResponse updateMitigationAction(UpdateMitigationActionRequest updateMitigationActionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Updates the definition for the specified mitigation action.
Requires permission to access the UpdateMitigationAction action.
- Parameters:
updateMitigationActionRequest
-- Returns:
- Result of the UpdateMitigationAction operation returned by the service.
- Throws:
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.AwsServiceException
-
updateMitigationAction
default UpdateMitigationActionResponse updateMitigationAction(Consumer<UpdateMitigationActionRequest.Builder> updateMitigationActionRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateMitigationAction operation returned by the service.
- Throws:
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.AwsServiceException
-
updatePackage
default UpdatePackageResponse updatePackage(UpdatePackageRequest updatePackageRequest) throws ThrottlingException, InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Updates the supported fields for a specific software package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
- Parameters:
updatePackageRequest
-- Returns:
- Result of the UpdatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
updatePackage
default UpdatePackageResponse updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest) throws ThrottlingException, InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
updatePackageConfiguration
default UpdatePackageConfigurationResponse updatePackageConfiguration(UpdatePackageConfigurationRequest updatePackageConfigurationRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
Updates the software package configuration.
Requires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
- Parameters:
updatePackageConfigurationRequest
-- Returns:
- Result of the UpdatePackageConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
updatePackageConfiguration
default UpdatePackageConfigurationResponse updatePackageConfiguration(Consumer<UpdatePackageConfigurationRequest.Builder> updatePackageConfigurationRequest) throws ThrottlingException, InternalServerException, ValidationException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdatePackageConfiguration operation returned by the service.
- Throws:
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.AwsServiceException
-
updatePackageVersion
default UpdatePackageVersionResponse updatePackageVersion(UpdatePackageVersionRequest updatePackageVersionRequest) throws ThrottlingException, InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Updates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
- Parameters:
updatePackageVersionRequest
-- Returns:
- Result of the UpdatePackageVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
updatePackageVersion
default UpdatePackageVersionResponse updatePackageVersion(Consumer<UpdatePackageVersionRequest.Builder> updatePackageVersionRequest) throws ThrottlingException, InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdatePackageVersion operation returned by the service.
- Throws:
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.AwsServiceException
-
updateProvisioningTemplate
default UpdateProvisioningTemplateResponse updateProvisioningTemplate(UpdateProvisioningTemplateRequest updateProvisioningTemplateRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
Updates a provisioning template.
Requires permission to access the UpdateProvisioningTemplate action.
- Parameters:
updateProvisioningTemplateRequest
-- Returns:
- Result of the UpdateProvisioningTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
updateProvisioningTemplate
default UpdateProvisioningTemplateResponse updateProvisioningTemplate(Consumer<UpdateProvisioningTemplateRequest.Builder> updateProvisioningTemplateRequest) throws InternalFailureException, InvalidRequestException, ResourceNotFoundException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateProvisioningTemplate operation returned by the service.
- Throws:
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.AwsServiceException
-
updateRoleAlias
default UpdateRoleAliasResponse updateRoleAlias(UpdateRoleAliasRequest updateRoleAliasRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
- Parameters:
updateRoleAliasRequest
-- Returns:
- Result of the UpdateRoleAlias operation returned by the service.
- Throws:
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.AwsServiceException
-
updateRoleAlias
default UpdateRoleAliasResponse updateRoleAlias(Consumer<UpdateRoleAliasRequest.Builder> updateRoleAliasRequest) throws ResourceNotFoundException, InvalidRequestException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Updates a role alias.
Requires permission to access the UpdateRoleAlias action.
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:
- Result of the UpdateRoleAlias operation returned by the service.
- Throws:
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.AwsServiceException
-
updateScheduledAudit
default UpdateScheduledAuditResponse updateScheduledAudit(UpdateScheduledAuditRequest updateScheduledAuditRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateScheduledAudit operation returned by the service.
- Throws:
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.AwsServiceException
-
updateScheduledAudit
default UpdateScheduledAuditResponse updateScheduledAudit(Consumer<UpdateScheduledAuditRequest.Builder> updateScheduledAuditRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateScheduledAudit operation returned by the service.
- Throws:
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.AwsServiceException
-
updateSecurityProfile
default UpdateSecurityProfileResponse updateSecurityProfile(UpdateSecurityProfileRequest updateSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, VersionConflictException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Updates a Device Defender security profile.
Requires permission to access the UpdateSecurityProfile action.
- Parameters:
updateSecurityProfileRequest
-- Returns:
- Result of the UpdateSecurityProfile operation returned by the service.
- Throws:
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 theexpectedVersion
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.AwsServiceException
-
updateSecurityProfile
default UpdateSecurityProfileResponse updateSecurityProfile(Consumer<UpdateSecurityProfileRequest.Builder> updateSecurityProfileRequest) throws InvalidRequestException, ResourceNotFoundException, VersionConflictException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateSecurityProfile operation returned by the service.
- Throws:
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 theexpectedVersion
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.AwsServiceException
-
updateStream
default UpdateStreamResponse updateStream(UpdateStreamRequest updateStreamRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Updates an existing stream. The stream version will be incremented by one.
Requires permission to access the UpdateStream action.
- Parameters:
updateStreamRequest
-- Returns:
- Result of the UpdateStream operation returned by the service.
- Throws:
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.AwsServiceException
-
updateStream
default UpdateStreamResponse updateStream(Consumer<UpdateStreamRequest.Builder> updateStreamRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateStream operation returned by the service.
- Throws:
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.AwsServiceException
-
updateThing
default UpdateThingResponse updateThing(UpdateThingRequest updateThingRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Updates the data for a thing.
Requires permission to access the UpdateThing action.
- Parameters:
updateThingRequest
- The input for the UpdateThing operation.- Returns:
- Result of the UpdateThing operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
updateThing
default UpdateThingResponse updateThing(Consumer<UpdateThingRequest.Builder> updateThingRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, UnauthorizedException, ServiceUnavailableException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateThing operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
updateThingGroup
default UpdateThingGroupResponse updateThingGroup(UpdateThingGroupRequest updateThingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Update a thing group.
Requires permission to access the UpdateThingGroup action.
- Parameters:
updateThingGroupRequest
-- Returns:
- Result of the UpdateThingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
updateThingGroup
default UpdateThingGroupResponse updateThingGroup(Consumer<UpdateThingGroupRequest.Builder> updateThingGroupRequest) throws InvalidRequestException, VersionConflictException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateThingGroup operation returned by the service.
- Throws:
InvalidRequestException
- The request is not valid.VersionConflictException
- An exception thrown when the version of an entity specified with theexpectedVersion
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.AwsServiceException
-
updateThingGroupsForThing
default UpdateThingGroupsForThingResponse updateThingGroupsForThing(UpdateThingGroupsForThingRequest updateThingGroupsForThingRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
Updates the groups to which the thing belongs.
Requires permission to access the UpdateThingGroupsForThing action.
- Parameters:
updateThingGroupsForThingRequest
-- Returns:
- Result of the UpdateThingGroupsForThing operation returned by the service.
- Throws:
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.AwsServiceException
-
updateThingGroupsForThing
default UpdateThingGroupsForThingResponse updateThingGroupsForThing(Consumer<UpdateThingGroupsForThingRequest.Builder> updateThingGroupsForThingRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, ResourceNotFoundException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateThingGroupsForThing operation returned by the service.
- Throws:
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.AwsServiceException
-
updateTopicRuleDestination
default UpdateTopicRuleDestinationResponse updateTopicRuleDestination(UpdateTopicRuleDestinationRequest updateTopicRuleDestinationRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateTopicRuleDestination operation returned by the service.
- Throws:
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.AwsServiceException
-
updateTopicRuleDestination
default UpdateTopicRuleDestinationResponse updateTopicRuleDestination(Consumer<UpdateTopicRuleDestinationRequest.Builder> updateTopicRuleDestinationRequest) throws InternalException, InvalidRequestException, ServiceUnavailableException, UnauthorizedException, ConflictingResourceUpdateException, AwsServiceException, SdkClientException, IotException
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:
- Result of the UpdateTopicRuleDestination operation returned by the service.
- Throws:
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.AwsServiceException
-
validateSecurityProfileBehaviors
default ValidateSecurityProfileBehaviorsResponse validateSecurityProfileBehaviors(ValidateSecurityProfileBehaviorsRequest validateSecurityProfileBehaviorsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
Validates a Device Defender security profile behaviors specification.
Requires permission to access the ValidateSecurityProfileBehaviors action.
- Parameters:
validateSecurityProfileBehaviorsRequest
-- Returns:
- Result of the ValidateSecurityProfileBehaviors operation returned by the service.
- Throws:
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.AwsServiceException
-
validateSecurityProfileBehaviors
default ValidateSecurityProfileBehaviorsResponse validateSecurityProfileBehaviors(Consumer<ValidateSecurityProfileBehaviorsRequest.Builder> validateSecurityProfileBehaviorsRequest) throws InvalidRequestException, ThrottlingException, InternalFailureException, AwsServiceException, SdkClientException, IotException
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:
- Result of the ValidateSecurityProfileBehaviors operation returned by the service.
- Throws:
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.AwsServiceException
-
create
static IotClient create()
Create aIotClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.
-
builder
static IotClientBuilder builder()
Create a builder that can be used to configure and create aIotClient
.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default IotServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
-
-