Struct Client

pub struct Client { /* private fields */ }

Client for AWS IoT

Client for invoking operations on AWS IoT. Each operation on AWS IoT is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_iot::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_iot::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AcceptCertificateTransfer operation has a Client::accept_certificate_transfer, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.accept_certificate_transfer()
    .certificate_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn accept_certificate_transfer( &self, ) -> AcceptCertificateTransferFluentBuilder

Constructs a fluent builder for the AcceptCertificateTransfer operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

    
    
  • set_as_active(bool) / set_set_as_active(Option<bool>):
    required: false
    

    Specifies whether the certificate is active.

    
    
• On success, responds with AcceptCertificateTransferOutput
• On failure, responds with SdkError<AcceptCertificateTransferError>

impl Client

pub fn add_thing_to_billing_group(&self) -> AddThingToBillingGroupFluentBuilder

Constructs a fluent builder for the AddThingToBillingGroup operation.

• The fluent builder is configurable:
  • billing_group_name(impl Into<String>) / set_billing_group_name(Option<String>):
    required: false
    

    The name of the billing group.

    This call is asynchronous. It might take several seconds for the detachment to propagate.

    
    
  • billing_group_arn(impl Into<String>) / set_billing_group_arn(Option<String>):
    required: false
    

    The ARN of the billing group.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: false
    

    The name of the thing to be added to the billing group.

    
    
  • thing_arn(impl Into<String>) / set_thing_arn(Option<String>):
    required: false
    

    The ARN of the thing to be added to the billing group.

    
    
• On success, responds with AddThingToBillingGroupOutput
• On failure, responds with SdkError<AddThingToBillingGroupError>

impl Client

pub fn add_thing_to_thing_group(&self) -> AddThingToThingGroupFluentBuilder

Constructs a fluent builder for the AddThingToThingGroup operation.

• The fluent builder is configurable:
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: false
    

    The name of the group to which you are adding a thing.

    
    
  • thing_group_arn(impl Into<String>) / set_thing_group_arn(Option<String>):
    required: false
    

    The ARN of the group to which you are adding a thing.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: false
    

    The name of the thing to add to a group.

    
    
  • thing_arn(impl Into<String>) / set_thing_arn(Option<String>):
    required: false
    

    The ARN of the thing to add to a group.

    
    
  • override_dynamic_groups(bool) / set_override_dynamic_groups(Option<bool>):
    required: false
    

    Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.

    
    
• On success, responds with AddThingToThingGroupOutput
• On failure, responds with SdkError<AddThingToThingGroupError>

impl Client

pub fn associate_sbom_with_package_version( &self, ) -> AssociateSbomWithPackageVersionFluentBuilder

Constructs a fluent builder for the AssociateSbomWithPackageVersion operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the new software package.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name of the new package version.

    
    
  • sbom(Sbom) / set_sbom(Option<Sbom>):
    required: true
    

    A specific software bill of matrerials associated with a software package version.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    
    
• On success, responds with AssociateSbomWithPackageVersionOutput with field(s):
  • package_name(Option<String>):

    The name of the new software package.

  • version_name(Option<String>):

    The name of the new package version.

  • sbom(Option<Sbom>):

    A specific software bill of matrerials associated with a software package version.

  • sbom_validation_status(Option<SbomValidationStatus>):

    The status of the initial validation for the software bill of materials against the Software Package Data Exchange (SPDX) and CycloneDX industry standard formats.

• On failure, responds with SdkError<AssociateSbomWithPackageVersionError>

impl Client

pub fn associate_targets_with_job(&self) -> AssociateTargetsWithJobFluentBuilder

Constructs a fluent builder for the AssociateTargetsWithJob operation.

• The fluent builder is configurable:
  • targets(impl Into<String>) / set_targets(Option<Vec::<String>>):
    required: true
    

    A list of thing group ARNs that define the targets of the job.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier you assigned to this job when it was created.

    
    
  • comment(impl Into<String>) / set_comment(Option<String>):
    required: false
    

    An optional comment string describing why the job was associated with the targets.

    
    
  • namespace_id(impl Into<String>) / set_namespace_id(Option<String>):
    required: false
    

    The namespace used to indicate that a job is a customer-managed job.

    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

    The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

    
    
• On success, responds with AssociateTargetsWithJobOutput with field(s):
  • job_arn(Option<String>):

    An ARN identifying the job.

  • job_id(Option<String>):

    The unique identifier you assigned to this job when it was created.

  • description(Option<String>):

    A short text description of the job.

• On failure, responds with SdkError<AssociateTargetsWithJobError>

impl Client

pub fn attach_policy(&self) -> AttachPolicyFluentBuilder

Constructs a fluent builder for the AttachPolicy operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The name of the policy to attach.

    
    
  • target(impl Into<String>) / set_target(Option<String>):
    required: true
    

    The identity to which the policy is attached. For example, a thing group or a certificate.

    
    
• On success, responds with AttachPolicyOutput
• On failure, responds with SdkError<AttachPolicyError>

impl Client

pub fn attach_principal_policy(&self) -> AttachPrincipalPolicyFluentBuilder

👎Deprecated

Constructs a fluent builder for the AttachPrincipalPolicy operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The policy name.

    
    
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: true
    

    The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

    
    
• On success, responds with AttachPrincipalPolicyOutput
• On failure, responds with SdkError<AttachPrincipalPolicyError>

impl Client

pub fn attach_security_profile(&self) -> AttachSecurityProfileFluentBuilder

Constructs a fluent builder for the AttachSecurityProfile operation.

• The fluent builder is configurable:
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: true
    

    The security profile that is attached.

    
    
  • security_profile_target_arn(impl Into<String>) / set_security_profile_target_arn(Option<String>):
    required: true
    

    The ARN of the target (thing group) to which the security profile is attached.

    
    
• On success, responds with AttachSecurityProfileOutput
• On failure, responds with SdkError<AttachSecurityProfileError>

impl Client

pub fn attach_thing_principal(&self) -> AttachThingPrincipalFluentBuilder

Constructs a fluent builder for the AttachThingPrincipal operation.

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing.

    
    
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: true
    

    The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

    
    
  • thing_principal_type(ThingPrincipalType) / set_thing_principal_type(Option<ThingPrincipalType>):
    required: false
    

    The type of the relation you want to specify when you attach a principal to a thing.

    • EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.

    • NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.

    
    
• On success, responds with AttachThingPrincipalOutput
• On failure, responds with SdkError<AttachThingPrincipalError>

impl Client

pub fn cancel_audit_mitigation_actions_task( &self, ) -> CancelAuditMitigationActionsTaskFluentBuilder

Constructs a fluent builder for the CancelAuditMitigationActionsTask operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The unique identifier for the task that you want to cancel.

    
    
• On success, responds with CancelAuditMitigationActionsTaskOutput
• On failure, responds with SdkError<CancelAuditMitigationActionsTaskError>

impl Client

pub fn cancel_audit_task(&self) -> CancelAuditTaskFluentBuilder

Constructs a fluent builder for the CancelAuditTask operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The ID of the audit you want to cancel. You can only cancel an audit that is “IN_PROGRESS”.

    
    
• On success, responds with CancelAuditTaskOutput
• On failure, responds with SdkError<CancelAuditTaskError>

impl Client

pub fn cancel_certificate_transfer( &self, ) -> CancelCertificateTransferFluentBuilder

Constructs a fluent builder for the CancelCertificateTransfer operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

    
    
• On success, responds with CancelCertificateTransferOutput
• On failure, responds with SdkError<CancelCertificateTransferError>

impl Client

pub fn cancel_detect_mitigation_actions_task( &self, ) -> CancelDetectMitigationActionsTaskFluentBuilder

Constructs a fluent builder for the CancelDetectMitigationActionsTask operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The unique identifier of the task.

    
    
• On success, responds with CancelDetectMitigationActionsTaskOutput
• On failure, responds with SdkError<CancelDetectMitigationActionsTaskError>

impl Client

pub fn cancel_job(&self) -> CancelJobFluentBuilder

Constructs a fluent builder for the CancelJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier you assigned to this job when it was created.

    
    
  • reason_code(impl Into<String>) / set_reason_code(Option<String>):
    required: false
    

    (Optional)A reason code string that explains why the job was canceled.

    
    
  • comment(impl Into<String>) / set_comment(Option<String>):
    required: false
    

    An optional comment string describing why the job was canceled.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    (Optional) If true job executions with status “IN_PROGRESS” and “QUEUED” are canceled, otherwise only job executions with status “QUEUED” are canceled. The default is false.

    Canceling a job which is “IN_PROGRESS”, will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

    
    
• On success, responds with CancelJobOutput with field(s):
  • job_arn(Option<String>):

    The job ARN.

  • job_id(Option<String>):

    The unique identifier you assigned to this job when it was created.

  • description(Option<String>):

    A short text description of the job.

• On failure, responds with SdkError<CancelJobError>

impl Client

pub fn cancel_job_execution(&self) -> CancelJobExecutionFluentBuilder

Constructs a fluent builder for the CancelJobExecution operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID of the job to be canceled.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing whose execution of the job will be canceled.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

    Canceling a job execution which is “IN_PROGRESS”, will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    (Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

    
    
  • status_details(impl Into<String>, impl Into<String>) / set_status_details(Option<HashMap::<String, String>>):
    required: false
    

    A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

    
    
• On success, responds with CancelJobExecutionOutput
• On failure, responds with SdkError<CancelJobExecutionError>

impl Client

pub fn clear_default_authorizer(&self) -> ClearDefaultAuthorizerFluentBuilder

Constructs a fluent builder for the ClearDefaultAuthorizer operation.

• The fluent builder takes no input, just send it.
• On success, responds with ClearDefaultAuthorizerOutput
• On failure, responds with SdkError<ClearDefaultAuthorizerError>

impl Client

pub fn confirm_topic_rule_destination( &self, ) -> ConfirmTopicRuleDestinationFluentBuilder

Constructs a fluent builder for the ConfirmTopicRuleDestination operation.

• The fluent builder is configurable:
  • confirmation_token(impl Into<String>) / set_confirmation_token(Option<String>):
    required: true
    

    The token used to confirm ownership or access to the topic rule confirmation URL.

    
    
• On success, responds with ConfirmTopicRuleDestinationOutput
• On failure, responds with SdkError<ConfirmTopicRuleDestinationError>

impl Client

pub fn create_audit_suppression(&self) -> CreateAuditSuppressionFluentBuilder

Constructs a fluent builder for the CreateAuditSuppression operation.

• The fluent builder is configurable:
  • check_name(impl Into<String>) / set_check_name(Option<String>):
    required: true
    

    An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

    
    
  • resource_identifier(ResourceIdentifier) / set_resource_identifier(Option<ResourceIdentifier>):
    required: true
    

    Information that identifies the noncompliant resource.

    
    
  • expiration_date(DateTime) / set_expiration_date(Option<DateTime>):
    required: false
    

    The epoch timestamp in seconds at which this suppression expires.

    
    
  • suppress_indefinitely(bool) / set_suppress_indefinitely(Option<bool>):
    required: false
    

    Indicates whether a suppression should exist indefinitely or not.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the audit suppression.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    Each audit supression must have a unique client request token. If you try to create a new audit suppression with the same token as one that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

    
    
• On success, responds with CreateAuditSuppressionOutput
• On failure, responds with SdkError<CreateAuditSuppressionError>

impl Client

pub fn create_authorizer(&self) -> CreateAuthorizerFluentBuilder

Constructs a fluent builder for the CreateAuthorizer operation.

• The fluent builder is configurable:
  • authorizer_name(impl Into<String>) / set_authorizer_name(Option<String>):
    required: true
    

    The authorizer name.

    
    
  • authorizer_function_arn(impl Into<String>) / set_authorizer_function_arn(Option<String>):
    required: true
    

    The ARN of the authorizer’s Lambda function.

    
    
  • token_key_name(impl Into<String>) / set_token_key_name(Option<String>):
    required: false
    

    The name of the token key used to extract the token from the HTTP headers.

    
    
  • token_signing_public_keys(impl Into<String>, impl Into<String>) / set_token_signing_public_keys(Option<HashMap::<String, String>>):
    required: false
    

    The public keys used to verify the digital signature returned by your custom authentication service.

    
    
  • status(AuthorizerStatus) / set_status(Option<AuthorizerStatus>):
    required: false
    

    The status of the create authorizer request.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the custom authorizer.

    For URI Request parameters use format: …key1=value1&key2=value2…

    For the CLI command-line parameter use format: &&tags “key1=value1&key2=value2…”

    For the cli-input-json file use format: “tags”: “key1=value1&key2=value2…”

    
    
  • signing_disabled(bool) / set_signing_disabled(Option<bool>):
    required: false
    

    Specifies whether IoT validates the token signature in an authorization request.

    
    
  • enable_caching_for_http(bool) / set_enable_caching_for_http(Option<bool>):
    required: false
    

    When true, the result from the authorizer’s Lambda function is cached for clients that use persistent HTTP connections. The results are cached for the time specified by the Lambda function in refreshAfterInSeconds. This value does not affect authorization of clients that use MQTT connections.

    The default value is false.

    
    
• On success, responds with CreateAuthorizerOutput with field(s):
  • authorizer_name(Option<String>):

    The authorizer’s name.

  • authorizer_arn(Option<String>):

    The authorizer ARN.

• On failure, responds with SdkError<CreateAuthorizerError>

impl Client

pub fn create_billing_group(&self) -> CreateBillingGroupFluentBuilder

Constructs a fluent builder for the CreateBillingGroup operation.

• The fluent builder is configurable:
  • billing_group_name(impl Into<String>) / set_billing_group_name(Option<String>):
    required: true
    

    The name you wish to give to the billing group.

    
    
  • billing_group_properties(BillingGroupProperties) / set_billing_group_properties(Option<BillingGroupProperties>):
    required: false
    

    The properties of the billing group.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the billing group.

    
    
• On success, responds with CreateBillingGroupOutput with field(s):
  • billing_group_name(Option<String>):

    The name you gave to the billing group.

  • billing_group_arn(Option<String>):

    The ARN of the billing group.

  • billing_group_id(Option<String>):

    The ID of the billing group.

• On failure, responds with SdkError<CreateBillingGroupError>

impl Client

pub fn create_certificate_from_csr( &self, ) -> CreateCertificateFromCsrFluentBuilder

Constructs a fluent builder for the CreateCertificateFromCsr operation.

• The fluent builder is configurable:
  • certificate_signing_request(impl Into<String>) / set_certificate_signing_request(Option<String>):
    required: true
    

    The certificate signing request (CSR).

    
    
  • set_as_active(bool) / set_set_as_active(Option<bool>):
    required: false
    

    Specifies whether the certificate is active.

    
    
• On success, responds with CreateCertificateFromCsrOutput with field(s):
  • certificate_arn(Option<String>):

    The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.

  • certificate_id(Option<String>):

    The ID of the certificate. Certificate management operations only take a certificateId.

  • certificate_pem(Option<String>):

    The certificate data, in PEM format.

• On failure, responds with SdkError<CreateCertificateFromCsrError>

impl Client

pub fn create_certificate_provider( &self, ) -> CreateCertificateProviderFluentBuilder

Constructs a fluent builder for the CreateCertificateProvider operation.

• The fluent builder is configurable:
  • certificate_provider_name(impl Into<String>) / set_certificate_provider_name(Option<String>):
    required: true
    

    The name of the certificate provider.

    
    
  • lambda_function_arn(impl Into<String>) / set_lambda_function_arn(Option<String>):
    required: true
    

    The ARN of the Lambda function that defines the authentication logic.

    
    
  • account_default_for_operations(CertificateProviderOperation) / set_account_default_for_operations(Option<Vec::<CertificateProviderOperation>>):
    required: true
    

    A list of the operations that the certificate provider will use to generate certificates. Valid value: CreateCertificateFromCsr.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A string that you can optionally pass in the CreateCertificateProvider request to make sure the request is idempotent.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the certificate provider.

    
    
• On success, responds with CreateCertificateProviderOutput with field(s):
  • certificate_provider_name(Option<String>):

    The name of the certificate provider.

  • certificate_provider_arn(Option<String>):

    The ARN of the certificate provider.

• On failure, responds with SdkError<CreateCertificateProviderError>

impl Client

pub fn create_command(&self) -> CreateCommandFluentBuilder

Constructs a fluent builder for the CreateCommand operation.

• The fluent builder is configurable:
  • command_id(impl Into<String>) / set_command_id(Option<String>):
    required: true
    

    A unique identifier for the command. We recommend using UUID. Alpha-numeric characters, hyphens, and underscores are valid for use here.

    
    
  • namespace(CommandNamespace) / set_namespace(Option<CommandNamespace>):
    required: false
    

    The namespace of the command. The MQTT reserved topics and validations will be used for command executions according to the namespace setting.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The user-friendly name in the console for the command. This name doesn’t have to be unique. You can update the user-friendly name after you define it.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A short text decription of the command.

    
    
  • payload(CommandPayload) / set_payload(Option<CommandPayload>):
    required: false
    

    The payload object for the command. You must specify this information when using the AWS-IoT namespace.

    You can upload a static payload file from your local storage that contains the instructions for the device to process. The payload file can use any format. To make sure that the device correctly interprets the payload, we recommend you to specify the payload content type.

    
    
  • mandatory_parameters(CommandParameter) / set_mandatory_parameters(Option<Vec::<CommandParameter>>):
    required: false
    

    A list of parameters that are required by the StartCommandExecution API. These parameters need to be specified only when using the AWS-IoT-FleetWise namespace. You can either specify them here or when running the command using the StartCommandExecution API.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The IAM role that you must provide when using the AWS-IoT-FleetWise namespace. The role grants IoT Device Management the permission to access IoT FleetWise resources for generating the payload for the command. This field is not required when you use the AWS-IoT namespace.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Name-value pairs that are used as metadata to manage a command.

    
    
• On success, responds with CreateCommandOutput with field(s):
  • command_id(Option<String>):

    The unique identifier for the command.

  • command_arn(Option<String>):

    The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot: : :command/

• On failure, responds with SdkError<CreateCommandError>

impl Client

pub fn create_custom_metric(&self) -> CreateCustomMetricFluentBuilder

Constructs a fluent builder for the CreateCustomMetric operation.

• The fluent builder is configurable:
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can’t begin with aws:. You can’t change the name after you define it.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The friendly name in the console for the custom metric. This name doesn’t have to be unique. Don’t use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

    
    
  • metric_type(CustomMetricType) / set_metric_type(Option<CustomMetricType>):
    required: true
    

    The type of the custom metric.

    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the custom metric.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

    
    
• On success, responds with CreateCustomMetricOutput with field(s):
  • metric_name(Option<String>):

    The name of the custom metric to be used in the metric report.

  • metric_arn(Option<String>):

    The Amazon Resource Number (ARN) of the custom metric. For example, arn:aws-partition:iot:region:accountId:custommetric/metricName

• On failure, responds with SdkError<CreateCustomMetricError>

impl Client

pub fn create_dimension(&self) -> CreateDimensionFluentBuilder

Constructs a fluent builder for the CreateDimension operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

    
    
  • r#type(DimensionType) / set_type(Option<DimensionType>):
    required: true
    

    Specifies the type of dimension. Supported types: TOPIC_FILTER.

    
    
  • string_values(impl Into<String>) / set_string_values(Option<Vec::<String>>):
    required: true
    

    Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, “admin/#”).

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the dimension.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

    
    
• On success, responds with CreateDimensionOutput with field(s):
  • name(Option<String>):

    A unique identifier for the dimension.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) of the created dimension.

• On failure, responds with SdkError<CreateDimensionError>

impl Client

pub fn create_domain_configuration( &self, ) -> CreateDomainConfigurationFluentBuilder

Constructs a fluent builder for the CreateDomainConfiguration operation.

• The fluent builder is configurable:
  • domain_configuration_name(impl Into<String>) / set_domain_configuration_name(Option<String>):
    required: true
    

    The name of the domain configuration. This value must be unique to a region.

    
    
  • domain_name(impl Into<String>) / set_domain_name(Option<String>):
    required: false
    

    The name of the domain.

    
    
  • server_certificate_arns(impl Into<String>) / set_server_certificate_arns(Option<Vec::<String>>):
    required: false
    

    The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.

    
    
  • validation_certificate_arn(impl Into<String>) / set_validation_certificate_arn(Option<String>):
    required: false
    

    The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.

    
    
  • authorizer_config(AuthorizerConfig) / set_authorizer_config(Option<AuthorizerConfig>):
    required: false
    

    An object that specifies the authorization service for a domain.

    
    
  • service_type(ServiceType) / set_service_type(Option<ServiceType>):
    required: false
    

    The type of service delivered by the endpoint.

    Amazon Web Services IoT Core currently supports only the DATA service type.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the domain configuration.

    For URI Request parameters use format: …key1=value1&key2=value2…

    For the CLI command-line parameter use format: &&tags “key1=value1&key2=value2…”

    For the cli-input-json file use format: “tags”: “key1=value1&key2=value2…”

    
    
  • tls_config(TlsConfig) / set_tls_config(Option<TlsConfig>):
    required: false
    

    An object that specifies the TLS configuration for a domain.

    
    
  • server_certificate_config(ServerCertificateConfig) / set_server_certificate_config(Option<ServerCertificateConfig>):
    required: false
    

    The server certificate configuration.

    
    
  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):
    required: false
    

    An enumerated string that specifies the authentication type.

    • CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

    • CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

    • AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

    • AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

    • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

    
    
  • application_protocol(ApplicationProtocol) / set_application_protocol(Option<ApplicationProtocol>):
    required: false
    

    An enumerated string that specifies the application-layer protocol.

    • SECURE_MQTT - MQTT over TLS.

    • MQTT_WSS - MQTT over WebSocket.

    • HTTPS - HTTP over TLS.

    • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

    
    
  • client_certificate_config(ClientCertificateConfig) / set_client_certificate_config(Option<ClientCertificateConfig>):
    required: false
    

    An object that specifies the client certificate configuration for a domain.

    
    
• On success, responds with CreateDomainConfigurationOutput with field(s):
  • domain_configuration_name(Option<String>):

    The name of the domain configuration.

  • domain_configuration_arn(Option<String>):

    The ARN of the domain configuration.

• On failure, responds with SdkError<CreateDomainConfigurationError>

impl Client

pub fn create_dynamic_thing_group(&self) -> CreateDynamicThingGroupFluentBuilder

Constructs a fluent builder for the CreateDynamicThingGroup operation.

• The fluent builder is configurable:
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: true
    

    The dynamic thing group name to create.

    
    
  • thing_group_properties(ThingGroupProperties) / set_thing_group_properties(Option<ThingGroupProperties>):
    required: false
    

    The dynamic thing group properties.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The dynamic thing group index name.

    Currently one index is supported: AWS_Things.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The dynamic thing group search query string.

    See Query Syntax for information about query string syntax.

    
    
  • query_version(impl Into<String>) / set_query_version(Option<String>):
    required: false
    

    The dynamic thing group query version.

    Currently one query version is supported: “2017-09-30”. If not specified, the query version defaults to this value.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the dynamic thing group.

    
    
• On success, responds with CreateDynamicThingGroupOutput with field(s):
  • thing_group_name(Option<String>):

    The dynamic thing group name.

  • thing_group_arn(Option<String>):

    The dynamic thing group ARN.

  • thing_group_id(Option<String>):

    The dynamic thing group ID.

  • index_name(Option<String>):

    The dynamic thing group index name.

  • query_string(Option<String>):

    The dynamic thing group search query string.

  • query_version(Option<String>):

    The dynamic thing group query version.

• On failure, responds with SdkError<CreateDynamicThingGroupError>

impl Client

pub fn create_fleet_metric(&self) -> CreateFleetMetricFluentBuilder

Constructs a fluent builder for the CreateFleetMetric operation.

• The fluent builder is configurable:
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    The name of the fleet metric to create.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The search query string.

    
    
  • aggregation_type(AggregationType) / set_aggregation_type(Option<AggregationType>):
    required: true
    

    The type of the aggregation query.

    
    
  • period(i32) / set_period(Option<i32>):
    required: true
    

    The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

    
    
  • aggregation_field(impl Into<String>) / set_aggregation_field(Option<String>):
    required: true
    

    The field to aggregate.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The fleet metric description.

    
    
  • query_version(impl Into<String>) / set_query_version(Option<String>):
    required: false
    

    The query version.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the index to search.

    
    
  • unit(FleetMetricUnit) / set_unit(Option<FleetMetricUnit>):
    required: false
    

    Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata, which can be used to manage the fleet metric.

    
    
• On success, responds with CreateFleetMetricOutput with field(s):
  • metric_name(Option<String>):

    The name of the fleet metric to create.

  • metric_arn(Option<String>):

    The Amazon Resource Name (ARN) of the new fleet metric.

• On failure, responds with SdkError<CreateFleetMetricError>

impl Client

pub fn create_job(&self) -> CreateJobFluentBuilder

Constructs a fluent builder for the CreateJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    A job identifier which must be unique for your account. We recommend using a UUID. Alpha-numeric characters, “-” and “_” are valid for use here.

    
    
  • targets(impl Into<String>) / set_targets(Option<Vec::<String>>):
    required: true
    

    A list of things and thing groups to which the job should be sent.

    
    
  • document_source(impl Into<String>) / set_document_source(Option<String>):
    required: false
    

    An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don’t specify a value for document.

    For example, –document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

    For more information, see Methods for accessing a bucket.

    
    
  • document(impl Into<String>) / set_document(Option<String>):
    required: false
    

    The job document. Required if you don’t specify a value for documentSource.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A short text description of the job.

    
    
  • presigned_url_config(PresignedUrlConfig) / set_presigned_url_config(Option<PresignedUrlConfig>):
    required: false
    

    Configuration information for pre-signed S3 URLs.

    
    
  • target_selection(TargetSelection) / set_target_selection(Option<TargetSelection>):
    required: false
    

    Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

    We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

    
    
  • job_executions_rollout_config(JobExecutionsRolloutConfig) / set_job_executions_rollout_config(Option<JobExecutionsRolloutConfig>):
    required: false
    

    Allows you to create a staged rollout of the job.

    
    
  • abort_config(AbortConfig) / set_abort_config(Option<AbortConfig>):
    required: false
    

    Allows you to create the criteria to abort a job.

    
    
  • timeout_config(TimeoutConfig) / set_timeout_config(Option<TimeoutConfig>):
    required: false
    

    Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the job.

    
    
  • namespace_id(impl Into<String>) / set_namespace_id(Option<String>):
    required: false
    

    The namespace used to indicate that a job is a customer-managed job.

    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

    The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

    
    
  • job_template_arn(impl Into<String>) / set_job_template_arn(Option<String>):
    required: false
    

    The ARN of the job template used to create the job.

    
    
  • job_executions_retry_config(JobExecutionsRetryConfig) / set_job_executions_retry_config(Option<JobExecutionsRetryConfig>):
    required: false
    

    Allows you to create the criteria to retry a job.

    
    
  • document_parameters(impl Into<String>, impl Into<String>) / set_document_parameters(Option<HashMap::<String, String>>):
    required: false
    

    Parameters of an Amazon Web Services managed template that you can specify to create the job document.

    documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can’t be used with custom job templates or to create jobs from them.

    
    
  • scheduling_config(SchedulingConfig) / set_scheduling_config(Option<SchedulingConfig>):
    required: false
    

    The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.

    
    
  • destination_package_versions(impl Into<String>) / set_destination_package_versions(Option<Vec::<String>>):
    required: false
    

    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

    
    
• On success, responds with CreateJobOutput with field(s):
  • job_arn(Option<String>):

    The job ARN.

  • job_id(Option<String>):

    The unique identifier you assigned to this job.

  • description(Option<String>):

    The job description.

• On failure, responds with SdkError<CreateJobError>

impl Client

pub fn create_job_template(&self) -> CreateJobTemplateFluentBuilder

Constructs a fluent builder for the CreateJobTemplate operation.

• The fluent builder is configurable:
  • job_template_id(impl Into<String>) / set_job_template_id(Option<String>):
    required: true
    

    A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, “-”, and “_” are valid for use here.

    
    
  • job_arn(impl Into<String>) / set_job_arn(Option<String>):
    required: false
    

    The ARN of the job to use as the basis for the job template.

    
    
  • document_source(impl Into<String>) / set_document_source(Option<String>):
    required: false
    

    An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don’t specify a value for document.

    For example, –document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

    For more information, see Methods for accessing a bucket.

    
    
  • document(impl Into<String>) / set_document(Option<String>):
    required: false
    

    The job document. Required if you don’t specify a value for documentSource.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    A description of the job document.

    
    
  • presigned_url_config(PresignedUrlConfig) / set_presigned_url_config(Option<PresignedUrlConfig>):
    required: false
    

    Configuration for pre-signed S3 URLs.

    
    
  • job_executions_rollout_config(JobExecutionsRolloutConfig) / set_job_executions_rollout_config(Option<JobExecutionsRolloutConfig>):
    required: false
    

    Allows you to create a staged rollout of a job.

    
    
  • abort_config(AbortConfig) / set_abort_config(Option<AbortConfig>):
    required: false
    

    The criteria that determine when and how a job abort takes place.

    
    
  • timeout_config(TimeoutConfig) / set_timeout_config(Option<TimeoutConfig>):
    required: false
    

    Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the job template.

    
    
  • job_executions_retry_config(JobExecutionsRetryConfig) / set_job_executions_retry_config(Option<JobExecutionsRetryConfig>):
    required: false
    

    Allows you to create the criteria to retry a job.

    
    
  • maintenance_windows(MaintenanceWindow) / set_maintenance_windows(Option<Vec::<MaintenanceWindow>>):
    required: false
    

    Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

    
    
  • destination_package_versions(impl Into<String>) / set_destination_package_versions(Option<Vec::<String>>):
    required: false
    

    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

    
    
• On success, responds with CreateJobTemplateOutput with field(s):
  • job_template_arn(Option<String>):

    The ARN of the job template.

  • job_template_id(Option<String>):

    The unique identifier of the job template.

• On failure, responds with SdkError<CreateJobTemplateError>

impl Client

pub fn create_keys_and_certificate( &self, ) -> CreateKeysAndCertificateFluentBuilder

Constructs a fluent builder for the CreateKeysAndCertificate operation.

• The fluent builder is configurable:
  • set_as_active(bool) / set_set_as_active(Option<bool>):
    required: false
    

    Specifies whether the certificate is active.

    
    
• On success, responds with CreateKeysAndCertificateOutput with field(s):
  • certificate_arn(Option<String>):

    The ARN of the certificate.

  • certificate_id(Option<String>):

    The ID of the certificate. IoT issues a default subject name for the certificate (for example, IoT Certificate).

  • certificate_pem(Option<String>):

    The certificate data, in PEM format.

  • key_pair(Option<KeyPair>):

    The generated key pair.

• On failure, responds with SdkError<CreateKeysAndCertificateError>

impl Client

pub fn create_mitigation_action(&self) -> CreateMitigationActionFluentBuilder

Constructs a fluent builder for the CreateMitigationAction operation.

• The fluent builder is configurable:
  • action_name(impl Into<String>) / set_action_name(Option<String>):
    required: true
    

    A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The ARN of the IAM role that is used to apply the mitigation action.

    
    
  • action_params(MitigationActionParams) / set_action_params(Option<MitigationActionParams>):
    required: true
    

    Defines the type of action and the parameters for that action.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the mitigation action.

    
    
• On success, responds with CreateMitigationActionOutput with field(s):
  • action_arn(Option<String>):

    The ARN for the new mitigation action.

  • action_id(Option<String>):

    A unique identifier for the new mitigation action.

• On failure, responds with SdkError<CreateMitigationActionError>

impl Client

pub fn create_ota_update(&self) -> CreateOTAUpdateFluentBuilder

Constructs a fluent builder for the CreateOTAUpdate operation.

• The fluent builder is configurable:
  • ota_update_id(impl Into<String>) / set_ota_update_id(Option<String>):
    required: true
    

    The ID of the OTA update to be created.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the OTA update.

    
    
  • targets(impl Into<String>) / set_targets(Option<Vec::<String>>):
    required: true
    

    The devices targeted to receive OTA updates.

    
    
  • protocols(Protocol) / set_protocols(Option<Vec::<Protocol>>):
    required: false
    

    The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

    
    
  • target_selection(TargetSelection) / set_target_selection(Option<TargetSelection>):
    required: false
    

    Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

    
    
  • aws_job_executions_rollout_config(AwsJobExecutionsRolloutConfig) / set_aws_job_executions_rollout_config(Option<AwsJobExecutionsRolloutConfig>):
    required: false
    

    Configuration for the rollout of OTA updates.

    
    
  • aws_job_presigned_url_config(AwsJobPresignedUrlConfig) / set_aws_job_presigned_url_config(Option<AwsJobPresignedUrlConfig>):
    required: false
    

    Configuration information for pre-signed URLs.

    
    
  • aws_job_abort_config(AwsJobAbortConfig) / set_aws_job_abort_config(Option<AwsJobAbortConfig>):
    required: false
    

    The criteria that determine when and how a job abort takes place.

    
    
  • aws_job_timeout_config(AwsJobTimeoutConfig) / set_aws_job_timeout_config(Option<AwsJobTimeoutConfig>):
    required: false
    

    Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

    
    
  • files(OtaUpdateFile) / set_files(Option<Vec::<OtaUpdateFile>>):
    required: true
    

    The files to be streamed by the OTA update.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

    
    
  • additional_parameters(impl Into<String>, impl Into<String>) / set_additional_parameters(Option<HashMap::<String, String>>):
    required: false
    

    A list of additional OTA update parameters, which are name-value pairs. They won’t be sent to devices as a part of the Job document.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage updates.

    
    
• On success, responds with CreateOtaUpdateOutput with field(s):
  • ota_update_id(Option<String>):

    The OTA update ID.

  • aws_iot_job_id(Option<String>):

    The IoT job ID associated with the OTA update.

  • ota_update_arn(Option<String>):

    The OTA update ARN.

  • aws_iot_job_arn(Option<String>):

    The IoT job ARN associated with the OTA update.

  • ota_update_status(Option<OtaUpdateStatus>):

    The OTA update status.

• On failure, responds with SdkError<CreateOTAUpdateError>

impl Client

pub fn create_package(&self) -> CreatePackageFluentBuilder

Constructs a fluent builder for the CreatePackage operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the new software package.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A summary of the package being created. This can be used to outline the package’s contents or purpose.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Metadata that can be used to manage the package.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    
    
• On success, responds with CreatePackageOutput with field(s):
  • package_name(Option<String>):

    The name of the software package.

  • package_arn(Option<String>):

    The Amazon Resource Name (ARN) for the package.

  • description(Option<String>):

    The package description.

• On failure, responds with SdkError<CreatePackageError>

impl Client

pub fn create_package_version(&self) -> CreatePackageVersionFluentBuilder

Constructs a fluent builder for the CreatePackageVersion operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the associated software package.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name of the new package version.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A summary of the package version being created. This can be used to outline the package’s contents or purpose.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.

    The combined size of all the attributes on a package version is limited to 3KB.

    
    
  • artifact(PackageVersionArtifact) / set_artifact(Option<PackageVersionArtifact>):
    required: false
    

    The various build components created during the build process such as libraries and configuration files that make up a software package version.

    
    
  • recipe(impl Into<String>) / set_recipe(Option<String>):
    required: false
    

    The inline job document associated with a software package version used for a quick job deployment.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Metadata that can be used to manage the package version.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    
    
• On success, responds with CreatePackageVersionOutput with field(s):
  • package_version_arn(Option<String>):

    The Amazon Resource Name (ARN) for the package.

  • package_name(Option<String>):

    The name of the associated software package.

  • version_name(Option<String>):

    The name of the new package version.

  • description(Option<String>):

    The package version description.

  • attributes(Option<HashMap::<String, String>>):

    Metadata that were added to the package version that can be used to define a package version’s configuration.

  • status(Option<PackageVersionStatus>):

    The status of the package version. For more information, see Package version lifecycle.

  • error_reason(Option<String>):

    Error reason for a package version failure during creation or update.

• On failure, responds with SdkError<CreatePackageVersionError>

impl Client

pub fn create_policy(&self) -> CreatePolicyFluentBuilder

Constructs a fluent builder for the CreatePolicy operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The policy name.

    
    
  • policy_document(impl Into<String>) / set_policy_document(Option<String>):
    required: true
    

    The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the policy.

    For URI Request parameters use format: …key1=value1&key2=value2…

    For the CLI command-line parameter use format: &&tags “key1=value1&key2=value2…”

    For the cli-input-json file use format: “tags”: “key1=value1&key2=value2…”

    
    
• On success, responds with CreatePolicyOutput with field(s):
  • policy_name(Option<String>):

    The policy name.

  • policy_arn(Option<String>):

    The policy ARN.

  • policy_document(Option<String>):

    The JSON document that describes the policy.

  • policy_version_id(Option<String>):

    The policy version ID.

• On failure, responds with SdkError<CreatePolicyError>

impl Client

pub fn create_policy_version(&self) -> CreatePolicyVersionFluentBuilder

Constructs a fluent builder for the CreatePolicyVersion operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The policy name.

    
    
  • policy_document(impl Into<String>) / set_policy_document(Option<String>):
    required: true
    

    The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

    
    
  • set_as_default(bool) / set_set_as_default(Option<bool>):
    required: false
    

    Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

    
    
• On success, responds with CreatePolicyVersionOutput with field(s):
  • policy_arn(Option<String>):

    The policy ARN.

  • policy_document(Option<String>):

    The JSON document that describes the policy.

  • policy_version_id(Option<String>):

    The policy version ID.

  • is_default_version(bool):

    Specifies whether the policy version is the default.

• On failure, responds with SdkError<CreatePolicyVersionError>

impl Client

pub fn create_provisioning_claim(&self) -> CreateProvisioningClaimFluentBuilder

Constructs a fluent builder for the CreateProvisioningClaim operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the provisioning template to use.

    
    
• On success, responds with CreateProvisioningClaimOutput with field(s):
  • certificate_id(Option<String>):

    The ID of the certificate.

  • certificate_pem(Option<String>):

    The provisioning claim certificate.

  • key_pair(Option<KeyPair>):

    The provisioning claim key pair.

  • expiration(Option<DateTime>):

    The provisioning claim expiration time.

• On failure, responds with SdkError<CreateProvisioningClaimError>

impl Client

pub fn create_provisioning_template( &self, ) -> CreateProvisioningTemplateFluentBuilder

Constructs a fluent builder for the CreateProvisioningTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the provisioning template.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the provisioning template.

    
    
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: true
    

    The JSON formatted contents of the provisioning template.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

    True to enable the provisioning template, otherwise false.

    
    
  • provisioning_role_arn(impl Into<String>) / set_provisioning_role_arn(Option<String>):
    required: true
    

    The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.

    
    
  • pre_provisioning_hook(ProvisioningHook) / set_pre_provisioning_hook(Option<ProvisioningHook>):
    required: false
    

    Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the provisioning template.

    For URI Request parameters use format: …key1=value1&key2=value2…

    For the CLI command-line parameter use format: &&tags “key1=value1&key2=value2…”

    For the cli-input-json file use format: “tags”: “key1=value1&key2=value2…”

    
    
  • r#type(TemplateType) / set_type(Option<TemplateType>):
    required: false
    

    The type you define in a provisioning template. You can create a template with only one type. You can’t change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

    
    
• On success, responds with CreateProvisioningTemplateOutput with field(s):
  • template_arn(Option<String>):

    The ARN that identifies the provisioning template.

  • template_name(Option<String>):

    The name of the provisioning template.

  • default_version_id(Option<i32>):

    The default version of the provisioning template.

• On failure, responds with SdkError<CreateProvisioningTemplateError>

impl Client

pub fn create_provisioning_template_version( &self, ) -> CreateProvisioningTemplateVersionFluentBuilder

Constructs a fluent builder for the CreateProvisioningTemplateVersion operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the provisioning template.

    
    
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: true
    

    The JSON formatted contents of the provisioning template.

    
    
  • set_as_default(bool) / set_set_as_default(Option<bool>):
    required: false
    

    Sets a fleet provision template version as the default version.

    
    
• On success, responds with CreateProvisioningTemplateVersionOutput with field(s):
  • template_arn(Option<String>):

    The ARN that identifies the provisioning template.

  • template_name(Option<String>):

    The name of the provisioning template.

  • version_id(Option<i32>):

    The version of the provisioning template.

  • is_default_version(bool):

    True if the provisioning template version is the default version, otherwise false.

• On failure, responds with SdkError<CreateProvisioningTemplateVersionError>

impl Client

pub fn create_role_alias(&self) -> CreateRoleAliasFluentBuilder

Constructs a fluent builder for the CreateRoleAlias operation.

• The fluent builder is configurable:
  • role_alias(impl Into<String>) / set_role_alias(Option<String>):
    required: true
    

    The role alias that points to a role ARN. This allows you to change the role without having to update the device.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The role ARN.

    
    
  • credential_duration_seconds(i32) / set_credential_duration_seconds(Option<i32>):
    required: false
    

    How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.

    This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the role alias.

    For URI Request parameters use format: …key1=value1&key2=value2…

    For the CLI command-line parameter use format: &&tags “key1=value1&key2=value2…”

    For the cli-input-json file use format: “tags”: “key1=value1&key2=value2…”

    
    
• On success, responds with CreateRoleAliasOutput with field(s):
  • role_alias(Option<String>):

    The role alias.

  • role_alias_arn(Option<String>):

    The role alias ARN.

• On failure, responds with SdkError<CreateRoleAliasError>

impl Client

pub fn create_scheduled_audit(&self) -> CreateScheduledAuditFluentBuilder

Constructs a fluent builder for the CreateScheduledAudit operation.

• The fluent builder is configurable:
  • frequency(AuditFrequency) / set_frequency(Option<AuditFrequency>):
    required: true
    

    How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is determined by the system.

    
    
  • day_of_month(impl Into<String>) / set_day_of_month(Option<String>):
    required: false
    

    The day of the month on which the scheduled audit takes place. This can be “1” through “31” or “LAST”. This field is required if the “frequency” parameter is set to MONTHLY. If days 29 to 31 are specified, and the month doesn’t have that many days, the audit takes place on the LAST day of the month.

    
    
  • day_of_week(DayOfWeek) / set_day_of_week(Option<DayOfWeek>):
    required: false
    

    The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.

    
    
  • target_check_names(impl Into<String>) / set_target_check_names(Option<Vec::<String>>):
    required: true
    

    Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

    
    
  • scheduled_audit_name(impl Into<String>) / set_scheduled_audit_name(Option<String>):
    required: true
    

    The name you want to give to the scheduled audit. (Max. 128 chars)

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the scheduled audit.

    
    
• On success, responds with CreateScheduledAuditOutput with field(s):
  • scheduled_audit_arn(Option<String>):

    The ARN of the scheduled audit.

• On failure, responds with SdkError<CreateScheduledAuditError>

impl Client

pub fn create_security_profile(&self) -> CreateSecurityProfileFluentBuilder

Constructs a fluent builder for the CreateSecurityProfile operation.

• The fluent builder is configurable:
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: true
    

    The name you are giving to the security profile.

    
    
  • security_profile_description(impl Into<String>) / set_security_profile_description(Option<String>):
    required: false
    

    A description of the security profile.

    
    
  • behaviors(Behavior) / set_behaviors(Option<Vec::<Behavior>>):
    required: false
    

    Specifies the behaviors that, when violated by a device (thing), cause an alert.

    
    
  • alert_targets(AlertTargetType, AlertTarget) / set_alert_targets(Option<HashMap::<AlertTargetType, AlertTarget>>):
    required: false
    

    Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

    
    
  • additional_metrics_to_retain(impl Into<String>) / set_additional_metrics_to_retain(Option<Vec::<String>>):
    required: false
    

    Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

    
    
  • additional_metrics_to_retain_v2(MetricToRetain) / set_additional_metrics_to_retain_v2(Option<Vec::<MetricToRetain>>):
    required: false
    

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata that can be used to manage the security profile.

    
    
  • metrics_export_config(MetricsExportConfig) / set_metrics_export_config(Option<MetricsExportConfig>):
    required: false
    

    Specifies the MQTT topic and role ARN required for metric export.

    
    
• On success, responds with CreateSecurityProfileOutput with field(s):
  • security_profile_name(Option<String>):

    The name you gave to the security profile.

  • security_profile_arn(Option<String>):

    The ARN of the security profile.

• On failure, responds with SdkError<CreateSecurityProfileError>

impl Client

pub fn create_stream(&self) -> CreateStreamFluentBuilder

Constructs a fluent builder for the CreateStream operation.

• The fluent builder is configurable:
  • stream_id(impl Into<String>) / set_stream_id(Option<String>):
    required: true
    

    The stream ID.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the stream.

    
    
  • files(StreamFile) / set_files(Option<Vec::<StreamFile>>):
    required: true
    

    The files to stream.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    An IAM role that allows the IoT service principal to access your S3 files.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage streams.

    
    
• On success, responds with CreateStreamOutput with field(s):
  • stream_id(Option<String>):

    The stream ID.

  • stream_arn(Option<String>):

    The stream ARN.

  • description(Option<String>):

    A description of the stream.

  • stream_version(Option<i32>):

    The version of the stream.

• On failure, responds with SdkError<CreateStreamError>

impl Client

pub fn create_thing(&self) -> CreateThingFluentBuilder

Constructs a fluent builder for the CreateThing operation.

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing to create.

    You can’t change a thing’s name after you create it. To change a thing’s name, you must create a new thing, give it the new name, and then delete the old thing.

    
    
  • thing_type_name(impl Into<String>) / set_thing_type_name(Option<String>):
    required: false
    

    The name of the thing type associated with the new thing.

    
    
  • attribute_payload(AttributePayload) / set_attribute_payload(Option<AttributePayload>):
    required: false
    

    The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:

    {"attributes":{"string1":"string2"}}

    
    
  • billing_group_name(impl Into<String>) / set_billing_group_name(Option<String>):
    required: false
    

    The name of the billing group the thing will be added to.

    
    
• On success, responds with CreateThingOutput with field(s):
  • thing_name(Option<String>):

    The name of the new thing.

  • thing_arn(Option<String>):

    The ARN of the new thing.

  • thing_id(Option<String>):

    The thing ID.

• On failure, responds with SdkError<CreateThingError>

impl Client

pub fn create_thing_group(&self) -> CreateThingGroupFluentBuilder

Constructs a fluent builder for the CreateThingGroup operation.

• The fluent builder is configurable:
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: true
    

    The thing group name to create.

    
    
  • parent_group_name(impl Into<String>) / set_parent_group_name(Option<String>):
    required: false
    

    The name of the parent thing group.

    
    
  • thing_group_properties(ThingGroupProperties) / set_thing_group_properties(Option<ThingGroupProperties>):
    required: false
    

    The thing group properties.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the thing group.

    
    
• On success, responds with CreateThingGroupOutput with field(s):
  • thing_group_name(Option<String>):

    The thing group name.

  • thing_group_arn(Option<String>):

    The thing group ARN.

  • thing_group_id(Option<String>):

    The thing group ID.

• On failure, responds with SdkError<CreateThingGroupError>

impl Client

pub fn create_thing_type(&self) -> CreateThingTypeFluentBuilder

Constructs a fluent builder for the CreateThingType operation.

• The fluent builder is configurable:
  • thing_type_name(impl Into<String>) / set_thing_type_name(Option<String>):
    required: true
    

    The name of the thing type.

    
    
  • thing_type_properties(ThingTypeProperties) / set_thing_type_properties(Option<ThingTypeProperties>):
    required: false
    

    The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the thing type.

    
    
• On success, responds with CreateThingTypeOutput with field(s):
  • thing_type_name(Option<String>):

    The name of the thing type.

  • thing_type_arn(Option<String>):

    The Amazon Resource Name (ARN) of the thing type.

  • thing_type_id(Option<String>):

    The thing type ID.

• On failure, responds with SdkError<CreateThingTypeError>

impl Client

pub fn create_topic_rule(&self) -> CreateTopicRuleFluentBuilder

Constructs a fluent builder for the CreateTopicRule operation.

• The fluent builder is configurable:
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the rule.

    
    
  • topic_rule_payload(TopicRulePayload) / set_topic_rule_payload(Option<TopicRulePayload>):
    required: true
    

    The rule payload.

    
    
  • tags(impl Into<String>) / set_tags(Option<String>):
    required: false
    

    Metadata which can be used to manage the topic rule.

    For URI Request parameters use format: …key1=value1&key2=value2…

    For the CLI command-line parameter use format: –tags “key1=value1&key2=value2…”

    For the cli-input-json file use format: “tags”: “key1=value1&key2=value2…”

    
    
• On success, responds with CreateTopicRuleOutput
• On failure, responds with SdkError<CreateTopicRuleError>

impl Client

pub fn create_topic_rule_destination( &self, ) -> CreateTopicRuleDestinationFluentBuilder

Constructs a fluent builder for the CreateTopicRuleDestination operation.

• The fluent builder is configurable:
  • destination_configuration(TopicRuleDestinationConfiguration) / set_destination_configuration(Option<TopicRuleDestinationConfiguration>):
    required: true
    

    The topic rule destination configuration.

    
    
• On success, responds with CreateTopicRuleDestinationOutput with field(s):
  • topic_rule_destination(Option<TopicRuleDestination>):

    The topic rule destination.

• On failure, responds with SdkError<CreateTopicRuleDestinationError>

impl Client

pub fn delete_account_audit_configuration( &self, ) -> DeleteAccountAuditConfigurationFluentBuilder

Constructs a fluent builder for the DeleteAccountAuditConfiguration operation.

• The fluent builder is configurable:
  • delete_scheduled_audits(bool) / set_delete_scheduled_audits(Option<bool>):
    required: false
    

    If true, all scheduled audits are deleted.

    
    
• On success, responds with DeleteAccountAuditConfigurationOutput
• On failure, responds with SdkError<DeleteAccountAuditConfigurationError>

impl Client

pub fn delete_audit_suppression(&self) -> DeleteAuditSuppressionFluentBuilder

Constructs a fluent builder for the DeleteAuditSuppression operation.

• The fluent builder is configurable:
  • check_name(impl Into<String>) / set_check_name(Option<String>):
    required: true
    

    An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

    
    
  • resource_identifier(ResourceIdentifier) / set_resource_identifier(Option<ResourceIdentifier>):
    required: true
    

    Information that identifies the noncompliant resource.

    
    
• On success, responds with DeleteAuditSuppressionOutput
• On failure, responds with SdkError<DeleteAuditSuppressionError>

impl Client

pub fn delete_authorizer(&self) -> DeleteAuthorizerFluentBuilder

Constructs a fluent builder for the DeleteAuthorizer operation.

• The fluent builder is configurable:
  • authorizer_name(impl Into<String>) / set_authorizer_name(Option<String>):
    required: true
    

    The name of the authorizer to delete.

    
    
• On success, responds with DeleteAuthorizerOutput
• On failure, responds with SdkError<DeleteAuthorizerError>

impl Client

pub fn delete_billing_group(&self) -> DeleteBillingGroupFluentBuilder

Constructs a fluent builder for the DeleteBillingGroup operation.

• The fluent builder is configurable:
  • billing_group_name(impl Into<String>) / set_billing_group_name(Option<String>):
    required: true
    

    The name of the billing group.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException.

    
    
• On success, responds with DeleteBillingGroupOutput
• On failure, responds with SdkError<DeleteBillingGroupError>

impl Client

pub fn delete_ca_certificate(&self) -> DeleteCACertificateFluentBuilder

Constructs a fluent builder for the DeleteCACertificate operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)

    
    
• On success, responds with DeleteCaCertificateOutput
• On failure, responds with SdkError<DeleteCACertificateError>

impl Client

pub fn delete_certificate(&self) -> DeleteCertificateFluentBuilder

Constructs a fluent builder for the DeleteCertificate operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

    
    
  • force_delete(bool) / set_force_delete(Option<bool>):
    required: false
    

    Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.

    
    
• On success, responds with DeleteCertificateOutput
• On failure, responds with SdkError<DeleteCertificateError>

impl Client

pub fn delete_certificate_provider( &self, ) -> DeleteCertificateProviderFluentBuilder

Constructs a fluent builder for the DeleteCertificateProvider operation.

• The fluent builder is configurable:
  • certificate_provider_name(impl Into<String>) / set_certificate_provider_name(Option<String>):
    required: true
    

    The name of the certificate provider.

    
    
• On success, responds with DeleteCertificateProviderOutput
• On failure, responds with SdkError<DeleteCertificateProviderError>

impl Client

pub fn delete_command(&self) -> DeleteCommandFluentBuilder

Constructs a fluent builder for the DeleteCommand operation.

• The fluent builder is configurable:
  • command_id(impl Into<String>) / set_command_id(Option<String>):
    required: true
    

    The unique identifier of the command to be deleted.

    
    
• On success, responds with DeleteCommandOutput with field(s):
  • status_code(i32):

    The status code for the command deletion request. The status code is in the 200 range for a successful request.

    • If the command hasn’t been deprecated, or has been deprecated for a duration that is shorter than the maximum time out duration of 12 hours, when calling the DeleteCommand request, the deletion will be scheduled and a 202 status code will be returned. While the command is being deleted, it will be in a pendingDeletion state. Once the time out duration has been reached, the command will be permanently removed from your account.

    • If the command has been deprecated for a duration that is longer than the maximum time out duration of 12 hours, when calling the DeleteCommand request, the command will be deleted immediately and a 204 status code will be returned.

• On failure, responds with SdkError<DeleteCommandError>

impl Client

pub fn delete_command_execution(&self) -> DeleteCommandExecutionFluentBuilder

Constructs a fluent builder for the DeleteCommandExecution operation.

• The fluent builder is configurable:
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The unique identifier of the command execution that you want to delete from your account.

    
    
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the target device for which you want to delete command executions.

    
    
• On success, responds with DeleteCommandExecutionOutput
• On failure, responds with SdkError<DeleteCommandExecutionError>

impl Client

pub fn delete_custom_metric(&self) -> DeleteCustomMetricFluentBuilder

Constructs a fluent builder for the DeleteCustomMetric operation.

• The fluent builder is configurable:
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    The name of the custom metric.

    
    
• On success, responds with DeleteCustomMetricOutput
• On failure, responds with SdkError<DeleteCustomMetricError>

impl Client

pub fn delete_dimension(&self) -> DeleteDimensionFluentBuilder

Constructs a fluent builder for the DeleteDimension operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The unique identifier for the dimension that you want to delete.

    
    
• On success, responds with DeleteDimensionOutput
• On failure, responds with SdkError<DeleteDimensionError>

impl Client

pub fn delete_domain_configuration( &self, ) -> DeleteDomainConfigurationFluentBuilder

Constructs a fluent builder for the DeleteDomainConfiguration operation.

• The fluent builder is configurable:
  • domain_configuration_name(impl Into<String>) / set_domain_configuration_name(Option<String>):
    required: true
    

    The name of the domain configuration to be deleted.

    
    
• On success, responds with DeleteDomainConfigurationOutput
• On failure, responds with SdkError<DeleteDomainConfigurationError>

impl Client

pub fn delete_dynamic_thing_group(&self) -> DeleteDynamicThingGroupFluentBuilder

Constructs a fluent builder for the DeleteDynamicThingGroup operation.

• The fluent builder is configurable:
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: true
    

    The name of the dynamic thing group to delete.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the dynamic thing group to delete.

    
    
• On success, responds with DeleteDynamicThingGroupOutput
• On failure, responds with SdkError<DeleteDynamicThingGroupError>

impl Client

pub fn delete_fleet_metric(&self) -> DeleteFleetMetricFluentBuilder

Constructs a fluent builder for the DeleteFleetMetric operation.

• The fluent builder is configurable:
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    The name of the fleet metric to delete.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the fleet metric to delete.

    
    
• On success, responds with DeleteFleetMetricOutput
• On failure, responds with SdkError<DeleteFleetMetricError>

impl Client

pub fn delete_job(&self) -> DeleteJobFluentBuilder

Constructs a fluent builder for the DeleteJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID of the job to be deleted.

    After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    (Optional) When true, you can delete a job which is “IN_PROGRESS”. Otherwise, you can only delete a job which is in a terminal state (“COMPLETED” or “CANCELED”) or an exception will occur. The default is false.

    Deleting a job which is “IN_PROGRESS”, will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.

    
    
  • namespace_id(impl Into<String>) / set_namespace_id(Option<String>):
    required: false
    

    The namespace used to indicate that a job is a customer-managed job.

    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

    The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

    
    
• On success, responds with DeleteJobOutput
• On failure, responds with SdkError<DeleteJobError>

impl Client

pub fn delete_job_execution(&self) -> DeleteJobExecutionFluentBuilder

Constructs a fluent builder for the DeleteJobExecution operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID of the job whose execution on a particular device will be deleted.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing whose job execution will be deleted.

    
    
  • execution_number(i64) / set_execution_number(Option<i64>):
    required: true
    

    The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

    Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    (Optional) When true, you can delete a job execution which is “IN_PROGRESS”. Otherwise, you can only delete a job execution which is in a terminal state (“SUCCEEDED”, “FAILED”, “REJECTED”, “REMOVED” or “CANCELED”) or an exception will occur. The default is false.

    Deleting a job execution which is “IN_PROGRESS”, will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

    
    
  • namespace_id(impl Into<String>) / set_namespace_id(Option<String>):
    required: false
    

    The namespace used to indicate that a job is a customer-managed job.

    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

    The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

    
    
• On success, responds with DeleteJobExecutionOutput
• On failure, responds with SdkError<DeleteJobExecutionError>

impl Client

pub fn delete_job_template(&self) -> DeleteJobTemplateFluentBuilder

Constructs a fluent builder for the DeleteJobTemplate operation.

• The fluent builder is configurable:
  • job_template_id(impl Into<String>) / set_job_template_id(Option<String>):
    required: true
    

    The unique identifier of the job template to delete.

    
    
• On success, responds with DeleteJobTemplateOutput
• On failure, responds with SdkError<DeleteJobTemplateError>

impl Client

pub fn delete_mitigation_action(&self) -> DeleteMitigationActionFluentBuilder

Constructs a fluent builder for the DeleteMitigationAction operation.

• The fluent builder is configurable:
  • action_name(impl Into<String>) / set_action_name(Option<String>):
    required: true
    

    The name of the mitigation action that you want to delete.

    
    
• On success, responds with DeleteMitigationActionOutput
• On failure, responds with SdkError<DeleteMitigationActionError>

impl Client

pub fn delete_ota_update(&self) -> DeleteOTAUpdateFluentBuilder

Constructs a fluent builder for the DeleteOTAUpdate operation.

• The fluent builder is configurable:
  • ota_update_id(impl Into<String>) / set_ota_update_id(Option<String>):
    required: true
    

    The ID of the OTA update to delete.

    
    
  • delete_stream(bool) / set_delete_stream(Option<bool>):
    required: false
    

    When true, the stream created by the OTAUpdate process is deleted when the OTA update is deleted. Ignored if the stream specified in the OTAUpdate is supplied by the user.

    
    
  • force_delete_aws_job(bool) / set_force_delete_aws_job(Option<bool>):
    required: false
    

    When true, deletes the IoT job created by the OTAUpdate process even if it is “IN_PROGRESS”. Otherwise, if the job is not in a terminal state (“COMPLETED” or “CANCELED”) an exception will occur. The default is false.

    
    
• On success, responds with DeleteOtaUpdateOutput
• On failure, responds with SdkError<DeleteOTAUpdateError>

impl Client

pub fn delete_package(&self) -> DeletePackageFluentBuilder

Constructs a fluent builder for the DeletePackage operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the target software package.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    
    
• On success, responds with DeletePackageOutput
• On failure, responds with SdkError<DeletePackageError>

impl Client

pub fn delete_package_version(&self) -> DeletePackageVersionFluentBuilder

Constructs a fluent builder for the DeletePackageVersion operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the associated software package.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name of the target package version.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    
    
• On success, responds with DeletePackageVersionOutput
• On failure, responds with SdkError<DeletePackageVersionError>

impl Client

pub fn delete_policy(&self) -> DeletePolicyFluentBuilder

Constructs a fluent builder for the DeletePolicy operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The name of the policy to delete.

    
    
• On success, responds with DeletePolicyOutput
• On failure, responds with SdkError<DeletePolicyError>

impl Client

pub fn delete_policy_version(&self) -> DeletePolicyVersionFluentBuilder

Constructs a fluent builder for the DeletePolicyVersion operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The name of the policy.

    
    
  • policy_version_id(impl Into<String>) / set_policy_version_id(Option<String>):
    required: true
    

    The policy version ID.

    
    
• On success, responds with DeletePolicyVersionOutput
• On failure, responds with SdkError<DeletePolicyVersionError>

impl Client

pub fn delete_provisioning_template( &self, ) -> DeleteProvisioningTemplateFluentBuilder

Constructs a fluent builder for the DeleteProvisioningTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the fleet provision template to delete.

    
    
• On success, responds with DeleteProvisioningTemplateOutput
• On failure, responds with SdkError<DeleteProvisioningTemplateError>

impl Client

pub fn delete_provisioning_template_version( &self, ) -> DeleteProvisioningTemplateVersionFluentBuilder

Constructs a fluent builder for the DeleteProvisioningTemplateVersion operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the provisioning template version to delete.

    
    
  • version_id(i32) / set_version_id(Option<i32>):
    required: true
    

    The provisioning template version ID to delete.

    
    
• On success, responds with DeleteProvisioningTemplateVersionOutput
• On failure, responds with SdkError<DeleteProvisioningTemplateVersionError>

impl Client

pub fn delete_registration_code(&self) -> DeleteRegistrationCodeFluentBuilder

Constructs a fluent builder for the DeleteRegistrationCode operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteRegistrationCodeOutput
• On failure, responds with SdkError<DeleteRegistrationCodeError>

impl Client

pub fn delete_role_alias(&self) -> DeleteRoleAliasFluentBuilder

Constructs a fluent builder for the DeleteRoleAlias operation.

• The fluent builder is configurable:
  • role_alias(impl Into<String>) / set_role_alias(Option<String>):
    required: true
    

    The role alias to delete.

    
    
• On success, responds with DeleteRoleAliasOutput
• On failure, responds with SdkError<DeleteRoleAliasError>

impl Client

pub fn delete_scheduled_audit(&self) -> DeleteScheduledAuditFluentBuilder

Constructs a fluent builder for the DeleteScheduledAudit operation.

• The fluent builder is configurable:
  • scheduled_audit_name(impl Into<String>) / set_scheduled_audit_name(Option<String>):
    required: true
    

    The name of the scheduled audit you want to delete.

    
    
• On success, responds with DeleteScheduledAuditOutput
• On failure, responds with SdkError<DeleteScheduledAuditError>

impl Client

pub fn delete_security_profile(&self) -> DeleteSecurityProfileFluentBuilder

Constructs a fluent builder for the DeleteSecurityProfile operation.

• The fluent builder is configurable:
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: true
    

    The name of the security profile to be deleted.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

    
    
• On success, responds with DeleteSecurityProfileOutput
• On failure, responds with SdkError<DeleteSecurityProfileError>

impl Client

pub fn delete_stream(&self) -> DeleteStreamFluentBuilder

Constructs a fluent builder for the DeleteStream operation.

• The fluent builder is configurable:
  • stream_id(impl Into<String>) / set_stream_id(Option<String>):
    required: true
    

    The stream ID.

    
    
• On success, responds with DeleteStreamOutput
• On failure, responds with SdkError<DeleteStreamError>

impl Client

pub fn delete_thing(&self) -> DeleteThingFluentBuilder

Constructs a fluent builder for the DeleteThing operation.

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing to delete.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException.

    
    
• On success, responds with DeleteThingOutput
• On failure, responds with SdkError<DeleteThingError>

impl Client

pub fn delete_thing_group(&self) -> DeleteThingGroupFluentBuilder

Constructs a fluent builder for the DeleteThingGroup operation.

• The fluent builder is configurable:
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: true
    

    The name of the thing group to delete.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the thing group to delete.

    
    
• On success, responds with DeleteThingGroupOutput
• On failure, responds with SdkError<DeleteThingGroupError>

impl Client

pub fn delete_thing_type(&self) -> DeleteThingTypeFluentBuilder

Constructs a fluent builder for the DeleteThingType operation.

• The fluent builder is configurable:
  • thing_type_name(impl Into<String>) / set_thing_type_name(Option<String>):
    required: true
    

    The name of the thing type.

    
    
• On success, responds with DeleteThingTypeOutput
• On failure, responds with SdkError<DeleteThingTypeError>

impl Client

pub fn delete_topic_rule(&self) -> DeleteTopicRuleFluentBuilder

Constructs a fluent builder for the DeleteTopicRule operation.

• The fluent builder is configurable:
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the rule.

    
    
• On success, responds with DeleteTopicRuleOutput
• On failure, responds with SdkError<DeleteTopicRuleError>

impl Client

pub fn delete_topic_rule_destination( &self, ) -> DeleteTopicRuleDestinationFluentBuilder

Constructs a fluent builder for the DeleteTopicRuleDestination operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The ARN of the topic rule destination to delete.

    
    
• On success, responds with DeleteTopicRuleDestinationOutput
• On failure, responds with SdkError<DeleteTopicRuleDestinationError>

impl Client

pub fn delete_v2_logging_level(&self) -> DeleteV2LoggingLevelFluentBuilder

Constructs a fluent builder for the DeleteV2LoggingLevel operation.

• The fluent builder is configurable:
  • target_type(LogTargetType) / set_target_type(Option<LogTargetType>):
    required: true
    

    The type of resource for which you are configuring logging. Must be THING_Group.

    
    
  • target_name(impl Into<String>) / set_target_name(Option<String>):
    required: true
    

    The name of the resource for which you are configuring logging.

    
    
• On success, responds with DeleteV2LoggingLevelOutput
• On failure, responds with SdkError<DeleteV2LoggingLevelError>

impl Client

pub fn deprecate_thing_type(&self) -> DeprecateThingTypeFluentBuilder

Constructs a fluent builder for the DeprecateThingType operation.

• The fluent builder is configurable:
  • thing_type_name(impl Into<String>) / set_thing_type_name(Option<String>):
    required: true
    

    The name of the thing type to deprecate.

    
    
  • undo_deprecate(bool) / set_undo_deprecate(Option<bool>):
    required: false
    

    Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.

    
    
• On success, responds with DeprecateThingTypeOutput
• On failure, responds with SdkError<DeprecateThingTypeError>

impl Client

pub fn describe_account_audit_configuration( &self, ) -> DescribeAccountAuditConfigurationFluentBuilder

Constructs a fluent builder for the DescribeAccountAuditConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeAccountAuditConfigurationOutput with field(s):
  • role_arn(Option<String>):

    The ARN of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

    On the first call to UpdateAccountAuditConfiguration, this parameter is required.

  • audit_notification_target_configurations(Option<HashMap::<AuditNotificationType, AuditNotificationTarget>>):

    Information about the targets to which audit notifications are sent for this account.

  • audit_check_configurations(Option<HashMap::<String, AuditCheckConfiguration>>):

    Which audit checks are enabled and disabled for this account.

• On failure, responds with SdkError<DescribeAccountAuditConfigurationError>

impl Client

pub fn describe_audit_finding(&self) -> DescribeAuditFindingFluentBuilder

Constructs a fluent builder for the DescribeAuditFinding operation.

• The fluent builder is configurable:
  • finding_id(impl Into<String>) / set_finding_id(Option<String>):
    required: true
    

    A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.

    
    
• On success, responds with DescribeAuditFindingOutput with field(s):
  • finding(Option<AuditFinding>):

    The findings (results) of the audit.

• On failure, responds with SdkError<DescribeAuditFindingError>

impl Client

pub fn describe_audit_mitigation_actions_task( &self, ) -> DescribeAuditMitigationActionsTaskFluentBuilder

Constructs a fluent builder for the DescribeAuditMitigationActionsTask operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The unique identifier for the audit mitigation task.

    
    
• On success, responds with DescribeAuditMitigationActionsTaskOutput with field(s):
  • task_status(Option<AuditMitigationActionsTaskStatus>):

    The current status of the task.

  • start_time(Option<DateTime>):

    The date and time when the task was started.

  • end_time(Option<DateTime>):

    The date and time when the task was completed or canceled.

  • task_statistics(Option<HashMap::<String, TaskStatisticsForAuditCheck>>):

    Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

  • target(Option<AuditMitigationActionsTaskTarget>):

    Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

  • audit_check_to_actions_mapping(Option<HashMap::<String, Vec::<String>>>):

    Specifies the mitigation actions that should be applied to specific audit checks.

  • actions_definition(Option<Vec::<MitigationAction>>):

    Specifies the mitigation actions and their parameters that are applied as part of this task.

• On failure, responds with SdkError<DescribeAuditMitigationActionsTaskError>

impl Client

pub fn describe_audit_suppression( &self, ) -> DescribeAuditSuppressionFluentBuilder

Constructs a fluent builder for the DescribeAuditSuppression operation.

• The fluent builder is configurable:
  • check_name(impl Into<String>) / set_check_name(Option<String>):
    required: true
    

    An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

    
    
  • resource_identifier(ResourceIdentifier) / set_resource_identifier(Option<ResourceIdentifier>):
    required: true
    

    Information that identifies the noncompliant resource.

    
    
• On success, responds with DescribeAuditSuppressionOutput with field(s):
  • check_name(Option<String>):

    An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

  • resource_identifier(Option<ResourceIdentifier>):

    Information that identifies the noncompliant resource.

  • expiration_date(Option<DateTime>):

    The epoch timestamp in seconds at which this suppression expires.

  • suppress_indefinitely(Option<bool>):

    Indicates whether a suppression should exist indefinitely or not.

  • description(Option<String>):

    The description of the audit suppression.

• On failure, responds with SdkError<DescribeAuditSuppressionError>

impl Client

pub fn describe_audit_task(&self) -> DescribeAuditTaskFluentBuilder

Constructs a fluent builder for the DescribeAuditTask operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The ID of the audit whose information you want to get.

    
    
• On success, responds with DescribeAuditTaskOutput with field(s):
  • task_status(Option<AuditTaskStatus>):

    The status of the audit: one of “IN_PROGRESS”, “COMPLETED”, “FAILED”, or “CANCELED”.

  • task_type(Option<AuditTaskType>):

    The type of audit: “ON_DEMAND_AUDIT_TASK” or “SCHEDULED_AUDIT_TASK”.

  • task_start_time(Option<DateTime>):

    The time the audit started.

  • task_statistics(Option<TaskStatistics>):

    Statistical information about the audit.

  • scheduled_audit_name(Option<String>):

    The name of the scheduled audit (only if the audit was a scheduled audit).

  • audit_details(Option<HashMap::<String, AuditCheckDetails>>):

    Detailed information about each check performed during this audit.

• On failure, responds with SdkError<DescribeAuditTaskError>

impl Client

pub fn describe_authorizer(&self) -> DescribeAuthorizerFluentBuilder

Constructs a fluent builder for the DescribeAuthorizer operation.

• The fluent builder is configurable:
  • authorizer_name(impl Into<String>) / set_authorizer_name(Option<String>):
    required: true
    

    The name of the authorizer to describe.

    
    
• On success, responds with DescribeAuthorizerOutput with field(s):
  • authorizer_description(Option<AuthorizerDescription>):

    The authorizer description.

• On failure, responds with SdkError<DescribeAuthorizerError>

impl Client

pub fn describe_billing_group(&self) -> DescribeBillingGroupFluentBuilder

Constructs a fluent builder for the DescribeBillingGroup operation.

• The fluent builder is configurable:
  • billing_group_name(impl Into<String>) / set_billing_group_name(Option<String>):
    required: true
    

    The name of the billing group.

    
    
• On success, responds with DescribeBillingGroupOutput with field(s):
  • billing_group_name(Option<String>):

    The name of the billing group.

  • billing_group_id(Option<String>):

    The ID of the billing group.

  • billing_group_arn(Option<String>):

    The ARN of the billing group.

  • version(i64):

    The version of the billing group.

  • billing_group_properties(Option<BillingGroupProperties>):

    The properties of the billing group.

  • billing_group_metadata(Option<BillingGroupMetadata>):

    Additional information about the billing group.

• On failure, responds with SdkError<DescribeBillingGroupError>

impl Client

pub fn describe_ca_certificate(&self) -> DescribeCACertificateFluentBuilder

Constructs a fluent builder for the DescribeCACertificate operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The CA certificate identifier.

    
    
• On success, responds with DescribeCaCertificateOutput with field(s):
  • certificate_description(Option<CaCertificateDescription>):

    The CA certificate description.

  • registration_config(Option<RegistrationConfig>):

    Information about the registration configuration.

• On failure, responds with SdkError<DescribeCACertificateError>

impl Client

pub fn describe_certificate(&self) -> DescribeCertificateFluentBuilder

Constructs a fluent builder for the DescribeCertificate operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

    
    
• On success, responds with DescribeCertificateOutput with field(s):
  • certificate_description(Option<CertificateDescription>):

    The description of the certificate.

• On failure, responds with SdkError<DescribeCertificateError>

impl Client

pub fn describe_certificate_provider( &self, ) -> DescribeCertificateProviderFluentBuilder

Constructs a fluent builder for the DescribeCertificateProvider operation.

• The fluent builder is configurable:
  • certificate_provider_name(impl Into<String>) / set_certificate_provider_name(Option<String>):
    required: true
    

    The name of the certificate provider.

    
    
• On success, responds with DescribeCertificateProviderOutput with field(s):
  • certificate_provider_name(Option<String>):

    The name of the certificate provider.

  • certificate_provider_arn(Option<String>):

    The ARN of the certificate provider.

  • lambda_function_arn(Option<String>):

    The Lambda function ARN that’s associated with the certificate provider.

  • account_default_for_operations(Option<Vec::<CertificateProviderOperation>>):

    A list of the operations that the certificate provider will use to generate certificates. Valid value: CreateCertificateFromCsr.

  • creation_date(Option<DateTime>):

    The date-time string that indicates when the certificate provider was created.

  • last_modified_date(Option<DateTime>):

    The date-time string that indicates when the certificate provider was last updated.

• On failure, responds with SdkError<DescribeCertificateProviderError>

impl Client

pub fn describe_custom_metric(&self) -> DescribeCustomMetricFluentBuilder

Constructs a fluent builder for the DescribeCustomMetric operation.

• The fluent builder is configurable:
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    The name of the custom metric.

    
    
• On success, responds with DescribeCustomMetricOutput with field(s):
  • metric_name(Option<String>):

    The name of the custom metric.

  • metric_arn(Option<String>):

    The Amazon Resource Number (ARN) of the custom metric.

  • metric_type(Option<CustomMetricType>):

    The type of the custom metric.

    The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

  • display_name(Option<String>):

    Field represents a friendly name in the console for the custom metric; doesn’t have to be unique. Don’t use this name as the metric identifier in the device metric report. Can be updated.

  • creation_date(Option<DateTime>):

    The creation date of the custom metric in milliseconds since epoch.

  • last_modified_date(Option<DateTime>):

    The time the custom metric was last modified in milliseconds since epoch.

• On failure, responds with SdkError<DescribeCustomMetricError>

impl Client

pub fn describe_default_authorizer( &self, ) -> DescribeDefaultAuthorizerFluentBuilder

Constructs a fluent builder for the DescribeDefaultAuthorizer operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeDefaultAuthorizerOutput with field(s):
  • authorizer_description(Option<AuthorizerDescription>):

    The default authorizer’s description.

• On failure, responds with SdkError<DescribeDefaultAuthorizerError>

impl Client

pub fn describe_detect_mitigation_actions_task( &self, ) -> DescribeDetectMitigationActionsTaskFluentBuilder

Constructs a fluent builder for the DescribeDetectMitigationActionsTask operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The unique identifier of the task.

    
    
• On success, responds with DescribeDetectMitigationActionsTaskOutput with field(s):
  • task_summary(Option<DetectMitigationActionsTaskSummary>):

    The description of a task.

• On failure, responds with SdkError<DescribeDetectMitigationActionsTaskError>

impl Client

pub fn describe_dimension(&self) -> DescribeDimensionFluentBuilder

Constructs a fluent builder for the DescribeDimension operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The unique identifier for the dimension.

    
    
• On success, responds with DescribeDimensionOutput with field(s):
  • name(Option<String>):

    The unique identifier for the dimension.

  • arn(Option<String>):

    The Amazon Resource Name (ARN) for the dimension.

  • r#type(Option<DimensionType>):

    The type of the dimension.

  • string_values(Option<Vec::<String>>):

    The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

  • creation_date(Option<DateTime>):

    The date the dimension was created.

  • last_modified_date(Option<DateTime>):

    The date the dimension was last modified.

• On failure, responds with SdkError<DescribeDimensionError>

impl Client

pub fn describe_domain_configuration( &self, ) -> DescribeDomainConfigurationFluentBuilder

Constructs a fluent builder for the DescribeDomainConfiguration operation.

• The fluent builder is configurable:
  • domain_configuration_name(impl Into<String>) / set_domain_configuration_name(Option<String>):
    required: true
    

    The name of the domain configuration.

    
    
• On success, responds with DescribeDomainConfigurationOutput with field(s):
  • domain_configuration_name(Option<String>):

    The name of the domain configuration.

  • domain_configuration_arn(Option<String>):

    The ARN of the domain configuration.

  • domain_name(Option<String>):

    The name of the domain.

  • server_certificates(Option<Vec::<ServerCertificateSummary>>):

    A list containing summary information about the server certificate included in the domain configuration.

  • authorizer_config(Option<AuthorizerConfig>):

    An object that specifies the authorization service for a domain.

  • domain_configuration_status(Option<DomainConfigurationStatus>):

    A Boolean value that specifies the current state of the domain configuration.

  • service_type(Option<ServiceType>):

    The type of service delivered by the endpoint.

  • domain_type(Option<DomainType>):

    The type of the domain.

  • last_status_change_date(Option<DateTime>):

    The date and time the domain configuration’s status was last changed.

  • tls_config(Option<TlsConfig>):

    An object that specifies the TLS configuration for a domain.

  • server_certificate_config(Option<ServerCertificateConfig>):

    The server certificate configuration.

  • authentication_type(Option<AuthenticationType>):

    An enumerated string that specifies the authentication type.

    • CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

    • CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

    • AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

    • AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

    • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

  • application_protocol(Option<ApplicationProtocol>):

    An enumerated string that specifies the application-layer protocol.

    • SECURE_MQTT - MQTT over TLS.

    • MQTT_WSS - MQTT over WebSocket.

    • HTTPS - HTTP over TLS.

    • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

  • client_certificate_config(Option<ClientCertificateConfig>):

    An object that specifies the client certificate configuration for a domain.

• On failure, responds with SdkError<DescribeDomainConfigurationError>

impl Client

pub fn describe_endpoint(&self) -> DescribeEndpointFluentBuilder

Constructs a fluent builder for the DescribeEndpoint operation.

• The fluent builder is configurable:
  • endpoint_type(impl Into<String>) / set_endpoint_type(Option<String>):
    required: false
    

    The endpoint type. Valid endpoint types include:

    • iot:Data - Returns a VeriSign signed data endpoint.

    • iot:Data-ATS - Returns an ATS signed data endpoint.

    • iot:CredentialProvider - Returns an IoT credentials provider API endpoint.

    • iot:Jobs - Returns an IoT device management Jobs API endpoint.

    We strongly recommend that customers use the newer iot:Data-ATS endpoint type to avoid issues related to the widespread distrust of Symantec certificate authorities. ATS Signed Certificates are more secure and are trusted by most popular browsers.

    
    
• On success, responds with DescribeEndpointOutput with field(s):
  • endpoint_address(Option<String>):

    The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.

• On failure, responds with SdkError<DescribeEndpointError>

impl Client

pub fn describe_event_configurations( &self, ) -> DescribeEventConfigurationsFluentBuilder

Constructs a fluent builder for the DescribeEventConfigurations operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeEventConfigurationsOutput with field(s):
  • event_configurations(Option<HashMap::<EventType, Configuration>>):

    The event configurations.

  • creation_date(Option<DateTime>):

    The creation date of the event configuration.

  • last_modified_date(Option<DateTime>):

    The date the event configurations were last modified.

• On failure, responds with SdkError<DescribeEventConfigurationsError>

impl Client

pub fn describe_fleet_metric(&self) -> DescribeFleetMetricFluentBuilder

Constructs a fluent builder for the DescribeFleetMetric operation.

• The fluent builder is configurable:
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    The name of the fleet metric to describe.

    
    
• On success, responds with DescribeFleetMetricOutput with field(s):
  • metric_name(Option<String>):

    The name of the fleet metric to describe.

  • query_string(Option<String>):

    The search query string.

  • aggregation_type(Option<AggregationType>):

    The type of the aggregation query.

  • period(Option<i32>):

    The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

  • aggregation_field(Option<String>):

    The field to aggregate.

  • description(Option<String>):

    The fleet metric description.

  • query_version(Option<String>):

    The query version.

  • index_name(Option<String>):

    The name of the index to search.

  • creation_date(Option<DateTime>):

    The date when the fleet metric is created.

  • last_modified_date(Option<DateTime>):

    The date when the fleet metric is last modified.

  • unit(Option<FleetMetricUnit>):

    Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

  • version(i64):

    The version of the fleet metric.

  • metric_arn(Option<String>):

    The ARN of the fleet metric to describe.

• On failure, responds with SdkError<DescribeFleetMetricError>

impl Client

pub fn describe_index(&self) -> DescribeIndexFluentBuilder

Constructs a fluent builder for the DescribeIndex operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The index name.

    
    
• On success, responds with DescribeIndexOutput with field(s):
  • index_name(Option<String>):

    The index name.

  • index_status(Option<IndexStatus>):

    The index status.

  • schema(Option<String>):

    Contains a value that specifies the type of indexing performed. Valid values are:

    • REGISTRY – Your thing index contains only registry data.

    • REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.

    • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

    • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

    • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

• On failure, responds with SdkError<DescribeIndexError>

impl Client

pub fn describe_job(&self) -> DescribeJobFluentBuilder

Constructs a fluent builder for the DescribeJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier you assigned to this job when it was created.

    
    
  • before_substitution(bool) / set_before_substitution(Option<bool>):
    required: false
    

    Provides a view of the job document before and after the substitution parameters have been resolved with their exact values.

    
    
• On success, responds with DescribeJobOutput with field(s):
  • document_source(Option<String>):

    An S3 link to the job document.

  • job(Option<Job>):

    Information about the job.

• On failure, responds with SdkError<DescribeJobError>

impl Client

pub fn describe_job_execution(&self) -> DescribeJobExecutionFluentBuilder

Constructs a fluent builder for the DescribeJobExecution operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier you assigned to this job when it was created.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing on which the job execution is running.

    
    
  • execution_number(i64) / set_execution_number(Option<i64>):
    required: false
    

    A string (consisting of the digits “0” through “9” which is used to specify a particular job execution on a particular device.

    
    
• On success, responds with DescribeJobExecutionOutput with field(s):
  • execution(Option<JobExecution>):

    Information about the job execution.

• On failure, responds with SdkError<DescribeJobExecutionError>

impl Client

pub fn describe_job_template(&self) -> DescribeJobTemplateFluentBuilder

Constructs a fluent builder for the DescribeJobTemplate operation.

• The fluent builder is configurable:
  • job_template_id(impl Into<String>) / set_job_template_id(Option<String>):
    required: true
    

    The unique identifier of the job template.

    
    
• On success, responds with DescribeJobTemplateOutput with field(s):
  • job_template_arn(Option<String>):

    The ARN of the job template.

  • job_template_id(Option<String>):

    The unique identifier of the job template.

  • description(Option<String>):

    A description of the job template.

  • document_source(Option<String>):

    An S3 link to the job document.

  • document(Option<String>):

    The job document.

  • created_at(Option<DateTime>):

    The time, in seconds since the epoch, when the job template was created.

  • presigned_url_config(Option<PresignedUrlConfig>):

    Configuration for pre-signed S3 URLs.

  • job_executions_rollout_config(Option<JobExecutionsRolloutConfig>):

    Allows you to create a staged rollout of a job.

  • abort_config(Option<AbortConfig>):

    The criteria that determine when and how a job abort takes place.

  • timeout_config(Option<TimeoutConfig>):

    Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

  • job_executions_retry_config(Option<JobExecutionsRetryConfig>):

    The configuration that determines how many retries are allowed for each failure type for a job.

  • maintenance_windows(Option<Vec::<MaintenanceWindow>>):

    Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

  • destination_package_versions(Option<Vec::<String>>):

    The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

• On failure, responds with SdkError<DescribeJobTemplateError>

impl Client

pub fn describe_managed_job_template( &self, ) -> DescribeManagedJobTemplateFluentBuilder

Constructs a fluent builder for the DescribeManagedJobTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The unique name of a managed job template, which is required.

    
    
  • template_version(impl Into<String>) / set_template_version(Option<String>):
    required: false
    

    An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned.

    
    
• On success, responds with DescribeManagedJobTemplateOutput with field(s):
  • template_name(Option<String>):

    The unique name of a managed template, such as AWS-Reboot.

  • template_arn(Option<String>):

    The unique Amazon Resource Name (ARN) of the managed template.

  • description(Option<String>):

    The unique description of a managed template.

  • template_version(Option<String>):

    The version for a managed template.

  • environments(Option<Vec::<String>>):

    A list of environments that are supported with the managed job template.

  • document_parameters(Option<Vec::<DocumentParameter>>):

    A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.

    documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can’t be used with custom job templates or to create jobs from them.

  • document(Option<String>):

    The document schema for a managed job template.

• On failure, responds with SdkError<DescribeManagedJobTemplateError>

impl Client

pub fn describe_mitigation_action( &self, ) -> DescribeMitigationActionFluentBuilder

Constructs a fluent builder for the DescribeMitigationAction operation.

• The fluent builder is configurable:
  • action_name(impl Into<String>) / set_action_name(Option<String>):
    required: true
    

    The friendly name that uniquely identifies the mitigation action.

    
    
• On success, responds with DescribeMitigationActionOutput with field(s):
  • action_name(Option<String>):

    The friendly name that uniquely identifies the mitigation action.

  • action_type(Option<MitigationActionType>):

    The type of mitigation action.

  • action_arn(Option<String>):

    The ARN that identifies this migration action.

  • action_id(Option<String>):

    A unique identifier for this action.

  • role_arn(Option<String>):

    The ARN of the IAM role used to apply this action.

  • action_params(Option<MitigationActionParams>):

    Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

  • creation_date(Option<DateTime>):

    The date and time when the mitigation action was added to your Amazon Web Services accounts.

  • last_modified_date(Option<DateTime>):

    The date and time when the mitigation action was last changed.

• On failure, responds with SdkError<DescribeMitigationActionError>

impl Client

pub fn describe_provisioning_template( &self, ) -> DescribeProvisioningTemplateFluentBuilder

Constructs a fluent builder for the DescribeProvisioningTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the provisioning template.

    
    
• On success, responds with DescribeProvisioningTemplateOutput with field(s):
  • template_arn(Option<String>):

    The ARN of the provisioning template.

  • template_name(Option<String>):

    The name of the provisioning template.

  • description(Option<String>):

    The description of the provisioning template.

  • creation_date(Option<DateTime>):

    The date when the provisioning template was created.

  • last_modified_date(Option<DateTime>):

    The date when the provisioning template was last modified.

  • default_version_id(Option<i32>):

    The default fleet template version ID.

  • template_body(Option<String>):

    The JSON formatted contents of the provisioning template.

  • enabled(Option<bool>):

    True if the provisioning template is enabled, otherwise false.

  • provisioning_role_arn(Option<String>):

    The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.

  • pre_provisioning_hook(Option<ProvisioningHook>):

    Gets information about a pre-provisioned hook.

  • r#type(Option<TemplateType>):

    The type you define in a provisioning template. You can create a template with only one type. You can’t change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

• On failure, responds with SdkError<DescribeProvisioningTemplateError>

impl Client

pub fn describe_provisioning_template_version( &self, ) -> DescribeProvisioningTemplateVersionFluentBuilder

Constructs a fluent builder for the DescribeProvisioningTemplateVersion operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The template name.

    
    
  • version_id(i32) / set_version_id(Option<i32>):
    required: true
    

    The provisioning template version ID.

    
    
• On success, responds with DescribeProvisioningTemplateVersionOutput with field(s):
  • version_id(Option<i32>):

    The provisioning template version ID.

  • creation_date(Option<DateTime>):

    The date when the provisioning template version was created.

  • template_body(Option<String>):

    The JSON formatted contents of the provisioning template version.

  • is_default_version(bool):

    True if the provisioning template version is the default version.

• On failure, responds with SdkError<DescribeProvisioningTemplateVersionError>

impl Client

pub fn describe_role_alias(&self) -> DescribeRoleAliasFluentBuilder

Constructs a fluent builder for the DescribeRoleAlias operation.

• The fluent builder is configurable:
  • role_alias(impl Into<String>) / set_role_alias(Option<String>):
    required: true
    

    The role alias to describe.

    
    
• On success, responds with DescribeRoleAliasOutput with field(s):
  • role_alias_description(Option<RoleAliasDescription>):

    The role alias description.

• On failure, responds with SdkError<DescribeRoleAliasError>

impl Client

pub fn describe_scheduled_audit(&self) -> DescribeScheduledAuditFluentBuilder

Constructs a fluent builder for the DescribeScheduledAudit operation.

• The fluent builder is configurable:
  • scheduled_audit_name(impl Into<String>) / set_scheduled_audit_name(Option<String>):
    required: true
    

    The name of the scheduled audit whose information you want to get.

    
    
• On success, responds with DescribeScheduledAuditOutput with field(s):
  • frequency(Option<AuditFrequency>):

    How often the scheduled audit takes place, either one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.

  • day_of_month(Option<String>):

    The day of the month on which the scheduled audit takes place. This is will be 1 through 31 or LAST. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the LAST day of the month.

  • day_of_week(Option<DayOfWeek>):

    The day of the week on which the scheduled audit takes place, either one of SUN, MON, TUE, WED, THU, FRI, or SAT.

  • target_check_names(Option<Vec::<String>>):

    Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

  • scheduled_audit_name(Option<String>):

    The name of the scheduled audit.

  • scheduled_audit_arn(Option<String>):

    The ARN of the scheduled audit.

• On failure, responds with SdkError<DescribeScheduledAuditError>

impl Client

pub fn describe_security_profile(&self) -> DescribeSecurityProfileFluentBuilder

Constructs a fluent builder for the DescribeSecurityProfile operation.

• The fluent builder is configurable:
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: true
    

    The name of the security profile whose information you want to get.

    
    
• On success, responds with DescribeSecurityProfileOutput with field(s):
  • security_profile_name(Option<String>):

    The name of the security profile.

  • security_profile_arn(Option<String>):

    The ARN of the security profile.

  • security_profile_description(Option<String>):

    A description of the security profile (associated with the security profile when it was created or updated).

  • behaviors(Option<Vec::<Behavior>>):

    Specifies the behaviors that, when violated by a device (thing), cause an alert.

  • alert_targets(Option<HashMap::<AlertTargetType, AlertTarget>>):

    Where the alerts are sent. (Alerts are always sent to the console.)

  • additional_metrics_to_retain(Option<Vec::<String>>):

    Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors, but it is also retained for any metric specified here.

  • additional_metrics_to_retain_v2(Option<Vec::<MetricToRetain>>):

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors, but it is also retained for any metric specified here.

  • version(i64):

    The version of the security profile. A new version is generated whenever the security profile is updated.

  • creation_date(Option<DateTime>):

    The time the security profile was created.

  • last_modified_date(Option<DateTime>):

    The time the security profile was last modified.

  • metrics_export_config(Option<MetricsExportConfig>):

    Specifies the MQTT topic and role ARN required for metric export.

• On failure, responds with SdkError<DescribeSecurityProfileError>

impl Client

pub fn describe_stream(&self) -> DescribeStreamFluentBuilder

Constructs a fluent builder for the DescribeStream operation.

• The fluent builder is configurable:
  • stream_id(impl Into<String>) / set_stream_id(Option<String>):
    required: true
    

    The stream ID.

    
    
• On success, responds with DescribeStreamOutput with field(s):
  • stream_info(Option<StreamInfo>):

    Information about the stream.

• On failure, responds with SdkError<DescribeStreamError>

impl Client

pub fn describe_thing(&self) -> DescribeThingFluentBuilder

Constructs a fluent builder for the DescribeThing operation.

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing.

    
    
• On success, responds with DescribeThingOutput with field(s):
  • default_client_id(Option<String>):

    The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing’s registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

    This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

  • thing_name(Option<String>):

    The name of the thing.

  • thing_id(Option<String>):

    The ID of the thing to describe.

  • thing_arn(Option<String>):

    The ARN of the thing to describe.

  • thing_type_name(Option<String>):

    The thing type name.

  • attributes(Option<HashMap::<String, String>>):

    The thing attributes.

  • version(i64):

    The current version of the thing record in the registry.

    To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

  • billing_group_name(Option<String>):

    The name of the billing group the thing belongs to.

• On failure, responds with SdkError<DescribeThingError>

impl Client

pub fn describe_thing_group(&self) -> DescribeThingGroupFluentBuilder

Constructs a fluent builder for the DescribeThingGroup operation.

• The fluent builder is configurable:
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: true
    

    The name of the thing group.

    
    
• On success, responds with DescribeThingGroupOutput with field(s):
  • thing_group_name(Option<String>):

    The name of the thing group.

  • thing_group_id(Option<String>):

    The thing group ID.

  • thing_group_arn(Option<String>):

    The thing group ARN.

  • version(i64):

    The version of the thing group.

  • thing_group_properties(Option<ThingGroupProperties>):

    The thing group properties.

  • thing_group_metadata(Option<ThingGroupMetadata>):

    Thing group metadata.

  • index_name(Option<String>):

    The dynamic thing group index name.

  • query_string(Option<String>):

    The dynamic thing group search query string.

  • query_version(Option<String>):

    The dynamic thing group query version.

  • status(Option<DynamicGroupStatus>):

    The dynamic thing group status.

• On failure, responds with SdkError<DescribeThingGroupError>

impl Client

pub fn describe_thing_registration_task( &self, ) -> DescribeThingRegistrationTaskFluentBuilder

Constructs a fluent builder for the DescribeThingRegistrationTask operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The task ID.

    
    
• On success, responds with DescribeThingRegistrationTaskOutput with field(s):
  • task_id(Option<String>):

    The task ID.

  • creation_date(Option<DateTime>):

    The task creation date.

  • last_modified_date(Option<DateTime>):

    The date when the task was last modified.

  • template_body(Option<String>):

    The task’s template.

  • input_file_bucket(Option<String>):

    The S3 bucket that contains the input file.

  • input_file_key(Option<String>):

    The input file key.

  • role_arn(Option<String>):

    The role ARN that grants access to the input file bucket.

  • status(Option<Status>):

    The status of the bulk thing provisioning task.

  • message(Option<String>):

    The message.

  • success_count(i32):

    The number of things successfully provisioned.

  • failure_count(i32):

    The number of things that failed to be provisioned.

  • percentage_progress(i32):

    The progress of the bulk provisioning task expressed as a percentage.

• On failure, responds with SdkError<DescribeThingRegistrationTaskError>

impl Client

pub fn describe_thing_type(&self) -> DescribeThingTypeFluentBuilder

Constructs a fluent builder for the DescribeThingType operation.

• The fluent builder is configurable:
  • thing_type_name(impl Into<String>) / set_thing_type_name(Option<String>):
    required: true
    

    The name of the thing type.

    
    
• On success, responds with DescribeThingTypeOutput with field(s):
  • thing_type_name(Option<String>):

    The name of the thing type.

  • thing_type_id(Option<String>):

    The thing type ID.

  • thing_type_arn(Option<String>):

    The thing type ARN.

  • thing_type_properties(Option<ThingTypeProperties>):

    The ThingTypeProperties contains information about the thing type including description, a list of searchable thing attribute names, and MQTT5 configuration.

  • thing_type_metadata(Option<ThingTypeMetadata>):

    The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.

• On failure, responds with SdkError<DescribeThingTypeError>

impl Client

pub fn detach_policy(&self) -> DetachPolicyFluentBuilder

Constructs a fluent builder for the DetachPolicy operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The policy to detach.

    
    
  • target(impl Into<String>) / set_target(Option<String>):
    required: true
    

    The target from which the policy will be detached.

    
    
• On success, responds with DetachPolicyOutput
• On failure, responds with SdkError<DetachPolicyError>

impl Client

pub fn detach_principal_policy(&self) -> DetachPrincipalPolicyFluentBuilder

👎Deprecated

Constructs a fluent builder for the DetachPrincipalPolicy operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The name of the policy to detach.

    
    
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: true
    

    The principal.

    Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

    
    
• On success, responds with DetachPrincipalPolicyOutput
• On failure, responds with SdkError<DetachPrincipalPolicyError>

impl Client

pub fn detach_security_profile(&self) -> DetachSecurityProfileFluentBuilder

Constructs a fluent builder for the DetachSecurityProfile operation.

• The fluent builder is configurable:
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: true
    

    The security profile that is detached.

    
    
  • security_profile_target_arn(impl Into<String>) / set_security_profile_target_arn(Option<String>):
    required: true
    

    The ARN of the thing group from which the security profile is detached.

    
    
• On success, responds with DetachSecurityProfileOutput
• On failure, responds with SdkError<DetachSecurityProfileError>

impl Client

pub fn detach_thing_principal(&self) -> DetachThingPrincipalFluentBuilder

Constructs a fluent builder for the DetachThingPrincipal operation.

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing.

    
    
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: true
    

    If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.

    
    
• On success, responds with DetachThingPrincipalOutput
• On failure, responds with SdkError<DetachThingPrincipalError>

impl Client

pub fn disable_topic_rule(&self) -> DisableTopicRuleFluentBuilder

Constructs a fluent builder for the DisableTopicRule operation.

• The fluent builder is configurable:
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the rule to disable.

    
    
• On success, responds with DisableTopicRuleOutput
• On failure, responds with SdkError<DisableTopicRuleError>

impl Client

pub fn disassociate_sbom_from_package_version( &self, ) -> DisassociateSbomFromPackageVersionFluentBuilder

Constructs a fluent builder for the DisassociateSbomFromPackageVersion operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the new software package.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name of the new package version.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    
    
• On success, responds with DisassociateSbomFromPackageVersionOutput
• On failure, responds with SdkError<DisassociateSbomFromPackageVersionError>

impl Client

pub fn enable_topic_rule(&self) -> EnableTopicRuleFluentBuilder

Constructs a fluent builder for the EnableTopicRule operation.

• The fluent builder is configurable:
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the topic rule to enable.

    
    
• On success, responds with EnableTopicRuleOutput
• On failure, responds with SdkError<EnableTopicRuleError>

impl Client

pub fn get_behavior_model_training_summaries( &self, ) -> GetBehaviorModelTrainingSummariesFluentBuilder

Constructs a fluent builder for the GetBehaviorModelTrainingSummaries operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: false
    

    The name of the security profile.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 10.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
• On success, responds with GetBehaviorModelTrainingSummariesOutput with field(s):
  • summaries(Option<Vec::<BehaviorModelTrainingSummary>>):

    A list of all ML Detect behaviors and their model status for a given Security Profile.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<GetBehaviorModelTrainingSummariesError>

impl Client

pub fn get_buckets_aggregation(&self) -> GetBucketsAggregationFluentBuilder

Constructs a fluent builder for the GetBucketsAggregation operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the index to search.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The search query string.

    
    
  • aggregation_field(impl Into<String>) / set_aggregation_field(Option<String>):
    required: true
    

    The aggregation field.

    
    
  • query_version(impl Into<String>) / set_query_version(Option<String>):
    required: false
    

    The version of the query.

    
    
  • buckets_aggregation_type(BucketsAggregationType) / set_buckets_aggregation_type(Option<BucketsAggregationType>):
    required: true
    

    The basic control of the response shape and the bucket aggregation type to perform.

    
    
• On success, responds with GetBucketsAggregationOutput with field(s):
  • total_count(i32):

    The total number of things that fit the query string criteria.

  • buckets(Option<Vec::<Bucket>>):

    The main part of the response with a list of buckets. Each bucket contains a keyValue and a count.

    keyValue: The aggregation field value counted for the particular bucket.

    count: The number of documents that have that value.

• On failure, responds with SdkError<GetBucketsAggregationError>

impl Client

pub fn get_cardinality(&self) -> GetCardinalityFluentBuilder

Constructs a fluent builder for the GetCardinality operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the index to search.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The search query string.

    
    
  • aggregation_field(impl Into<String>) / set_aggregation_field(Option<String>):
    required: false
    

    The field to aggregate.

    
    
  • query_version(impl Into<String>) / set_query_version(Option<String>):
    required: false
    

    The query version.

    
    
• On success, responds with GetCardinalityOutput with field(s):
  • cardinality(i32):

    The approximate count of unique values that match the query.

• On failure, responds with SdkError<GetCardinalityError>

impl Client

pub fn get_command(&self) -> GetCommandFluentBuilder

Constructs a fluent builder for the GetCommand operation.

• The fluent builder is configurable:
  • command_id(impl Into<String>) / set_command_id(Option<String>):
    required: true
    

    The unique identifier of the command for which you want to retrieve information.

    
    
• On success, responds with GetCommandOutput with field(s):
  • command_id(Option<String>):

    The unique identifier of the command.

  • command_arn(Option<String>):

    The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot: : :command/

  • namespace(Option<CommandNamespace>):

    The namespace of the command.

  • display_name(Option<String>):

    The user-friendly name in the console for the command.

  • description(Option<String>):

    A short text description of the command.

  • mandatory_parameters(Option<Vec::<CommandParameter>>):

    A list of parameters for the command created.

  • payload(Option<CommandPayload>):

    The payload object that you provided for the command.

  • role_arn(Option<String>):

    The IAM role that you provided when creating the command with AWS-IoT-FleetWise as the namespace.

  • created_at(Option<DateTime>):

    The timestamp, when the command was created.

  • last_updated_at(Option<DateTime>):

    The timestamp, when the command was last updated.

  • deprecated(Option<bool>):

    Indicates whether the command has been deprecated.

  • pending_deletion(Option<bool>):

    Indicates whether the command is being deleted.

• On failure, responds with SdkError<GetCommandError>

impl Client

pub fn get_command_execution(&self) -> GetCommandExecutionFluentBuilder

Constructs a fluent builder for the GetCommandExecution operation.

• The fluent builder is configurable:
  • execution_id(impl Into<String>) / set_execution_id(Option<String>):
    required: true
    

    The unique identifier for the command execution. This information is returned as a response of the StartCommandExecution API request.

    
    
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: true
    

    The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

    
    
  • include_result(bool) / set_include_result(Option<bool>):
    required: false
    

    Can be used to specify whether to include the result of the command execution in the GetCommandExecution API response. Your device can use this field to provide additional information about the command execution. You only need to specify this field when using the AWS-IoT namespace.

    
    
• On success, responds with GetCommandExecutionOutput with field(s):
  • execution_id(Option<String>):

    The unique identifier of the command execution.

  • command_arn(Option<String>):

    The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot: : :command/

  • target_arn(Option<String>):

    The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

  • status(Option<CommandExecutionStatus>):

    The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the UpdateCommandExecution MQTT API to update the status information.

  • status_reason(Option<StatusReason>):

    Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.

  • result(Option<HashMap::<String, CommandExecutionResult>>):

    The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.

    If you use the AWS-IoT-FleetWise namespace, then this field is not applicable in the API response.

  • parameters(Option<HashMap::<String, CommandParameterValue>>):

    The list of parameters that the StartCommandExecution API used when performing the command on the device.

  • execution_timeout_seconds(Option<i64>):

    Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to TIMED_OUT.

  • created_at(Option<DateTime>):

    The timestamp, when the command execution was created.

  • last_updated_at(Option<DateTime>):

    The timestamp, when the command execution was last updated.

  • started_at(Option<DateTime>):

    The timestamp, when the command execution was started.

  • completed_at(Option<DateTime>):

    The timestamp, when the command execution was completed.

  • time_to_live(Option<DateTime>):

    The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.

• On failure, responds with SdkError<GetCommandExecutionError>

impl Client

pub fn get_effective_policies(&self) -> GetEffectivePoliciesFluentBuilder

Constructs a fluent builder for the GetEffectivePolicies operation.

• The fluent builder is configurable:
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: false
    

    The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

    
    
  • cognito_identity_pool_id(impl Into<String>) / set_cognito_identity_pool_id(Option<String>):
    required: false
    

    The Cognito identity pool ID.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: false
    

    The thing name.

    
    
• On success, responds with GetEffectivePoliciesOutput with field(s):
  • effective_policies(Option<Vec::<EffectivePolicy>>):

    The effective policies.

• On failure, responds with SdkError<GetEffectivePoliciesError>

impl Client

pub fn get_indexing_configuration( &self, ) -> GetIndexingConfigurationFluentBuilder

Constructs a fluent builder for the GetIndexingConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetIndexingConfigurationOutput with field(s):
  • thing_indexing_configuration(Option<ThingIndexingConfiguration>):

    Thing indexing configuration.

  • thing_group_indexing_configuration(Option<ThingGroupIndexingConfiguration>):

    The index configuration.

• On failure, responds with SdkError<GetIndexingConfigurationError>

impl Client

pub fn get_job_document(&self) -> GetJobDocumentFluentBuilder

Constructs a fluent builder for the GetJobDocument operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier you assigned to this job when it was created.

    
    
  • before_substitution(bool) / set_before_substitution(Option<bool>):
    required: false
    

    Provides a view of the job document before and after the substitution parameters have been resolved with their exact values.

    
    
• On success, responds with GetJobDocumentOutput with field(s):
  • document(Option<String>):

    The job document content.

• On failure, responds with SdkError<GetJobDocumentError>

impl Client

pub fn get_logging_options(&self) -> GetLoggingOptionsFluentBuilder

Constructs a fluent builder for the GetLoggingOptions operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetLoggingOptionsOutput with field(s):
  • role_arn(Option<String>):

    The ARN of the IAM role that grants access.

  • log_level(Option<LogLevel>):

    The logging level.

• On failure, responds with SdkError<GetLoggingOptionsError>

impl Client

pub fn get_ota_update(&self) -> GetOTAUpdateFluentBuilder

Constructs a fluent builder for the GetOTAUpdate operation.

• The fluent builder is configurable:
  • ota_update_id(impl Into<String>) / set_ota_update_id(Option<String>):
    required: true
    

    The OTA update ID.

    
    
• On success, responds with GetOtaUpdateOutput with field(s):
  • ota_update_info(Option<OtaUpdateInfo>):

    The OTA update info.

• On failure, responds with SdkError<GetOTAUpdateError>

impl Client

pub fn get_package(&self) -> GetPackageFluentBuilder

Constructs a fluent builder for the GetPackage operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the target software package.

    
    
• On success, responds with GetPackageOutput with field(s):
  • package_name(Option<String>):

    The name of the software package.

  • package_arn(Option<String>):

    The ARN for the package.

  • description(Option<String>):

    The package description.

  • default_version_name(Option<String>):

    The name of the default package version.

  • creation_date(Option<DateTime>):

    The date the package was created.

  • last_modified_date(Option<DateTime>):

    The date when the package was last updated.

• On failure, responds with SdkError<GetPackageError>

impl Client

pub fn get_package_configuration(&self) -> GetPackageConfigurationFluentBuilder

Constructs a fluent builder for the GetPackageConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetPackageConfigurationOutput with field(s):
  • version_update_by_jobs_config(Option<VersionUpdateByJobsConfig>):

    The version that is associated to a specific job.

• On failure, responds with SdkError<GetPackageConfigurationError>

impl Client

pub fn get_package_version(&self) -> GetPackageVersionFluentBuilder

Constructs a fluent builder for the GetPackageVersion operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the associated package.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name of the target package version.

    
    
• On success, responds with GetPackageVersionOutput with field(s):
  • package_version_arn(Option<String>):

    The ARN for the package version.

  • package_name(Option<String>):

    The name of the software package.

  • version_name(Option<String>):

    The name of the package version.

  • description(Option<String>):

    The package version description.

  • attributes(Option<HashMap::<String, String>>):

    Metadata that were added to the package version that can be used to define a package version’s configuration.

  • artifact(Option<PackageVersionArtifact>):

    The various components that make up a software package version.

  • status(Option<PackageVersionStatus>):

    The status associated to the package version. For more information, see Package version lifecycle.

  • error_reason(Option<String>):

    Error reason for a package version failure during creation or update.

  • creation_date(Option<DateTime>):

    The date when the package version was created.

  • last_modified_date(Option<DateTime>):

    The date when the package version was last updated.

  • sbom(Option<Sbom>):

    The software bill of materials for a software package version.

  • sbom_validation_status(Option<SbomValidationStatus>):

    The status of the validation for a new software bill of materials added to a software package version.

  • recipe(Option<String>):

    The inline job document associated with a software package version used for a quick job deployment.

• On failure, responds with SdkError<GetPackageVersionError>

impl Client

pub fn get_percentiles(&self) -> GetPercentilesFluentBuilder

Constructs a fluent builder for the GetPercentiles operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the index to search.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The search query string.

    
    
  • aggregation_field(impl Into<String>) / set_aggregation_field(Option<String>):
    required: false
    

    The field to aggregate.

    
    
  • query_version(impl Into<String>) / set_query_version(Option<String>):
    required: false
    

    The query version.

    
    
  • percents(f64) / set_percents(Option<Vec::<f64>>):
    required: false
    

    The percentile groups returned.

    
    
• On success, responds with GetPercentilesOutput with field(s):
  • percentiles(Option<Vec::<PercentPair>>):

    The percentile values of the aggregated fields.

• On failure, responds with SdkError<GetPercentilesError>

impl Client

pub fn get_policy(&self) -> GetPolicyFluentBuilder

Constructs a fluent builder for the GetPolicy operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The name of the policy.

    
    
• On success, responds with GetPolicyOutput with field(s):
  • policy_name(Option<String>):

    The policy name.

  • policy_arn(Option<String>):

    The policy ARN.

  • policy_document(Option<String>):

    The JSON document that describes the policy.

  • default_version_id(Option<String>):

    The default policy version ID.

  • creation_date(Option<DateTime>):

    The date the policy was created.

  • last_modified_date(Option<DateTime>):

    The date the policy was last modified.

  • generation_id(Option<String>):

    The generation ID of the policy.

• On failure, responds with SdkError<GetPolicyError>

impl Client

pub fn get_policy_version(&self) -> GetPolicyVersionFluentBuilder

Constructs a fluent builder for the GetPolicyVersion operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The name of the policy.

    
    
  • policy_version_id(impl Into<String>) / set_policy_version_id(Option<String>):
    required: true
    

    The policy version ID.

    
    
• On success, responds with GetPolicyVersionOutput with field(s):
  • policy_arn(Option<String>):

    The policy ARN.

  • policy_name(Option<String>):

    The policy name.

  • policy_document(Option<String>):

    The JSON document that describes the policy.

  • policy_version_id(Option<String>):

    The policy version ID.

  • is_default_version(bool):

    Specifies whether the policy version is the default.

  • creation_date(Option<DateTime>):

    The date the policy was created.

  • last_modified_date(Option<DateTime>):

    The date the policy was last modified.

  • generation_id(Option<String>):

    The generation ID of the policy version.

• On failure, responds with SdkError<GetPolicyVersionError>

impl Client

pub fn get_registration_code(&self) -> GetRegistrationCodeFluentBuilder

Constructs a fluent builder for the GetRegistrationCode operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetRegistrationCodeOutput with field(s):
  • registration_code(Option<String>):

    The CA certificate registration code.

• On failure, responds with SdkError<GetRegistrationCodeError>

impl Client

pub fn get_statistics(&self) -> GetStatisticsFluentBuilder

Constructs a fluent builder for the GetStatistics operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The name of the index to search. The default value is AWS_Things.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The query used to search. You can specify “*” for the query string to get the count of all indexed things in your Amazon Web Services account.

    
    
  • aggregation_field(impl Into<String>) / set_aggregation_field(Option<String>):
    required: false
    

    The aggregation field name.

    
    
  • query_version(impl Into<String>) / set_query_version(Option<String>):
    required: false
    

    The version of the query used to search.

    
    
• On success, responds with GetStatisticsOutput with field(s):
  • statistics(Option<Statistics>):

    The statistics returned by the Fleet Indexing service based on the query and aggregation field.

• On failure, responds with SdkError<GetStatisticsError>

impl Client

pub fn get_thing_connectivity_data( &self, ) -> GetThingConnectivityDataFluentBuilder

Constructs a fluent builder for the GetThingConnectivityData operation.

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of your IoT thing.

    
    
• On success, responds with GetThingConnectivityDataOutput with field(s):
  • thing_name(Option<String>):

    The name of your IoT thing.

  • connected(Option<bool>):

    A Boolean that indicates the connectivity status.

  • timestamp(Option<DateTime>):

    The timestamp of when the event occurred.

  • disconnect_reason(Option<DisconnectReasonValue>):

    The reason why the client is disconnecting.

• On failure, responds with SdkError<GetThingConnectivityDataError>

impl Client

pub fn get_topic_rule(&self) -> GetTopicRuleFluentBuilder

Constructs a fluent builder for the GetTopicRule operation.

• The fluent builder is configurable:
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the rule.

    
    
• On success, responds with GetTopicRuleOutput with field(s):
  • rule_arn(Option<String>):

    The rule ARN.

  • rule(Option<TopicRule>):

    The rule.

• On failure, responds with SdkError<GetTopicRuleError>

impl Client

pub fn get_topic_rule_destination(&self) -> GetTopicRuleDestinationFluentBuilder

Constructs a fluent builder for the GetTopicRuleDestination operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The ARN of the topic rule destination.

    
    
• On success, responds with GetTopicRuleDestinationOutput with field(s):
  • topic_rule_destination(Option<TopicRuleDestination>):

    The topic rule destination.

• On failure, responds with SdkError<GetTopicRuleDestinationError>

impl Client

pub fn get_v2_logging_options(&self) -> GetV2LoggingOptionsFluentBuilder

Constructs a fluent builder for the GetV2LoggingOptions operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetV2LoggingOptionsOutput with field(s):
  • role_arn(Option<String>):

    The IAM role ARN IoT uses to write to your CloudWatch logs.

  • default_log_level(Option<LogLevel>):

    The default log level.

  • disable_all_logs(bool):

    Disables all logs.

• On failure, responds with SdkError<GetV2LoggingOptionsError>

impl Client

pub fn list_active_violations(&self) -> ListActiveViolationsFluentBuilder

Constructs a fluent builder for the ListActiveViolations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: false
    

    The name of the thing whose active violations are listed.

    
    
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: false
    

    The name of the Device Defender security profile for which violations are listed.

    
    
  • behavior_criteria_type(BehaviorCriteriaType) / set_behavior_criteria_type(Option<BehaviorCriteriaType>):
    required: false
    

    The criteria for a behavior.

    
    
  • list_suppressed_alerts(bool) / set_list_suppressed_alerts(Option<bool>):
    required: false
    

    A list of all suppressed alerts.

    
    
  • verification_state(VerificationState) / set_verification_state(Option<VerificationState>):
    required: false
    

    The verification state of the violation (detect alarm).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
• On success, responds with ListActiveViolationsOutput with field(s):
  • active_violations(Option<Vec::<ActiveViolation>>):

    The list of active violations.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListActiveViolationsError>

impl Client

pub fn list_attached_policies(&self) -> ListAttachedPoliciesFluentBuilder

Constructs a fluent builder for the ListAttachedPolicies operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • target(impl Into<String>) / set_target(Option<String>):
    required: true
    

    The group or principal for which the policies will be listed. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

    
    
  • recursive(bool) / set_recursive(Option<bool>):
    required: false
    

    When true, recursively list attached policies.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    The token to retrieve the next set of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
• On success, responds with ListAttachedPoliciesOutput with field(s):
  • policies(Option<Vec::<Policy>>):

    The policies.

  • next_marker(Option<String>):

    The token to retrieve the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListAttachedPoliciesError>

impl Client

pub fn list_audit_findings(&self) -> ListAuditFindingsFluentBuilder

Constructs a fluent builder for the ListAuditFindings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: false
    

    A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.

    
    
  • check_name(impl Into<String>) / set_check_name(Option<String>):
    required: false
    

    A filter to limit results to the findings for the specified audit check.

    
    
  • resource_identifier(ResourceIdentifier) / set_resource_identifier(Option<ResourceIdentifier>):
    required: false
    

    Information identifying the noncompliant resource.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.

    
    
  • list_suppressed_findings(bool) / set_list_suppressed_findings(Option<bool>):
    required: false
    

    Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn’t provided, the response will list both suppressed and unsuppressed findings.

    
    
• On success, responds with ListAuditFindingsOutput with field(s):
  • findings(Option<Vec::<AuditFinding>>):

    The findings (results) of the audit.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAuditFindingsError>

impl Client

pub fn list_audit_mitigation_actions_executions( &self, ) -> ListAuditMitigationActionsExecutionsFluentBuilder

Constructs a fluent builder for the ListAuditMitigationActionsExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    Specify this filter to limit results to actions for a specific audit mitigation actions task.

    
    
  • action_status(AuditMitigationActionsExecutionStatus) / set_action_status(Option<AuditMitigationActionsExecutionStatus>):
    required: false
    

    Specify this filter to limit results to those with a specific status.

    
    
  • finding_id(impl Into<String>) / set_finding_id(Option<String>):
    required: true
    

    Specify this filter to limit results to those that were applied to a specific audit finding.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
• On success, responds with ListAuditMitigationActionsExecutionsOutput with field(s):
  • actions_executions(Option<Vec::<AuditMitigationActionExecutionMetadata>>):

    A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

  • next_token(Option<String>):

    The token for the next set of results.

• On failure, responds with SdkError<ListAuditMitigationActionsExecutionsError>

impl Client

pub fn list_audit_mitigation_actions_tasks( &self, ) -> ListAuditMitigationActionsTasksFluentBuilder

Constructs a fluent builder for the ListAuditMitigationActionsTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • audit_task_id(impl Into<String>) / set_audit_task_id(Option<String>):
    required: false
    

    Specify this filter to limit results to tasks that were applied to results for a specific audit.

    
    
  • finding_id(impl Into<String>) / set_finding_id(Option<String>):
    required: false
    

    Specify this filter to limit results to tasks that were applied to a specific audit finding.

    
    
  • task_status(AuditMitigationActionsTaskStatus) / set_task_status(Option<AuditMitigationActionsTaskStatus>):
    required: false
    

    Specify this filter to limit results to tasks that are in a specific state.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    Specify this filter to limit results to tasks that began on or after a specific date and time.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

    
    
• On success, responds with ListAuditMitigationActionsTasksOutput with field(s):
  • tasks(Option<Vec::<AuditMitigationActionsTaskMetadata>>):

    The collection of audit mitigation tasks that matched the filter criteria.

  • next_token(Option<String>):

    The token for the next set of results.

• On failure, responds with SdkError<ListAuditMitigationActionsTasksError>

impl Client

pub fn list_audit_suppressions(&self) -> ListAuditSuppressionsFluentBuilder

Constructs a fluent builder for the ListAuditSuppressions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • check_name(impl Into<String>) / set_check_name(Option<String>):
    required: false
    

    An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

    
    
  • resource_identifier(ResourceIdentifier) / set_resource_identifier(Option<ResourceIdentifier>):
    required: false
    

    Information that identifies the noncompliant resource.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn’t provided, ascendingOrder=true.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
• On success, responds with ListAuditSuppressionsOutput with field(s):
  • suppressions(Option<Vec::<AuditSuppression>>):

    List of audit suppressions.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAuditSuppressionsError>

impl Client

pub fn list_audit_tasks(&self) -> ListAuditTasksFluentBuilder

Constructs a fluent builder for the ListAuditTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an “InvalidRequestException”.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The end of the time period.

    
    
  • task_type(AuditTaskType) / set_task_type(Option<AuditTaskType>):
    required: false
    

    A filter to limit the output to the specified type of audit: can be one of “ON_DEMAND_AUDIT_TASK” or “SCHEDULED__AUDIT_TASK”.

    
    
  • task_status(AuditTaskStatus) / set_task_status(Option<AuditTaskStatus>):
    required: false
    

    A filter to limit the output to audits with the specified completion status: can be one of “IN_PROGRESS”, “COMPLETED”, “FAILED”, or “CANCELED”.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
• On success, responds with ListAuditTasksOutput with field(s):
  • tasks(Option<Vec::<AuditTaskMetadata>>):

    The audits that were performed during the specified time period.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListAuditTasksError>

impl Client

pub fn list_authorizers(&self) -> ListAuthorizersFluentBuilder

Constructs a fluent builder for the ListAuthorizers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A marker used to get the next set of results.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Return the list of authorizers in ascending alphabetical order.

    
    
  • status(AuthorizerStatus) / set_status(Option<AuthorizerStatus>):
    required: false
    

    The status of the list authorizers request.

    
    
• On success, responds with ListAuthorizersOutput with field(s):
  • authorizers(Option<Vec::<AuthorizerSummary>>):

    The authorizers.

  • next_marker(Option<String>):

    A marker used to get the next set of results.

• On failure, responds with SdkError<ListAuthorizersError>

impl Client

pub fn list_billing_groups(&self) -> ListBillingGroupsFluentBuilder

Constructs a fluent builder for the ListBillingGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per request.

    
    
  • name_prefix_filter(impl Into<String>) / set_name_prefix_filter(Option<String>):
    required: false
    

    Limit the results to billing groups whose names have the given prefix.

    
    
• On success, responds with ListBillingGroupsOutput with field(s):
  • billing_groups(Option<Vec::<GroupNameAndArn>>):

    The list of billing groups.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListBillingGroupsError>

impl Client

pub fn list_ca_certificates(&self) -> ListCACertificatesFluentBuilder

Constructs a fluent builder for the ListCACertificates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The result page size.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    The marker for the next set of results.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Determines the order of the results.

    
    
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: false
    

    The name of the provisioning template.

    
    
• On success, responds with ListCaCertificatesOutput with field(s):
  • certificates(Option<Vec::<CaCertificate>>):

    The CA certificates registered in your Amazon Web Services account.

  • next_marker(Option<String>):

    The current position within the list of CA certificates.

• On failure, responds with SdkError<ListCACertificatesError>

impl Client

pub fn list_certificate_providers( &self, ) -> ListCertificateProvidersFluentBuilder

Constructs a fluent builder for the ListCertificateProviders operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results, or null if there are no more results.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Returns the list of certificate providers in ascending alphabetical order.

    
    
• On success, responds with ListCertificateProvidersOutput with field(s):
  • certificate_providers(Option<Vec::<CertificateProviderSummary>>):

    The list of certificate providers in your Amazon Web Services account.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no more results.

• On failure, responds with SdkError<ListCertificateProvidersError>

impl Client

pub fn list_certificates(&self) -> ListCertificatesFluentBuilder

Constructs a fluent builder for the ListCertificates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The result page size.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    The marker for the next set of results.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

    
    
• On success, responds with ListCertificatesOutput with field(s):
  • certificates(Option<Vec::<Certificate>>):

    The descriptions of the certificates.

  • next_marker(Option<String>):

    The marker for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListCertificatesError>

impl Client

pub fn list_certificates_by_ca(&self) -> ListCertificatesByCAFluentBuilder

Constructs a fluent builder for the ListCertificatesByCA operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • ca_certificate_id(impl Into<String>) / set_ca_certificate_id(Option<String>):
    required: true
    

    The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The result page size.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    The marker for the next set of results.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

    
    
• On success, responds with ListCertificatesByCaOutput with field(s):
  • certificates(Option<Vec::<Certificate>>):

    The device certificates signed by the specified CA certificate.

  • next_marker(Option<String>):

    The marker for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListCertificatesByCAError>

impl Client

pub fn list_command_executions(&self) -> ListCommandExecutionsFluentBuilder

Constructs a fluent builder for the ListCommandExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • namespace(CommandNamespace) / set_namespace(Option<CommandNamespace>):
    required: false
    

    The namespace of the command.

    
    
  • status(CommandExecutionStatus) / set_status(Option<CommandExecutionStatus>):
    required: false
    

    List all command executions for the device that have a particular status. For example, you can filter the list to display only command executions that have failed or timed out.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    Specify whether to list the command executions that were created in the ascending or descending order. By default, the API returns all commands in the descending order based on the start time or completion time of the executions, that are determined by the startTimeFilter and completeTimeFilter parameters.

    
    
  • started_time_filter(TimeFilter) / set_started_time_filter(Option<TimeFilter>):
    required: false
    

    List all command executions that started any time before or after the date and time that you specify. The date and time uses the format yyyy-MM-dd’T’HH:mm.

    
    
  • completed_time_filter(TimeFilter) / set_completed_time_filter(Option<TimeFilter>):
    required: false
    

    List all command executions that completed any time before or after the date and time that you specify. The date and time uses the format yyyy-MM-dd’T’HH:mm.

    
    
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: false
    

    The Amazon Resource Number (ARN) of the target device. You can use this information to list all command executions for a particular device.

    
    
  • command_arn(impl Into<String>) / set_command_arn(Option<String>):
    required: false
    

    The Amazon Resource Number (ARN) of the command. You can use this information to list all command executions for a particular command.

    
    
• On success, responds with ListCommandExecutionsOutput with field(s):
  • command_executions(Option<Vec::<CommandExecutionSummary>>):

    The list of command executions.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListCommandExecutionsError>

impl Client

pub fn list_commands(&self) -> ListCommandsFluentBuilder

Constructs a fluent builder for the ListCommands operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation. By default, the API returns up to a maximum of 25 results. You can override this default value to return up to a maximum of 100 results for this operation.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • namespace(CommandNamespace) / set_namespace(Option<CommandNamespace>):
    required: false
    

    The namespace of the command. By default, the API returns all commands that have been created for both AWS-IoT and AWS-IoT-FleetWise namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.

    
    
  • command_parameter_name(impl Into<String>) / set_command_parameter_name(Option<String>):
    required: false
    

    A filter that can be used to display the list of commands that have a specific command parameter name.

    
    
  • sort_order(SortOrder) / set_sort_order(Option<SortOrder>):
    required: false
    

    Specify whether to list the commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.

    
    
• On success, responds with ListCommandsOutput with field(s):
  • commands(Option<Vec::<CommandSummary>>):

    The list of commands.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListCommandsError>

impl Client

pub fn list_custom_metrics(&self) -> ListCustomMetricsFluentBuilder

Constructs a fluent builder for the ListCustomMetrics operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
• On success, responds with ListCustomMetricsOutput with field(s):
  • metric_names(Option<Vec::<String>>):

    The name of the custom metric.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListCustomMetricsError>

impl Client

pub fn list_detect_mitigation_actions_executions( &self, ) -> ListDetectMitigationActionsExecutionsFluentBuilder

Constructs a fluent builder for the ListDetectMitigationActionsExecutions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: false
    

    The unique identifier of the task.

    
    
  • violation_id(impl Into<String>) / set_violation_id(Option<String>):
    required: false
    

    The unique identifier of the violation.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: false
    

    The name of the thing whose mitigation actions are listed.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: false
    

    A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: false
    

    The end of the time period for which ML Detect mitigation actions executions are returned.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
• On success, responds with ListDetectMitigationActionsExecutionsOutput with field(s):
  • actions_executions(Option<Vec::<DetectMitigationActionExecution>>):

    List of actions executions.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListDetectMitigationActionsExecutionsError>

impl Client

pub fn list_detect_mitigation_actions_tasks( &self, ) -> ListDetectMitigationActionsTasksFluentBuilder

Constructs a fluent builder for the ListDetectMitigationActionsTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The end of the time period for which ML Detect mitigation actions tasks are returned.

    
    
• On success, responds with ListDetectMitigationActionsTasksOutput with field(s):
  • tasks(Option<Vec::<DetectMitigationActionsTaskSummary>>):

    The collection of ML Detect mitigation tasks that matched the filter criteria.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListDetectMitigationActionsTasksError>

impl Client

pub fn list_dimensions(&self) -> ListDimensionsFluentBuilder

Constructs a fluent builder for the ListDimensions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to retrieve at one time.

    
    
• On success, responds with ListDimensionsOutput with field(s):
  • dimension_names(Option<Vec::<String>>):

    A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListDimensionsError>

impl Client

pub fn list_domain_configurations( &self, ) -> ListDomainConfigurationsFluentBuilder

Constructs a fluent builder for the ListDomainConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    The marker for the next set of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The result page size.

    
    
  • service_type(ServiceType) / set_service_type(Option<ServiceType>):
    required: false
    

    The type of service delivered by the endpoint.

    
    
• On success, responds with ListDomainConfigurationsOutput with field(s):
  • domain_configurations(Option<Vec::<DomainConfigurationSummary>>):

    A list of objects that contain summary information about the user’s domain configurations.

  • next_marker(Option<String>):

    The marker for the next set of results.

• On failure, responds with SdkError<ListDomainConfigurationsError>

impl Client

pub fn list_fleet_metrics(&self) -> ListFleetMetricsFluentBuilder

Constructs a fluent builder for the ListFleetMetrics operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
• On success, responds with ListFleetMetricsOutput with field(s):
  • fleet_metrics(Option<Vec::<FleetMetricNameAndArn>>):

    The list of fleet metrics objects.

  • next_token(Option<String>):

    The token for the next set of results. Will not be returned if the operation has returned all results.

• On failure, responds with SdkError<ListFleetMetricsError>

impl Client

pub fn list_indices(&self) -> ListIndicesFluentBuilder

Constructs a fluent builder for the ListIndices operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token used to get the next set of results, or null if there are no additional results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
• On success, responds with ListIndicesOutput with field(s):
  • index_names(Option<Vec::<String>>):

    The index names.

  • next_token(Option<String>):

    The token used to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListIndicesError>

impl Client

pub fn list_job_executions_for_job( &self, ) -> ListJobExecutionsForJobFluentBuilder

Constructs a fluent builder for the ListJobExecutionsForJob operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The unique identifier you assigned to this job when it was created.

    
    
  • status(JobExecutionStatus) / set_status(Option<JobExecutionStatus>):
    required: false
    

    The status of the job.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to retrieve the next set of results.

    
    
• On success, responds with ListJobExecutionsForJobOutput with field(s):
  • execution_summaries(Option<Vec::<JobExecutionSummaryForJob>>):

    A list of job execution summaries.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListJobExecutionsForJobError>

impl Client

pub fn list_job_executions_for_thing( &self, ) -> ListJobExecutionsForThingFluentBuilder

Constructs a fluent builder for the ListJobExecutionsForThing operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The thing name.

    
    
  • status(JobExecutionStatus) / set_status(Option<JobExecutionStatus>):
    required: false
    

    An optional filter that lets you search for jobs that have the specified status.

    
    
  • namespace_id(impl Into<String>) / set_namespace_id(Option<String>):
    required: false
    

    The namespace used to indicate that a job is a customer-managed job.

    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

    The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned per request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to retrieve the next set of results.

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: false
    

    The unique identifier you assigned to this job when it was created.

    
    
• On success, responds with ListJobExecutionsForThingOutput with field(s):
  • execution_summaries(Option<Vec::<JobExecutionSummaryForThing>>):

    A list of job execution summaries.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListJobExecutionsForThingError>

impl Client

pub fn list_job_templates(&self) -> ListJobTemplatesFluentBuilder

Constructs a fluent builder for the ListJobTemplates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the list.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to use to return the next set of results in the list.

    
    
• On success, responds with ListJobTemplatesOutput with field(s):
  • job_templates(Option<Vec::<JobTemplateSummary>>):

    A list of objects that contain information about the job templates.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListJobTemplatesError>

impl Client

pub fn list_jobs(&self) -> ListJobsFluentBuilder

Constructs a fluent builder for the ListJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • status(JobStatus) / set_status(Option<JobStatus>):
    required: false
    

    An optional filter that lets you search for jobs that have the specified status.

    
    
  • target_selection(TargetSelection) / set_target_selection(Option<TargetSelection>):
    required: false
    

    Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

    We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to retrieve the next set of results.

    
    
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: false
    

    A filter that limits the returned jobs to those for the specified group.

    
    
  • thing_group_id(impl Into<String>) / set_thing_group_id(Option<String>):
    required: false
    

    A filter that limits the returned jobs to those for the specified group.

    
    
  • namespace_id(impl Into<String>) / set_namespace_id(Option<String>):
    required: false
    

    The namespace used to indicate that a job is a customer-managed job.

    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

    The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

    
    
• On success, responds with ListJobsOutput with field(s):
  • jobs(Option<Vec::<JobSummary>>):

    A list of jobs.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListJobsError>

impl Client

pub fn list_managed_job_templates(&self) -> ListManagedJobTemplatesFluentBuilder

Constructs a fluent builder for the ListManagedJobTemplates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: false
    

    An optional parameter for template name. If specified, only the versions of the managed job templates that have the specified template name will be returned.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of entries that can be returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to retrieve the next set of results.

    
    
• On success, responds with ListManagedJobTemplatesOutput with field(s):
  • managed_job_templates(Option<Vec::<ManagedJobTemplateSummary>>):

    A list of managed job templates that are returned.

  • next_token(Option<String>):

    The token to retrieve the next set of results.

• On failure, responds with SdkError<ListManagedJobTemplatesError>

impl Client

pub fn list_metric_values(&self) -> ListMetricValuesFluentBuilder

Constructs a fluent builder for the ListMetricValues operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing for which security profile metric values are returned.

    
    
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    The name of the security profile metric for which values are returned.

    
    
  • dimension_name(impl Into<String>) / set_dimension_name(Option<String>):
    required: false
    

    The dimension name.

    
    
  • dimension_value_operator(DimensionValueOperator) / set_dimension_value_operator(Option<DimensionValueOperator>):
    required: false
    

    The dimension value operator.

    
    
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The start of the time period for which metric values are returned.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The end of the time period for which metric values are returned.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
• On success, responds with ListMetricValuesOutput with field(s):
  • metric_datum_list(Option<Vec::<MetricDatum>>):

    The data the thing reports for the metric during the specified time period.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListMetricValuesError>

impl Client

pub fn list_mitigation_actions(&self) -> ListMitigationActionsFluentBuilder

Constructs a fluent builder for the ListMitigationActions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • action_type(MitigationActionType) / set_action_type(Option<MitigationActionType>):
    required: false
    

    Specify a value to limit the result to mitigation actions with a specific action type.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
• On success, responds with ListMitigationActionsOutput with field(s):
  • action_identifiers(Option<Vec::<MitigationActionIdentifier>>):

    A set of actions that matched the specified filter criteria.

  • next_token(Option<String>):

    The token for the next set of results.

• On failure, responds with SdkError<ListMitigationActionsError>

impl Client

pub fn list_ota_updates(&self) -> ListOTAUpdatesFluentBuilder

Constructs a fluent builder for the ListOTAUpdates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token used to retrieve the next set of results.

    
    
  • ota_update_status(OtaUpdateStatus) / set_ota_update_status(Option<OtaUpdateStatus>):
    required: false
    

    The OTA update job status.

    
    
• On success, responds with ListOtaUpdatesOutput with field(s):
  • ota_updates(Option<Vec::<OtaUpdateSummary>>):

    A list of OTA update jobs.

  • next_token(Option<String>):

    A token to use to get the next set of results.

• On failure, responds with SdkError<ListOTAUpdatesError>

impl Client

pub fn list_outgoing_certificates( &self, ) -> ListOutgoingCertificatesFluentBuilder

Constructs a fluent builder for the ListOutgoingCertificates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The result page size.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    The marker for the next set of results.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

    
    
• On success, responds with ListOutgoingCertificatesOutput with field(s):
  • outgoing_certificates(Option<Vec::<OutgoingCertificate>>):

    The certificates that are being transferred but not yet accepted.

  • next_marker(Option<String>):

    The marker for the next set of results.

• On failure, responds with SdkError<ListOutgoingCertificatesError>

impl Client

pub fn list_package_versions(&self) -> ListPackageVersionsFluentBuilder

Constructs a fluent builder for the ListPackageVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the target software package.

    
    
  • status(PackageVersionStatus) / set_status(Option<PackageVersionStatus>):
    required: false
    

    The status of the package version. For more information, see Package version lifecycle.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
• On success, responds with ListPackageVersionsOutput with field(s):
  • package_version_summaries(Option<Vec::<PackageVersionSummary>>):

    Lists the package versions associated to the package.

  • next_token(Option<String>):

    The token for the next set of results.

• On failure, responds with SdkError<ListPackageVersionsError>

impl Client

pub fn list_packages(&self) -> ListPackagesFluentBuilder

Constructs a fluent builder for the ListPackages operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results returned at one time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
• On success, responds with ListPackagesOutput with field(s):
  • package_summaries(Option<Vec::<PackageSummary>>):

    The software package summary.

  • next_token(Option<String>):

    The token for the next set of results.

• On failure, responds with SdkError<ListPackagesError>

impl Client

pub fn list_policies(&self) -> ListPoliciesFluentBuilder

Constructs a fluent builder for the ListPolicies operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    The marker for the next set of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The result page size.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Specifies the order for results. If true, the results are returned in ascending creation order.

    
    
• On success, responds with ListPoliciesOutput with field(s):
  • policies(Option<Vec::<Policy>>):

    The descriptions of the policies.

  • next_marker(Option<String>):

    The marker for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListPoliciesError>

impl Client

pub fn list_policy_principals(&self) -> ListPolicyPrincipalsFluentBuilder

👎Deprecated

Constructs a fluent builder for the ListPolicyPrincipals operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The policy name.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    The marker for the next set of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The result page size.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Specifies the order for results. If true, the results are returned in ascending creation order.

    
    
• On success, responds with ListPolicyPrincipalsOutput with field(s):
  • principals(Option<Vec::<String>>):

    The descriptions of the principals.

  • next_marker(Option<String>):

    The marker for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListPolicyPrincipalsError>

impl Client

pub fn list_policy_versions(&self) -> ListPolicyVersionsFluentBuilder

Constructs a fluent builder for the ListPolicyVersions operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The policy name.

    
    
• On success, responds with ListPolicyVersionsOutput with field(s):
  • policy_versions(Option<Vec::<PolicyVersion>>):

    The policy versions.

• On failure, responds with SdkError<ListPolicyVersionsError>

impl Client

pub fn list_principal_policies(&self) -> ListPrincipalPoliciesFluentBuilder

👎Deprecated

Constructs a fluent builder for the ListPrincipalPolicies operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: true
    

    The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    The marker for the next set of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The result page size.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Specifies the order for results. If true, results are returned in ascending creation order.

    
    
• On success, responds with ListPrincipalPoliciesOutput with field(s):
  • policies(Option<Vec::<Policy>>):

    The policies.

  • next_marker(Option<String>):

    The marker for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListPrincipalPoliciesError>

impl Client

pub fn list_principal_things(&self) -> ListPrincipalThingsFluentBuilder

Constructs a fluent builder for the ListPrincipalThings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: true
    

    The principal.

    
    
• On success, responds with ListPrincipalThingsOutput with field(s):
  • things(Option<Vec::<String>>):

    The things.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListPrincipalThingsError>

impl Client

pub fn list_principal_things_v2(&self) -> ListPrincipalThingsV2FluentBuilder

Constructs a fluent builder for the ListPrincipalThingsV2 operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: true
    

    The principal. A principal can be an X.509 certificate or an Amazon Cognito ID.

    
    
  • thing_principal_type(ThingPrincipalType) / set_thing_principal_type(Option<ThingPrincipalType>):
    required: false
    

    The type of the relation you want to filter in the response. If no value is provided in this field, the response will list all things, including both the EXCLUSIVE_THING and NON_EXCLUSIVE_THING attachment types.

    • EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.

    • NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.

    
    
• On success, responds with ListPrincipalThingsV2Output with field(s):
  • principal_thing_objects(Option<Vec::<PrincipalThingObject>>):

    A list of thingPrincipalObject that represents the principal and the type of relation it has with the thing.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListPrincipalThingsV2Error>

impl Client

pub fn list_provisioning_template_versions( &self, ) -> ListProvisioningTemplateVersionsFluentBuilder

Constructs a fluent builder for the ListProvisioningTemplateVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the provisioning template.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next set of results.

    
    
• On success, responds with ListProvisioningTemplateVersionsOutput with field(s):
  • versions(Option<Vec::<ProvisioningTemplateVersionSummary>>):

    The list of provisioning template versions.

  • next_token(Option<String>):

    A token to retrieve the next set of results.

• On failure, responds with SdkError<ListProvisioningTemplateVersionsError>

impl Client

pub fn list_provisioning_templates( &self, ) -> ListProvisioningTemplatesFluentBuilder

Constructs a fluent builder for the ListProvisioningTemplates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token to retrieve the next set of results.

    
    
• On success, responds with ListProvisioningTemplatesOutput with field(s):
  • templates(Option<Vec::<ProvisioningTemplateSummary>>):

    A list of provisioning templates

  • next_token(Option<String>):

    A token to retrieve the next set of results.

• On failure, responds with SdkError<ListProvisioningTemplatesError>

impl Client

pub fn list_related_resources_for_audit_finding( &self, ) -> ListRelatedResourcesForAuditFindingFluentBuilder

Constructs a fluent builder for the ListRelatedResourcesForAuditFinding operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • finding_id(impl Into<String>) / set_finding_id(Option<String>):
    required: true
    

    The finding Id.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
• On success, responds with ListRelatedResourcesForAuditFindingOutput with field(s):
  • related_resources(Option<Vec::<RelatedResource>>):

    The related resources.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null for the first API call.

• On failure, responds with SdkError<ListRelatedResourcesForAuditFindingError>

impl Client

pub fn list_role_aliases(&self) -> ListRoleAliasesFluentBuilder

Constructs a fluent builder for the ListRoleAliases operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A marker used to get the next set of results.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Return the list of role aliases in ascending alphabetical order.

    
    
• On success, responds with ListRoleAliasesOutput with field(s):
  • role_aliases(Option<Vec::<String>>):

    The role aliases.

  • next_marker(Option<String>):

    A marker used to get the next set of results.

• On failure, responds with SdkError<ListRoleAliasesError>

impl Client

pub fn list_sbom_validation_results( &self, ) -> ListSbomValidationResultsFluentBuilder

Constructs a fluent builder for the ListSbomValidationResults operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the new software package.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name of the new package version.

    
    
  • validation_result(SbomValidationResult) / set_validation_result(Option<SbomValidationResult>):
    required: false
    

    The end result of the

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

    
    
• On success, responds with ListSbomValidationResultsOutput with field(s):
  • validation_result_summaries(Option<Vec::<SbomValidationResultSummary>>):

    A summary of the validation results for each software bill of materials attached to a software package version.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListSbomValidationResultsError>

impl Client

pub fn list_scheduled_audits(&self) -> ListScheduledAuditsFluentBuilder

Constructs a fluent builder for the ListScheduledAudits operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time. The default is 25.

    
    
• On success, responds with ListScheduledAuditsOutput with field(s):
  • scheduled_audits(Option<Vec::<ScheduledAuditMetadata>>):

    The list of scheduled audits.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListScheduledAuditsError>

impl Client

pub fn list_security_profiles(&self) -> ListSecurityProfilesFluentBuilder

Constructs a fluent builder for the ListSecurityProfiles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • dimension_name(impl Into<String>) / set_dimension_name(Option<String>):
    required: false
    

    A filter to limit results to the security profiles that use the defined dimension. Cannot be used with metricName

    
    
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: false
    

    The name of the custom metric. Cannot be used with dimensionName.

    
    
• On success, responds with ListSecurityProfilesOutput with field(s):
  • security_profile_identifiers(Option<Vec::<SecurityProfileIdentifier>>):

    A list of security profile identifiers (names and ARNs).

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListSecurityProfilesError>

impl Client

pub fn list_security_profiles_for_target( &self, ) -> ListSecurityProfilesForTargetFluentBuilder

Constructs a fluent builder for the ListSecurityProfilesForTarget operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • recursive(bool) / set_recursive(Option<bool>):
    required: false
    

    If true, return child groups too.

    
    
  • security_profile_target_arn(impl Into<String>) / set_security_profile_target_arn(Option<String>):
    required: true
    

    The ARN of the target (thing group) whose attached security profiles you want to get.

    
    
• On success, responds with ListSecurityProfilesForTargetOutput with field(s):
  • security_profile_target_mappings(Option<Vec::<SecurityProfileTargetMapping>>):

    A list of security profiles and their associated targets.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListSecurityProfilesForTargetError>

impl Client

pub fn list_streams(&self) -> ListStreamsFluentBuilder

Constructs a fluent builder for the ListStreams operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    A token used to get the next set of results.

    
    
  • ascending_order(bool) / set_ascending_order(Option<bool>):
    required: false
    

    Set to true to return the list of streams in ascending order.

    
    
• On success, responds with ListStreamsOutput with field(s):
  • streams(Option<Vec::<StreamSummary>>):

    A list of streams.

  • next_token(Option<String>):

    A token used to get the next set of results.

• On failure, responds with SdkError<ListStreamsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The list of tags assigned to the resource.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_targets_for_policy(&self) -> ListTargetsForPolicyFluentBuilder

Constructs a fluent builder for the ListTargetsForPolicy operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The policy name.

    
    
  • marker(impl Into<String>) / set_marker(Option<String>):
    required: false
    

    A marker used to get the next set of results.

    
    
  • page_size(i32) / set_page_size(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
• On success, responds with ListTargetsForPolicyOutput with field(s):
  • targets(Option<Vec::<String>>):

    The policy targets.

  • next_marker(Option<String>):

    A marker used to get the next set of results.

• On failure, responds with SdkError<ListTargetsForPolicyError>

impl Client

pub fn list_targets_for_security_profile( &self, ) -> ListTargetsForSecurityProfileFluentBuilder

Constructs a fluent builder for the ListTargetsForSecurityProfile operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: true
    

    The security profile.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
• On success, responds with ListTargetsForSecurityProfileOutput with field(s):
  • security_profile_targets(Option<Vec::<SecurityProfileTarget>>):

    The thing groups to which the security profile is attached.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListTargetsForSecurityProfileError>

impl Client

pub fn list_thing_groups(&self) -> ListThingGroupsFluentBuilder

Constructs a fluent builder for the ListThingGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • parent_group(impl Into<String>) / set_parent_group(Option<String>):
    required: false
    

    A filter that limits the results to those with the specified parent group.

    
    
  • name_prefix_filter(impl Into<String>) / set_name_prefix_filter(Option<String>):
    required: false
    

    A filter that limits the results to those with the specified name prefix.

    
    
  • recursive(bool) / set_recursive(Option<bool>):
    required: false
    

    If true, return child groups as well.

    
    
• On success, responds with ListThingGroupsOutput with field(s):
  • thing_groups(Option<Vec::<GroupNameAndArn>>):

    The thing groups.

  • next_token(Option<String>):

    The token to use to get the next set of results. Will not be returned if operation has returned all results.

• On failure, responds with SdkError<ListThingGroupsError>

impl Client

pub fn list_thing_groups_for_thing( &self, ) -> ListThingGroupsForThingFluentBuilder

Constructs a fluent builder for the ListThingGroupsForThing operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The thing name.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
• On success, responds with ListThingGroupsForThingOutput with field(s):
  • thing_groups(Option<Vec::<GroupNameAndArn>>):

    The thing groups.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListThingGroupsForThingError>

impl Client

pub fn list_thing_principals(&self) -> ListThingPrincipalsFluentBuilder

Constructs a fluent builder for the ListThingPrincipals operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing.

    
    
• On success, responds with ListThingPrincipalsOutput with field(s):
  • principals(Option<Vec::<String>>):

    The principals associated with the thing.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListThingPrincipalsError>

impl Client

pub fn list_thing_principals_v2(&self) -> ListThingPrincipalsV2FluentBuilder

Constructs a fluent builder for the ListThingPrincipalsV2 operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing.

    
    
  • thing_principal_type(ThingPrincipalType) / set_thing_principal_type(Option<ThingPrincipalType>):
    required: false
    

    The type of the relation you want to filter in the response. If no value is provided in this field, the response will list all principals, including both the EXCLUSIVE_THING and NON_EXCLUSIVE_THING attachment types.

    • EXCLUSIVE_THING - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.

    • NON_EXCLUSIVE_THING - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.

    
    
• On success, responds with ListThingPrincipalsV2Output with field(s):
  • thing_principal_objects(Option<Vec::<ThingPrincipalObject>>):

    A list of thingPrincipalObject that represents the principal and the type of relation it has with the thing.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListThingPrincipalsV2Error>

impl Client

pub fn list_thing_registration_task_reports( &self, ) -> ListThingRegistrationTaskReportsFluentBuilder

Constructs a fluent builder for the ListThingRegistrationTaskReports operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The id of the task.

    
    
  • report_type(ReportType) / set_report_type(Option<ReportType>):
    required: true
    

    The type of task report.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per request.

    
    
• On success, responds with ListThingRegistrationTaskReportsOutput with field(s):
  • resource_links(Option<Vec::<String>>):

    Links to the task resources.

  • report_type(Option<ReportType>):

    The type of task report.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListThingRegistrationTaskReportsError>

impl Client

pub fn list_thing_registration_tasks( &self, ) -> ListThingRegistrationTasksFluentBuilder

Constructs a fluent builder for the ListThingRegistrationTasks operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • status(Status) / set_status(Option<Status>):
    required: false
    

    The status of the bulk thing provisioning task.

    
    
• On success, responds with ListThingRegistrationTasksOutput with field(s):
  • task_ids(Option<Vec::<String>>):

    A list of bulk thing provisioning task IDs.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListThingRegistrationTasksError>

impl Client

pub fn list_thing_types(&self) -> ListThingTypesFluentBuilder

Constructs a fluent builder for the ListThingTypes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • thing_type_name(impl Into<String>) / set_thing_type_name(Option<String>):
    required: false
    

    The name of the thing type.

    
    
• On success, responds with ListThingTypesOutput with field(s):
  • thing_types(Option<Vec::<ThingTypeDefinition>>):

    The thing types.

  • next_token(Option<String>):

    The token for the next set of results. Will not be returned if operation has returned all results.

• On failure, responds with SdkError<ListThingTypesError>

impl Client

pub fn list_things(&self) -> ListThingsFluentBuilder

Constructs a fluent builder for the ListThings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in this operation.

    
    
  • attribute_name(impl Into<String>) / set_attribute_name(Option<String>):
    required: false
    

    The attribute name used to search for things.

    
    
  • attribute_value(impl Into<String>) / set_attribute_value(Option<String>):
    required: false
    

    The attribute value used to search for things.

    
    
  • thing_type_name(impl Into<String>) / set_thing_type_name(Option<String>):
    required: false
    

    The name of the thing type used to search for things.

    
    
  • use_prefix_attribute_value(bool) / set_use_prefix_attribute_value(Option<bool>):
    required: false
    

    When true, the action returns the thing resources with attribute values that start with the attributeValue provided.

    When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.

    
    
• On success, responds with ListThingsOutput with field(s):
  • things(Option<Vec::<ThingAttribute>>):

    The things.

  • next_token(Option<String>):

    The token to use to get the next set of results. Will not be returned if operation has returned all results.

• On failure, responds with SdkError<ListThingsError>

impl Client

pub fn list_things_in_billing_group( &self, ) -> ListThingsInBillingGroupFluentBuilder

Constructs a fluent builder for the ListThingsInBillingGroup operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • billing_group_name(impl Into<String>) / set_billing_group_name(Option<String>):
    required: true
    

    The name of the billing group.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per request.

    
    
• On success, responds with ListThingsInBillingGroupOutput with field(s):
  • things(Option<Vec::<String>>):

    A list of things in the billing group.

  • next_token(Option<String>):

    The token to use to get the next set of results. Will not be returned if operation has returned all results.

• On failure, responds with SdkError<ListThingsInBillingGroupError>

impl Client

pub fn list_things_in_thing_group(&self) -> ListThingsInThingGroupFluentBuilder

Constructs a fluent builder for the ListThingsInThingGroup operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: true
    

    The thing group name.

    
    
  • recursive(bool) / set_recursive(Option<bool>):
    required: false
    

    When true, list things in this thing group and in all child groups as well.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
• On success, responds with ListThingsInThingGroupOutput with field(s):
  • things(Option<Vec::<String>>):

    The things in the specified thing group.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListThingsInThingGroupError>

impl Client

pub fn list_topic_rule_destinations( &self, ) -> ListTopicRuleDestinationsFluentBuilder

Constructs a fluent builder for the ListTopicRuleDestinations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
• On success, responds with ListTopicRuleDestinationsOutput with field(s):
  • destination_summaries(Option<Vec::<TopicRuleDestinationSummary>>):

    Information about a topic rule destination.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListTopicRuleDestinationsError>

impl Client

pub fn list_topic_rules(&self) -> ListTopicRulesFluentBuilder

Constructs a fluent builder for the ListTopicRules operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • topic(impl Into<String>) / set_topic(Option<String>):
    required: false
    

    The topic.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • rule_disabled(bool) / set_rule_disabled(Option<bool>):
    required: false
    

    Specifies whether the rule is disabled.

    
    
• On success, responds with ListTopicRulesOutput with field(s):
  • rules(Option<Vec::<TopicRuleListItem>>):

    The rules.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListTopicRulesError>

impl Client

pub fn list_v2_logging_levels(&self) -> ListV2LoggingLevelsFluentBuilder

Constructs a fluent builder for the ListV2LoggingLevels operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • target_type(LogTargetType) / set_target_type(Option<LogTargetType>):
    required: false
    

    The type of resource for which you are configuring logging. Must be THING_Group.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
• On success, responds with ListV2LoggingLevelsOutput with field(s):
  • log_target_configurations(Option<Vec::<LogTargetConfiguration>>):

    The logging configuration for a target.

  • next_token(Option<String>):

    The token to use to get the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListV2LoggingLevelsError>

impl Client

pub fn list_violation_events(&self) -> ListViolationEventsFluentBuilder

Constructs a fluent builder for the ListViolationEvents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • start_time(DateTime) / set_start_time(Option<DateTime>):
    required: true
    

    The start time for the alerts to be listed.

    
    
  • end_time(DateTime) / set_end_time(Option<DateTime>):
    required: true
    

    The end time for the alerts to be listed.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: false
    

    A filter to limit results to those alerts caused by the specified thing.

    
    
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: false
    

    A filter to limit results to those alerts generated by the specified security profile.

    
    
  • behavior_criteria_type(BehaviorCriteriaType) / set_behavior_criteria_type(Option<BehaviorCriteriaType>):
    required: false
    

    The criteria for a behavior.

    
    
  • list_suppressed_alerts(bool) / set_list_suppressed_alerts(Option<bool>):
    required: false
    

    A list of all suppressed alerts.

    
    
  • verification_state(VerificationState) / set_verification_state(Option<VerificationState>):
    required: false
    

    The verification state of the violation (detect alarm).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return at one time.

    
    
• On success, responds with ListViolationEventsOutput with field(s):
  • violation_events(Option<Vec::<ViolationEvent>>):

    The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.

  • next_token(Option<String>):

    A token that can be used to retrieve the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListViolationEventsError>

impl Client

pub fn put_verification_state_on_violation( &self, ) -> PutVerificationStateOnViolationFluentBuilder

Constructs a fluent builder for the PutVerificationStateOnViolation operation.

• The fluent builder is configurable:
  • violation_id(impl Into<String>) / set_violation_id(Option<String>):
    required: true
    

    The violation ID.

    
    
  • verification_state(VerificationState) / set_verification_state(Option<VerificationState>):
    required: true
    

    The verification state of the violation.

    
    
  • verification_state_description(impl Into<String>) / set_verification_state_description(Option<String>):
    required: false
    

    The description of the verification state of the violation (detect alarm).

    
    
• On success, responds with PutVerificationStateOnViolationOutput
• On failure, responds with SdkError<PutVerificationStateOnViolationError>

impl Client

pub fn register_ca_certificate(&self) -> RegisterCACertificateFluentBuilder

Constructs a fluent builder for the RegisterCACertificate operation.

• The fluent builder is configurable:
  • ca_certificate(impl Into<String>) / set_ca_certificate(Option<String>):
    required: true
    

    The CA certificate.

    
    
  • verification_certificate(impl Into<String>) / set_verification_certificate(Option<String>):
    required: false
    

    The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

    
    
  • set_as_active(bool) / set_set_as_active(Option<bool>):
    required: false
    

    A boolean value that specifies if the CA certificate is set to active.

    Valid values: ACTIVE | INACTIVE

    
    
  • allow_auto_registration(bool) / set_allow_auto_registration(Option<bool>):
    required: false
    

    Allows this CA certificate to be used for auto registration of device certificates.

    
    
  • registration_config(RegistrationConfig) / set_registration_config(Option<RegistrationConfig>):
    required: false
    

    Information about the registration configuration.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    Metadata which can be used to manage the CA certificate.

    For URI Request parameters use format: …key1=value1&key2=value2…

    For the CLI command-line parameter use format: &&tags “key1=value1&key2=value2…”

    For the cli-input-json file use format: “tags”: “key1=value1&key2=value2…”

    
    
  • certificate_mode(CertificateMode) / set_certificate_mode(Option<CertificateMode>):
    required: false
    

    Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

    
    
• On success, responds with RegisterCaCertificateOutput with field(s):
  • certificate_arn(Option<String>):

    The CA certificate ARN.

  • certificate_id(Option<String>):

    The CA certificate identifier.

• On failure, responds with SdkError<RegisterCACertificateError>

impl Client

pub fn register_certificate(&self) -> RegisterCertificateFluentBuilder

Constructs a fluent builder for the RegisterCertificate operation.

• The fluent builder is configurable:
  • certificate_pem(impl Into<String>) / set_certificate_pem(Option<String>):
    required: true
    

    The certificate data, in PEM format.

    
    
  • ca_certificate_pem(impl Into<String>) / set_ca_certificate_pem(Option<String>):
    required: false
    

    The CA certificate used to sign the device certificate being registered.

    
    
  • set_as_active(bool) / set_set_as_active(Option<bool>):
    required: false
    

    A boolean value that specifies if the certificate is set to active.

    Valid values: ACTIVE | INACTIVE

    
    
  • status(CertificateStatus) / set_status(Option<CertificateStatus>):
    required: false
    

    The status of the register certificate request. Valid values that you can use include ACTIVE, INACTIVE, and REVOKED.

    
    
• On success, responds with RegisterCertificateOutput with field(s):
  • certificate_arn(Option<String>):

    The certificate ARN.

  • certificate_id(Option<String>):

    The certificate identifier.

• On failure, responds with SdkError<RegisterCertificateError>

impl Client

pub fn register_certificate_without_ca( &self, ) -> RegisterCertificateWithoutCAFluentBuilder

Constructs a fluent builder for the RegisterCertificateWithoutCA operation.

• The fluent builder is configurable:
  • certificate_pem(impl Into<String>) / set_certificate_pem(Option<String>):
    required: true
    

    The certificate data, in PEM format.

    
    
  • status(CertificateStatus) / set_status(Option<CertificateStatus>):
    required: false
    

    The status of the register certificate request.

    
    
• On success, responds with RegisterCertificateWithoutCaOutput with field(s):
  • certificate_arn(Option<String>):

    The Amazon Resource Name (ARN) of the registered certificate.

  • certificate_id(Option<String>):

    The ID of the registered certificate. (The last part of the certificate ARN contains the certificate ID.

• On failure, responds with SdkError<RegisterCertificateWithoutCAError>

impl Client

pub fn register_thing(&self) -> RegisterThingFluentBuilder

Constructs a fluent builder for the RegisterThing operation.

• The fluent builder is configurable:
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: true
    

    The provisioning template. See Provisioning Devices That Have Device Certificates for more information.

    
    
  • parameters(impl Into<String>, impl Into<String>) / set_parameters(Option<HashMap::<String, String>>):
    required: false
    

    The parameters for provisioning a thing. See Provisioning Templates for more information.

    
    
• On success, responds with RegisterThingOutput with field(s):
  • certificate_pem(Option<String>):

    The certificate data, in PEM format.

  • resource_arns(Option<HashMap::<String, String>>):

    ARNs for the generated resources.

• On failure, responds with SdkError<RegisterThingError>

impl Client

pub fn reject_certificate_transfer( &self, ) -> RejectCertificateTransferFluentBuilder

Constructs a fluent builder for the RejectCertificateTransfer operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

    
    
  • reject_reason(impl Into<String>) / set_reject_reason(Option<String>):
    required: false
    

    The reason the certificate transfer was rejected.

    
    
• On success, responds with RejectCertificateTransferOutput
• On failure, responds with SdkError<RejectCertificateTransferError>

impl Client

pub fn remove_thing_from_billing_group( &self, ) -> RemoveThingFromBillingGroupFluentBuilder

Constructs a fluent builder for the RemoveThingFromBillingGroup operation.

• The fluent builder is configurable:
  • billing_group_name(impl Into<String>) / set_billing_group_name(Option<String>):
    required: false
    

    The name of the billing group.

    
    
  • billing_group_arn(impl Into<String>) / set_billing_group_arn(Option<String>):
    required: false
    

    The ARN of the billing group.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: false
    

    The name of the thing to be removed from the billing group.

    
    
  • thing_arn(impl Into<String>) / set_thing_arn(Option<String>):
    required: false
    

    The ARN of the thing to be removed from the billing group.

    
    
• On success, responds with RemoveThingFromBillingGroupOutput
• On failure, responds with SdkError<RemoveThingFromBillingGroupError>

impl Client

pub fn remove_thing_from_thing_group( &self, ) -> RemoveThingFromThingGroupFluentBuilder

Constructs a fluent builder for the RemoveThingFromThingGroup operation.

• The fluent builder is configurable:
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: false
    

    The group name.

    
    
  • thing_group_arn(impl Into<String>) / set_thing_group_arn(Option<String>):
    required: false
    

    The group ARN.

    
    
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: false
    

    The name of the thing to remove from the group.

    
    
  • thing_arn(impl Into<String>) / set_thing_arn(Option<String>):
    required: false
    

    The ARN of the thing to remove from the group.

    
    
• On success, responds with RemoveThingFromThingGroupOutput
• On failure, responds with SdkError<RemoveThingFromThingGroupError>

impl Client

pub fn replace_topic_rule(&self) -> ReplaceTopicRuleFluentBuilder

Constructs a fluent builder for the ReplaceTopicRule operation.

• The fluent builder is configurable:
  • rule_name(impl Into<String>) / set_rule_name(Option<String>):
    required: true
    

    The name of the rule.

    
    
  • topic_rule_payload(TopicRulePayload) / set_topic_rule_payload(Option<TopicRulePayload>):
    required: true
    

    The rule payload.

    
    
• On success, responds with ReplaceTopicRuleOutput
• On failure, responds with SdkError<ReplaceTopicRuleError>

impl Client

pub fn search_index(&self) -> SearchIndexFluentBuilder

Constructs a fluent builder for the SearchIndex operation.

• The fluent builder is configurable:
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The search index name.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: true
    

    The search query string. For more information about the search query syntax, see Query syntax.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token used to get the next set of results, or null if there are no additional results.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

    
    
  • query_version(impl Into<String>) / set_query_version(Option<String>):
    required: false
    

    The query version.

    
    
• On success, responds with SearchIndexOutput with field(s):
  • next_token(Option<String>):

    The token used to get the next set of results, or null if there are no additional results.

  • things(Option<Vec::<ThingDocument>>):

    The things that match the search query.

  • thing_groups(Option<Vec::<ThingGroupDocument>>):

    The thing groups that match the search query.

• On failure, responds with SdkError<SearchIndexError>

impl Client

pub fn set_default_authorizer(&self) -> SetDefaultAuthorizerFluentBuilder

Constructs a fluent builder for the SetDefaultAuthorizer operation.

• The fluent builder is configurable:
  • authorizer_name(impl Into<String>) / set_authorizer_name(Option<String>):
    required: true
    

    The authorizer name.

    
    
• On success, responds with SetDefaultAuthorizerOutput with field(s):
  • authorizer_name(Option<String>):

    The authorizer name.

  • authorizer_arn(Option<String>):

    The authorizer ARN.

• On failure, responds with SdkError<SetDefaultAuthorizerError>

impl Client

pub fn set_default_policy_version(&self) -> SetDefaultPolicyVersionFluentBuilder

Constructs a fluent builder for the SetDefaultPolicyVersion operation.

• The fluent builder is configurable:
  • policy_name(impl Into<String>) / set_policy_name(Option<String>):
    required: true
    

    The policy name.

    
    
  • policy_version_id(impl Into<String>) / set_policy_version_id(Option<String>):
    required: true
    

    The policy version ID.

    
    
• On success, responds with SetDefaultPolicyVersionOutput
• On failure, responds with SdkError<SetDefaultPolicyVersionError>

impl Client

pub fn set_logging_options(&self) -> SetLoggingOptionsFluentBuilder

Constructs a fluent builder for the SetLoggingOptions operation.

• The fluent builder is configurable:
  • logging_options_payload(LoggingOptionsPayload) / set_logging_options_payload(Option<LoggingOptionsPayload>):
    required: true
    

    The logging options payload.

    
    
• On success, responds with SetLoggingOptionsOutput
• On failure, responds with SdkError<SetLoggingOptionsError>

impl Client

pub fn set_v2_logging_level(&self) -> SetV2LoggingLevelFluentBuilder

Constructs a fluent builder for the SetV2LoggingLevel operation.

• The fluent builder is configurable:
  • log_target(LogTarget) / set_log_target(Option<LogTarget>):
    required: true
    

    The log target.

    
    
  • log_level(LogLevel) / set_log_level(Option<LogLevel>):
    required: true
    

    The log level.

    
    
• On success, responds with SetV2LoggingLevelOutput
• On failure, responds with SdkError<SetV2LoggingLevelError>

impl Client

pub fn set_v2_logging_options(&self) -> SetV2LoggingOptionsFluentBuilder

Constructs a fluent builder for the SetV2LoggingOptions operation.

• The fluent builder is configurable:
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The ARN of the role that allows IoT to write to Cloudwatch logs.

    
    
  • default_log_level(LogLevel) / set_default_log_level(Option<LogLevel>):
    required: false
    

    The default logging level.

    
    
  • disable_all_logs(bool) / set_disable_all_logs(Option<bool>):
    required: false
    

    If true all logs are disabled. The default is false.

    
    
• On success, responds with SetV2LoggingOptionsOutput
• On failure, responds with SdkError<SetV2LoggingOptionsError>

impl Client

pub fn start_audit_mitigation_actions_task( &self, ) -> StartAuditMitigationActionsTaskFluentBuilder

Constructs a fluent builder for the StartAuditMitigationActionsTask operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

    
    
  • target(AuditMitigationActionsTaskTarget) / set_target(Option<AuditMitigationActionsTaskTarget>):
    required: true
    

    Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.

    
    
  • audit_check_to_actions_mapping(impl Into<String>, Vec::<String>) / set_audit_check_to_actions_mapping(Option<HashMap::<String, Vec::<String>>>):
    required: true
    

    For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

    
    
• On success, responds with StartAuditMitigationActionsTaskOutput with field(s):
  • task_id(Option<String>):

    The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

• On failure, responds with SdkError<StartAuditMitigationActionsTaskError>

impl Client

pub fn start_detect_mitigation_actions_task( &self, ) -> StartDetectMitigationActionsTaskFluentBuilder

Constructs a fluent builder for the StartDetectMitigationActionsTask operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The unique identifier of the task.

    
    
  • target(DetectMitigationActionsTaskTarget) / set_target(Option<DetectMitigationActionsTaskTarget>):
    required: true
    

    Specifies the ML Detect findings to which the mitigation actions are applied.

    
    
  • actions(impl Into<String>) / set_actions(Option<Vec::<String>>):
    required: true
    

    The actions to be performed when a device has unexpected behavior.

    
    
  • violation_event_occurrence_range(ViolationEventOccurrenceRange) / set_violation_event_occurrence_range(Option<ViolationEventOccurrenceRange>):
    required: false
    

    Specifies the time period of which violation events occurred between.

    
    
  • include_only_active_violations(bool) / set_include_only_active_violations(Option<bool>):
    required: false
    

    Specifies to list only active violations.

    
    
  • include_suppressed_alerts(bool) / set_include_suppressed_alerts(Option<bool>):
    required: false
    

    Specifies to include suppressed alerts.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: true
    

    Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

    
    
• On success, responds with StartDetectMitigationActionsTaskOutput with field(s):
  • task_id(Option<String>):

    The unique identifier of the task.

• On failure, responds with SdkError<StartDetectMitigationActionsTaskError>

impl Client

pub fn start_on_demand_audit_task(&self) -> StartOnDemandAuditTaskFluentBuilder

Constructs a fluent builder for the StartOnDemandAuditTask operation.

• The fluent builder is configurable:
  • target_check_names(impl Into<String>) / set_target_check_names(Option<Vec::<String>>):
    required: true
    

    Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.

    
    
• On success, responds with StartOnDemandAuditTaskOutput with field(s):
  • task_id(Option<String>):

    The ID of the on-demand audit you started.

• On failure, responds with SdkError<StartOnDemandAuditTaskError>

impl Client

pub fn start_thing_registration_task( &self, ) -> StartThingRegistrationTaskFluentBuilder

Constructs a fluent builder for the StartThingRegistrationTask operation.

• The fluent builder is configurable:
  • template_body(impl Into<String>) / set_template_body(Option<String>):
    required: true
    

    The provisioning template.

    
    
  • input_file_bucket(impl Into<String>) / set_input_file_bucket(Option<String>):
    required: true
    

    The S3 bucket that contains the input file.

    
    
  • input_file_key(impl Into<String>) / set_input_file_key(Option<String>):
    required: true
    

    The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The IAM role ARN that grants permission the input file.

    
    
• On success, responds with StartThingRegistrationTaskOutput with field(s):
  • task_id(Option<String>):

    The bulk thing provisioning task ID.

• On failure, responds with SdkError<StartThingRegistrationTaskError>

impl Client

pub fn stop_thing_registration_task( &self, ) -> StopThingRegistrationTaskFluentBuilder

Constructs a fluent builder for the StopThingRegistrationTask operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):
    required: true
    

    The bulk thing provisioning task ID.

    
    
• On success, responds with StopThingRegistrationTaskOutput
• On failure, responds with SdkError<StopThingRegistrationTaskError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The new or modified tags for the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn test_authorization(&self) -> TestAuthorizationFluentBuilder

Constructs a fluent builder for the TestAuthorization operation.

• The fluent builder is configurable:
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: false
    

    The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

    
    
  • cognito_identity_pool_id(impl Into<String>) / set_cognito_identity_pool_id(Option<String>):
    required: false
    

    The Cognito identity pool ID.

    
    
  • auth_infos(AuthInfo) / set_auth_infos(Option<Vec::<AuthInfo>>):
    required: true
    

    A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

    
    
  • client_id(impl Into<String>) / set_client_id(Option<String>):
    required: false
    

    The MQTT client ID.

    
    
  • policy_names_to_add(impl Into<String>) / set_policy_names_to_add(Option<Vec::<String>>):
    required: false
    

    When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

    
    
  • policy_names_to_skip(impl Into<String>) / set_policy_names_to_skip(Option<Vec::<String>>):
    required: false
    

    When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

    
    
• On success, responds with TestAuthorizationOutput with field(s):
  • auth_results(Option<Vec::<AuthResult>>):

    The authentication results.

• On failure, responds with SdkError<TestAuthorizationError>

impl Client

pub fn test_invoke_authorizer(&self) -> TestInvokeAuthorizerFluentBuilder

Constructs a fluent builder for the TestInvokeAuthorizer operation.

• The fluent builder is configurable:
  • authorizer_name(impl Into<String>) / set_authorizer_name(Option<String>):
    required: true
    

    The custom authorizer name.

    
    
  • token(impl Into<String>) / set_token(Option<String>):
    required: false
    

    The token returned by your custom authentication service.

    
    
  • token_signature(impl Into<String>) / set_token_signature(Option<String>):
    required: false
    

    The signature made with the token and your custom authentication service’s private key. This value must be Base-64-encoded.

    
    
  • http_context(HttpContext) / set_http_context(Option<HttpContext>):
    required: false
    

    Specifies a test HTTP authorization request.

    
    
  • mqtt_context(MqttContext) / set_mqtt_context(Option<MqttContext>):
    required: false
    

    Specifies a test MQTT authorization request.

    
    
  • tls_context(TlsContext) / set_tls_context(Option<TlsContext>):
    required: false
    

    Specifies a test TLS authorization request.

    
    
• On success, responds with TestInvokeAuthorizerOutput with field(s):
  • is_authenticated(Option<bool>):

    True if the token is authenticated, otherwise false.

  • principal_id(Option<String>):

    The principal ID.

  • policy_documents(Option<Vec::<String>>):

    IAM policy documents.

  • refresh_after_in_seconds(Option<i32>):

    The number of seconds after which the temporary credentials are refreshed.

  • disconnect_after_in_seconds(Option<i32>):

    The number of seconds after which the connection is terminated.

• On failure, responds with SdkError<TestInvokeAuthorizerError>

impl Client

pub fn transfer_certificate(&self) -> TransferCertificateFluentBuilder

Constructs a fluent builder for the TransferCertificate operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

    
    
  • target_aws_account(impl Into<String>) / set_target_aws_account(Option<String>):
    required: true
    

    The Amazon Web Services account.

    
    
  • transfer_message(impl Into<String>) / set_transfer_message(Option<String>):
    required: false
    

    The transfer message.

    
    
• On success, responds with TransferCertificateOutput with field(s):
  • transferred_certificate_arn(Option<String>):

    The ARN of the certificate.

• On failure, responds with SdkError<TransferCertificateError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    A list of the keys of the tags to be removed from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_account_audit_configuration( &self, ) -> UpdateAccountAuditConfigurationFluentBuilder

Constructs a fluent builder for the UpdateAccountAuditConfiguration operation.

• The fluent builder is configurable:
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

    
    
  • audit_notification_target_configurations(AuditNotificationType, AuditNotificationTarget) / set_audit_notification_target_configurations(Option<HashMap::<AuditNotificationType, AuditNotificationTarget>>):
    required: false
    

    Information about the targets to which audit notifications are sent.

    
    
  • audit_check_configurations(impl Into<String>, AuditCheckConfiguration) / set_audit_check_configurations(Option<HashMap::<String, AuditCheckConfiguration>>):
    required: false
    

    Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled.

    Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

    You cannot disable a check if it’s used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

    On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.

    
    
• On success, responds with UpdateAccountAuditConfigurationOutput
• On failure, responds with SdkError<UpdateAccountAuditConfigurationError>

impl Client

pub fn update_audit_suppression(&self) -> UpdateAuditSuppressionFluentBuilder

Constructs a fluent builder for the UpdateAuditSuppression operation.

• The fluent builder is configurable:
  • check_name(impl Into<String>) / set_check_name(Option<String>):
    required: true
    

    An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

    
    
  • resource_identifier(ResourceIdentifier) / set_resource_identifier(Option<ResourceIdentifier>):
    required: true
    

    Information that identifies the noncompliant resource.

    
    
  • expiration_date(DateTime) / set_expiration_date(Option<DateTime>):
    required: false
    

    The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.

    
    
  • suppress_indefinitely(bool) / set_suppress_indefinitely(Option<bool>):
    required: false
    

    Indicates whether a suppression should exist indefinitely or not.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the audit suppression.

    
    
• On success, responds with UpdateAuditSuppressionOutput
• On failure, responds with SdkError<UpdateAuditSuppressionError>

impl Client

pub fn update_authorizer(&self) -> UpdateAuthorizerFluentBuilder

Constructs a fluent builder for the UpdateAuthorizer operation.

• The fluent builder is configurable:
  • authorizer_name(impl Into<String>) / set_authorizer_name(Option<String>):
    required: true
    

    The authorizer name.

    
    
  • authorizer_function_arn(impl Into<String>) / set_authorizer_function_arn(Option<String>):
    required: false
    

    The ARN of the authorizer’s Lambda function.

    
    
  • token_key_name(impl Into<String>) / set_token_key_name(Option<String>):
    required: false
    

    The key used to extract the token from the HTTP headers.

    
    
  • token_signing_public_keys(impl Into<String>, impl Into<String>) / set_token_signing_public_keys(Option<HashMap::<String, String>>):
    required: false
    

    The public keys used to verify the token signature.

    
    
  • status(AuthorizerStatus) / set_status(Option<AuthorizerStatus>):
    required: false
    

    The status of the update authorizer request.

    
    
  • enable_caching_for_http(bool) / set_enable_caching_for_http(Option<bool>):
    required: false
    

    When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

    
    
• On success, responds with UpdateAuthorizerOutput with field(s):
  • authorizer_name(Option<String>):

    The authorizer name.

  • authorizer_arn(Option<String>):

    The authorizer ARN.

• On failure, responds with SdkError<UpdateAuthorizerError>

impl Client

pub fn update_billing_group(&self) -> UpdateBillingGroupFluentBuilder

Constructs a fluent builder for the UpdateBillingGroup operation.

• The fluent builder is configurable:
  • billing_group_name(impl Into<String>) / set_billing_group_name(Option<String>):
    required: true
    

    The name of the billing group.

    
    
  • billing_group_properties(BillingGroupProperties) / set_billing_group_properties(Option<BillingGroupProperties>):
    required: true
    

    The properties of the billing group.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException.

    
    
• On success, responds with UpdateBillingGroupOutput with field(s):
  • version(i64):

    The latest version of the billing group.

• On failure, responds with SdkError<UpdateBillingGroupError>

impl Client

pub fn update_ca_certificate(&self) -> UpdateCACertificateFluentBuilder

Constructs a fluent builder for the UpdateCACertificate operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The CA certificate identifier.

    
    
  • new_status(CaCertificateStatus) / set_new_status(Option<CaCertificateStatus>):
    required: false
    

    The updated status of the CA certificate.

    Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

    
    
  • new_auto_registration_status(AutoRegistrationStatus) / set_new_auto_registration_status(Option<AutoRegistrationStatus>):
    required: false
    

    The new value for the auto registration status. Valid values are: “ENABLE” or “DISABLE”.

    
    
  • registration_config(RegistrationConfig) / set_registration_config(Option<RegistrationConfig>):
    required: false
    

    Information about the registration configuration.

    
    
  • remove_auto_registration(bool) / set_remove_auto_registration(Option<bool>):
    required: false
    

    If true, removes auto registration.

    
    
• On success, responds with UpdateCaCertificateOutput
• On failure, responds with SdkError<UpdateCACertificateError>

impl Client

pub fn update_certificate(&self) -> UpdateCertificateFluentBuilder

Constructs a fluent builder for the UpdateCertificate operation.

• The fluent builder is configurable:
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

    
    
  • new_status(CertificateStatus) / set_new_status(Option<CertificateStatus>):
    required: true
    

    The new status.

    Note: Setting the status to PENDING_TRANSFER or PENDING_ACTIVATION will result in an exception being thrown. PENDING_TRANSFER and PENDING_ACTIVATION are statuses used internally by IoT. They are not intended for developer use.

    Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

    
    
• On success, responds with UpdateCertificateOutput
• On failure, responds with SdkError<UpdateCertificateError>

impl Client

pub fn update_certificate_provider( &self, ) -> UpdateCertificateProviderFluentBuilder

Constructs a fluent builder for the UpdateCertificateProvider operation.

• The fluent builder is configurable:
  • certificate_provider_name(impl Into<String>) / set_certificate_provider_name(Option<String>):
    required: true
    

    The name of the certificate provider.

    
    
  • lambda_function_arn(impl Into<String>) / set_lambda_function_arn(Option<String>):
    required: false
    

    The Lambda function ARN that’s associated with the certificate provider.

    
    
  • account_default_for_operations(CertificateProviderOperation) / set_account_default_for_operations(Option<Vec::<CertificateProviderOperation>>):
    required: false
    

    A list of the operations that the certificate provider will use to generate certificates. Valid value: CreateCertificateFromCsr.

    
    
• On success, responds with UpdateCertificateProviderOutput with field(s):
  • certificate_provider_name(Option<String>):

    The name of the certificate provider.

  • certificate_provider_arn(Option<String>):

    The ARN of the certificate provider.

• On failure, responds with SdkError<UpdateCertificateProviderError>

impl Client

pub fn update_command(&self) -> UpdateCommandFluentBuilder

Constructs a fluent builder for the UpdateCommand operation.

• The fluent builder is configurable:
  • command_id(impl Into<String>) / set_command_id(Option<String>):
    required: true
    

    The unique identifier of the command to be updated.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The new user-friendly name to use in the console for the command.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A short text description of the command.

    
    
  • deprecated(bool) / set_deprecated(Option<bool>):
    required: false
    

    A boolean that you can use to specify whether to deprecate a command.

    
    
• On success, responds with UpdateCommandOutput with field(s):
  • command_id(Option<String>):

    The unique identifier of the command.

  • display_name(Option<String>):

    The updated user-friendly display name in the console for the command.

  • description(Option<String>):

    The updated text description of the command.

  • deprecated(Option<bool>):

    The boolean that indicates whether the command was deprecated.

  • last_updated_at(Option<DateTime>):

    The date and time (epoch timestamp in seconds) when the command was last updated.

• On failure, responds with SdkError<UpdateCommandError>

impl Client

pub fn update_custom_metric(&self) -> UpdateCustomMetricFluentBuilder

Constructs a fluent builder for the UpdateCustomMetric operation.

• The fluent builder is configurable:
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    The name of the custom metric. Cannot be updated.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: true
    

    Field represents a friendly name in the console for the custom metric, it doesn’t have to be unique. Don’t use this name as the metric identifier in the device metric report. Can be updated.

    
    
• On success, responds with UpdateCustomMetricOutput with field(s):
  • metric_name(Option<String>):

    The name of the custom metric.

  • metric_arn(Option<String>):

    The Amazon Resource Number (ARN) of the custom metric.

  • metric_type(Option<CustomMetricType>):

    The type of the custom metric.

    The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

  • display_name(Option<String>):

    A friendly name in the console for the custom metric

  • creation_date(Option<DateTime>):

    The creation date of the custom metric in milliseconds since epoch.

  • last_modified_date(Option<DateTime>):

    The time the custom metric was last modified in milliseconds since epoch.

• On failure, responds with SdkError<UpdateCustomMetricError>

impl Client

pub fn update_dimension(&self) -> UpdateDimensionFluentBuilder

Constructs a fluent builder for the UpdateDimension operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

    
    
  • string_values(impl Into<String>) / set_string_values(Option<Vec::<String>>):
    required: true
    

    Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, “admin/#”).

    
    
• On success, responds with UpdateDimensionOutput with field(s):
  • name(Option<String>):

    A unique identifier for the dimension.

  • arn(Option<String>):

    The Amazon Resource Name (ARN)of the created dimension.

  • r#type(Option<DimensionType>):

    The type of the dimension.

  • string_values(Option<Vec::<String>>):

    The value or list of values used to scope the dimension. For example, for topic filters, this is the pattern used to match the MQTT topic name.

  • creation_date(Option<DateTime>):

    The date and time, in milliseconds since epoch, when the dimension was initially created.

  • last_modified_date(Option<DateTime>):

    The date and time, in milliseconds since epoch, when the dimension was most recently updated.

• On failure, responds with SdkError<UpdateDimensionError>

impl Client

pub fn update_domain_configuration( &self, ) -> UpdateDomainConfigurationFluentBuilder

Constructs a fluent builder for the UpdateDomainConfiguration operation.

• The fluent builder is configurable:
  • domain_configuration_name(impl Into<String>) / set_domain_configuration_name(Option<String>):
    required: true
    

    The name of the domain configuration to be updated.

    
    
  • authorizer_config(AuthorizerConfig) / set_authorizer_config(Option<AuthorizerConfig>):
    required: false
    

    An object that specifies the authorization service for a domain.

    
    
  • domain_configuration_status(DomainConfigurationStatus) / set_domain_configuration_status(Option<DomainConfigurationStatus>):
    required: false
    

    The status to which the domain configuration should be updated.

    
    
  • remove_authorizer_config(bool) / set_remove_authorizer_config(Option<bool>):
    required: false
    

    Removes the authorization configuration from a domain.

    
    
  • tls_config(TlsConfig) / set_tls_config(Option<TlsConfig>):
    required: false
    

    An object that specifies the TLS configuration for a domain.

    
    
  • server_certificate_config(ServerCertificateConfig) / set_server_certificate_config(Option<ServerCertificateConfig>):
    required: false
    

    The server certificate configuration.

    
    
  • authentication_type(AuthenticationType) / set_authentication_type(Option<AuthenticationType>):
    required: false
    

    An enumerated string that specifies the authentication type.

    • CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

    • CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

    • AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

    • AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

    • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

    
    
  • application_protocol(ApplicationProtocol) / set_application_protocol(Option<ApplicationProtocol>):
    required: false
    

    An enumerated string that specifies the application-layer protocol.

    • SECURE_MQTT - MQTT over TLS.

    • MQTT_WSS - MQTT over WebSocket.

    • HTTPS - HTTP over TLS.

    • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

    
    
  • client_certificate_config(ClientCertificateConfig) / set_client_certificate_config(Option<ClientCertificateConfig>):
    required: false
    

    An object that specifies the client certificate configuration for a domain.

    
    
• On success, responds with UpdateDomainConfigurationOutput with field(s):
  • domain_configuration_name(Option<String>):

    The name of the domain configuration that was updated.

  • domain_configuration_arn(Option<String>):

    The ARN of the domain configuration that was updated.

• On failure, responds with SdkError<UpdateDomainConfigurationError>

impl Client

pub fn update_dynamic_thing_group(&self) -> UpdateDynamicThingGroupFluentBuilder

Constructs a fluent builder for the UpdateDynamicThingGroup operation.

• The fluent builder is configurable:
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: true
    

    The name of the dynamic thing group to update.

    
    
  • thing_group_properties(ThingGroupProperties) / set_thing_group_properties(Option<ThingGroupProperties>):
    required: true
    

    The dynamic thing group properties to update.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the dynamic thing group to update.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: false
    

    The dynamic thing group index to update.

    Currently one index is supported: AWS_Things.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: false
    

    The dynamic thing group search query string to update.

    
    
  • query_version(impl Into<String>) / set_query_version(Option<String>):
    required: false
    

    The dynamic thing group query version to update.

    Currently one query version is supported: “2017-09-30”. If not specified, the query version defaults to this value.

    
    
• On success, responds with UpdateDynamicThingGroupOutput with field(s):
  • version(i64):

    The dynamic thing group version.

• On failure, responds with SdkError<UpdateDynamicThingGroupError>

impl Client

pub fn update_event_configurations( &self, ) -> UpdateEventConfigurationsFluentBuilder

Constructs a fluent builder for the UpdateEventConfigurations operation.

• The fluent builder is configurable:
  • event_configurations(EventType, Configuration) / set_event_configurations(Option<HashMap::<EventType, Configuration>>):
    required: false
    

    The new event configuration values.

    
    
• On success, responds with UpdateEventConfigurationsOutput
• On failure, responds with SdkError<UpdateEventConfigurationsError>

impl Client

pub fn update_fleet_metric(&self) -> UpdateFleetMetricFluentBuilder

Constructs a fluent builder for the UpdateFleetMetric operation.

• The fluent builder is configurable:
  • metric_name(impl Into<String>) / set_metric_name(Option<String>):
    required: true
    

    The name of the fleet metric to update.

    
    
  • query_string(impl Into<String>) / set_query_string(Option<String>):
    required: false
    

    The search query string.

    
    
  • aggregation_type(AggregationType) / set_aggregation_type(Option<AggregationType>):
    required: false
    

    The type of the aggregation query.

    
    
  • period(i32) / set_period(Option<i32>):
    required: false
    

    The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

    
    
  • aggregation_field(impl Into<String>) / set_aggregation_field(Option<String>):
    required: false
    

    The field to aggregate.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the fleet metric.

    
    
  • query_version(impl Into<String>) / set_query_version(Option<String>):
    required: false
    

    The version of the query.

    
    
  • index_name(impl Into<String>) / set_index_name(Option<String>):
    required: true
    

    The name of the index to search.

    
    
  • unit(FleetMetricUnit) / set_unit(Option<FleetMetricUnit>):
    required: false
    

    Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the fleet metric record in the registry.

    
    
• On success, responds with UpdateFleetMetricOutput
• On failure, responds with SdkError<UpdateFleetMetricError>

impl Client

pub fn update_indexing_configuration( &self, ) -> UpdateIndexingConfigurationFluentBuilder

Constructs a fluent builder for the UpdateIndexingConfiguration operation.

• The fluent builder is configurable:
  • thing_indexing_configuration(ThingIndexingConfiguration) / set_thing_indexing_configuration(Option<ThingIndexingConfiguration>):
    required: false
    

    Thing indexing configuration.

    
    
  • thing_group_indexing_configuration(ThingGroupIndexingConfiguration) / set_thing_group_indexing_configuration(Option<ThingGroupIndexingConfiguration>):
    required: false
    

    Thing group indexing configuration.

    
    
• On success, responds with UpdateIndexingConfigurationOutput
• On failure, responds with SdkError<UpdateIndexingConfigurationError>

impl Client

pub fn update_job(&self) -> UpdateJobFluentBuilder

Constructs a fluent builder for the UpdateJob operation.

• The fluent builder is configurable:
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The ID of the job to be updated.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A short text description of the job.

    
    
  • presigned_url_config(PresignedUrlConfig) / set_presigned_url_config(Option<PresignedUrlConfig>):
    required: false
    

    Configuration information for pre-signed S3 URLs.

    
    
  • job_executions_rollout_config(JobExecutionsRolloutConfig) / set_job_executions_rollout_config(Option<JobExecutionsRolloutConfig>):
    required: false
    

    Allows you to create a staged rollout of the job.

    
    
  • abort_config(AbortConfig) / set_abort_config(Option<AbortConfig>):
    required: false
    

    Allows you to create criteria to abort a job.

    
    
  • timeout_config(TimeoutConfig) / set_timeout_config(Option<TimeoutConfig>):
    required: false
    

    Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

    
    
  • namespace_id(impl Into<String>) / set_namespace_id(Option<String>):
    required: false
    

    The namespace used to indicate that a job is a customer-managed job.

    When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

    $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

    The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

    
    
  • job_executions_retry_config(JobExecutionsRetryConfig) / set_job_executions_retry_config(Option<JobExecutionsRetryConfig>):
    required: false
    

    Allows you to create the criteria to retry a job.

    
    
• On success, responds with UpdateJobOutput
• On failure, responds with SdkError<UpdateJobError>

impl Client

pub fn update_mitigation_action(&self) -> UpdateMitigationActionFluentBuilder

Constructs a fluent builder for the UpdateMitigationAction operation.

• The fluent builder is configurable:
  • action_name(impl Into<String>) / set_action_name(Option<String>):
    required: true
    

    The friendly name for the mitigation action. You cannot change the name by using UpdateMitigationAction. Instead, you must delete and recreate the mitigation action with the new name.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The ARN of the IAM role that is used to apply the mitigation action.

    
    
  • action_params(MitigationActionParams) / set_action_params(Option<MitigationActionParams>):
    required: false
    

    Defines the type of action and the parameters for that action.

    
    
• On success, responds with UpdateMitigationActionOutput with field(s):
  • action_arn(Option<String>):

    The ARN for the new mitigation action.

  • action_id(Option<String>):

    A unique identifier for the mitigation action.

• On failure, responds with SdkError<UpdateMitigationActionError>

impl Client

pub fn update_package(&self) -> UpdatePackageFluentBuilder

Constructs a fluent builder for the UpdatePackage operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the target software package.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The package description.

    
    
  • default_version_name(impl Into<String>) / set_default_version_name(Option<String>):
    required: false
    

    The name of the default package version.

    Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true at the same time.

    
    
  • unset_default_version(bool) / set_unset_default_version(Option<bool>):
    required: false
    

    Indicates whether you want to remove the named default package version from the software package. Set as true to remove the default package version.

    Note: You cannot name a defaultVersion and set unsetDefaultVersion equal to true at the same time.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    
    
• On success, responds with UpdatePackageOutput
• On failure, responds with SdkError<UpdatePackageError>

impl Client

pub fn update_package_configuration( &self, ) -> UpdatePackageConfigurationFluentBuilder

Constructs a fluent builder for the UpdatePackageConfiguration operation.

• The fluent builder is configurable:
  • version_update_by_jobs_config(VersionUpdateByJobsConfig) / set_version_update_by_jobs_config(Option<VersionUpdateByJobsConfig>):
    required: false
    

    Configuration to manage job’s package version reporting. This updates the thing’s reserved named shadow that the job targets.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    
    
• On success, responds with UpdatePackageConfigurationOutput
• On failure, responds with SdkError<UpdatePackageConfigurationError>

impl Client

pub fn update_package_version(&self) -> UpdatePackageVersionFluentBuilder

Constructs a fluent builder for the UpdatePackageVersion operation.

• The fluent builder is configurable:
  • package_name(impl Into<String>) / set_package_name(Option<String>):
    required: true
    

    The name of the associated software package.

    
    
  • version_name(impl Into<String>) / set_version_name(Option<String>):
    required: true
    

    The name of the target package version.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The package version description.

    
    
  • attributes(impl Into<String>, impl Into<String>) / set_attributes(Option<HashMap::<String, String>>):
    required: false
    

    Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.

    Note: Attributes can be updated only when the package version is in a draft state.

    The combined size of all the attributes on a package version is limited to 3KB.

    
    
  • artifact(PackageVersionArtifact) / set_artifact(Option<PackageVersionArtifact>):
    required: false
    

    The various components that make up a software package version.

    
    
  • action(PackageVersionAction) / set_action(Option<PackageVersionAction>):
    required: false
    

    The status that the package version should be assigned. For more information, see Package version lifecycle.

    
    
  • recipe(impl Into<String>) / set_recipe(Option<String>):
    required: false
    

    The inline job document associated with a software package version used for a quick job deployment.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

    
    
• On success, responds with UpdatePackageVersionOutput
• On failure, responds with SdkError<UpdatePackageVersionError>

impl Client

pub fn update_provisioning_template( &self, ) -> UpdateProvisioningTemplateFluentBuilder

Constructs a fluent builder for the UpdateProvisioningTemplate operation.

• The fluent builder is configurable:
  • template_name(impl Into<String>) / set_template_name(Option<String>):
    required: true
    

    The name of the provisioning template.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the provisioning template.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

    True to enable the provisioning template, otherwise false.

    
    
  • default_version_id(i32) / set_default_version_id(Option<i32>):
    required: false
    

    The ID of the default provisioning template version.

    
    
  • provisioning_role_arn(impl Into<String>) / set_provisioning_role_arn(Option<String>):
    required: false
    

    The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.

    
    
  • pre_provisioning_hook(ProvisioningHook) / set_pre_provisioning_hook(Option<ProvisioningHook>):
    required: false
    

    Updates the pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.

    
    
  • remove_pre_provisioning_hook(bool) / set_remove_pre_provisioning_hook(Option<bool>):
    required: false
    

    Removes pre-provisioning hook template.

    
    
• On success, responds with UpdateProvisioningTemplateOutput
• On failure, responds with SdkError<UpdateProvisioningTemplateError>

impl Client

pub fn update_role_alias(&self) -> UpdateRoleAliasFluentBuilder

Constructs a fluent builder for the UpdateRoleAlias operation.

• The fluent builder is configurable:
  • role_alias(impl Into<String>) / set_role_alias(Option<String>):
    required: true
    

    The role alias to update.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The role ARN.

    
    
  • credential_duration_seconds(i32) / set_credential_duration_seconds(Option<i32>):
    required: false
    

    The number of seconds the credential will be valid.

    This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.

    
    
• On success, responds with UpdateRoleAliasOutput with field(s):
  • role_alias(Option<String>):

    The role alias.

  • role_alias_arn(Option<String>):

    The role alias ARN.

• On failure, responds with SdkError<UpdateRoleAliasError>

impl Client

pub fn update_scheduled_audit(&self) -> UpdateScheduledAuditFluentBuilder

Constructs a fluent builder for the UpdateScheduledAudit operation.

• The fluent builder is configurable:
  • frequency(AuditFrequency) / set_frequency(Option<AuditFrequency>):
    required: false
    

    How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.

    
    
  • day_of_month(impl Into<String>) / set_day_of_month(Option<String>):
    required: false
    

    The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the “LAST” day of the month.

    
    
  • day_of_week(DayOfWeek) / set_day_of_week(Option<DayOfWeek>):
    required: false
    

    The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the “frequency” parameter is set to WEEKLY or BIWEEKLY.

    
    
  • target_check_names(impl Into<String>) / set_target_check_names(Option<Vec::<String>>):
    required: false
    

    Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

    
    
  • scheduled_audit_name(impl Into<String>) / set_scheduled_audit_name(Option<String>):
    required: true
    

    The name of the scheduled audit. (Max. 128 chars)

    
    
• On success, responds with UpdateScheduledAuditOutput with field(s):
  • scheduled_audit_arn(Option<String>):

    The ARN of the scheduled audit.

• On failure, responds with SdkError<UpdateScheduledAuditError>

impl Client

pub fn update_security_profile(&self) -> UpdateSecurityProfileFluentBuilder

Constructs a fluent builder for the UpdateSecurityProfile operation.

• The fluent builder is configurable:
  • security_profile_name(impl Into<String>) / set_security_profile_name(Option<String>):
    required: true
    

    The name of the security profile you want to update.

    
    
  • security_profile_description(impl Into<String>) / set_security_profile_description(Option<String>):
    required: false
    

    A description of the security profile.

    
    
  • behaviors(Behavior) / set_behaviors(Option<Vec::<Behavior>>):
    required: false
    

    Specifies the behaviors that, when violated by a device (thing), cause an alert.

    
    
  • alert_targets(AlertTargetType, AlertTarget) / set_alert_targets(Option<HashMap::<AlertTargetType, AlertTarget>>):
    required: false
    

    Where the alerts are sent. (Alerts are always sent to the console.)

    
    
  • additional_metrics_to_retain(impl Into<String>) / set_additional_metrics_to_retain(Option<Vec::<String>>):
    required: false
    

    Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

    
    
  • additional_metrics_to_retain_v2(MetricToRetain) / set_additional_metrics_to_retain_v2(Option<Vec::<MetricToRetain>>):
    required: false
    

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

    
    
  • delete_behaviors(bool) / set_delete_behaviors(Option<bool>):
    required: false
    

    If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

    
    
  • delete_alert_targets(bool) / set_delete_alert_targets(Option<bool>):
    required: false
    

    If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

    
    
  • delete_additional_metrics_to_retain(bool) / set_delete_additional_metrics_to_retain(Option<bool>):
    required: false
    

    If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

    
    
  • metrics_export_config(MetricsExportConfig) / set_metrics_export_config(Option<MetricsExportConfig>):
    required: false
    

    Specifies the MQTT topic and role ARN required for metric export.

    
    
  • delete_metrics_export_config(bool) / set_delete_metrics_export_config(Option<bool>):
    required: false
    

    Set the value as true to delete metrics export related configurations.

    
    
• On success, responds with UpdateSecurityProfileOutput with field(s):
  • security_profile_name(Option<String>):

    The name of the security profile that was updated.

  • security_profile_arn(Option<String>):

    The ARN of the security profile that was updated.

  • security_profile_description(Option<String>):

    The description of the security profile.

  • behaviors(Option<Vec::<Behavior>>):

    Specifies the behaviors that, when violated by a device (thing), cause an alert.

  • alert_targets(Option<HashMap::<AlertTargetType, AlertTarget>>):

    Where the alerts are sent. (Alerts are always sent to the console.)

  • additional_metrics_to_retain(Option<Vec::<String>>):

    Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile’s behaviors, but it is also retained for any metric specified here.

  • additional_metrics_to_retain_v2(Option<Vec::<MetricToRetain>>):

    A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

  • version(i64):

    The updated version of the security profile.

  • creation_date(Option<DateTime>):

    The time the security profile was created.

  • last_modified_date(Option<DateTime>):

    The time the security profile was last modified.

  • metrics_export_config(Option<MetricsExportConfig>):

    Specifies the MQTT topic and role ARN required for metric export.

• On failure, responds with SdkError<UpdateSecurityProfileError>

impl Client

pub fn update_stream(&self) -> UpdateStreamFluentBuilder

Constructs a fluent builder for the UpdateStream operation.

• The fluent builder is configurable:
  • stream_id(impl Into<String>) / set_stream_id(Option<String>):
    required: true
    

    The stream ID.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the stream.

    
    
  • files(StreamFile) / set_files(Option<Vec::<StreamFile>>):
    required: false
    

    The files associated with the stream.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    An IAM role that allows the IoT service principal assumes to access your S3 files.

    
    
• On success, responds with UpdateStreamOutput with field(s):
  • stream_id(Option<String>):

    The stream ID.

  • stream_arn(Option<String>):

    The stream ARN.

  • description(Option<String>):

    A description of the stream.

  • stream_version(Option<i32>):

    The stream version.

• On failure, responds with SdkError<UpdateStreamError>

impl Client

pub fn update_thing(&self) -> UpdateThingFluentBuilder

Constructs a fluent builder for the UpdateThing operation.

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: true
    

    The name of the thing to update.

    You can’t change a thing’s name. To change a thing’s name, you must create a new thing, give it the new name, and then delete the old thing.

    
    
  • thing_type_name(impl Into<String>) / set_thing_type_name(Option<String>):
    required: false
    

    The name of the thing type.

    
    
  • attribute_payload(AttributePayload) / set_attribute_payload(Option<AttributePayload>):
    required: false
    

    A list of thing attributes, a JSON string containing name-value pairs. For example:

    {"attributes":{"name1":"value2"}}

    This data is used to add new attributes or update existing attributes.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.

    
    
  • remove_thing_type(bool) / set_remove_thing_type(Option<bool>):
    required: false
    

    Remove a thing type association. If true, the association is removed.

    
    
• On success, responds with UpdateThingOutput
• On failure, responds with SdkError<UpdateThingError>

impl Client

pub fn update_thing_group(&self) -> UpdateThingGroupFluentBuilder

Constructs a fluent builder for the UpdateThingGroup operation.

• The fluent builder is configurable:
  • thing_group_name(impl Into<String>) / set_thing_group_name(Option<String>):
    required: true
    

    The thing group to update.

    
    
  • thing_group_properties(ThingGroupProperties) / set_thing_group_properties(Option<ThingGroupProperties>):
    required: true
    

    The thing group properties.

    
    
  • expected_version(i64) / set_expected_version(Option<i64>):
    required: false
    

    The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.

    
    
• On success, responds with UpdateThingGroupOutput with field(s):
  • version(i64):

    The version of the updated thing group.

• On failure, responds with SdkError<UpdateThingGroupError>

impl Client

pub fn update_thing_groups_for_thing( &self, ) -> UpdateThingGroupsForThingFluentBuilder

Constructs a fluent builder for the UpdateThingGroupsForThing operation.

• The fluent builder is configurable:
  • thing_name(impl Into<String>) / set_thing_name(Option<String>):
    required: false
    

    The thing whose group memberships will be updated.

    
    
  • thing_groups_to_add(impl Into<String>) / set_thing_groups_to_add(Option<Vec::<String>>):
    required: false
    

    The groups to which the thing will be added.

    
    
  • thing_groups_to_remove(impl Into<String>) / set_thing_groups_to_remove(Option<Vec::<String>>):
    required: false
    

    The groups from which the thing will be removed.

    
    
  • override_dynamic_groups(bool) / set_override_dynamic_groups(Option<bool>):
    required: false
    

    Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.

    
    
• On success, responds with UpdateThingGroupsForThingOutput
• On failure, responds with SdkError<UpdateThingGroupsForThingError>

impl Client

pub fn update_thing_type(&self) -> UpdateThingTypeFluentBuilder

Constructs a fluent builder for the UpdateThingType operation.

• The fluent builder is configurable:
  • thing_type_name(impl Into<String>) / set_thing_type_name(Option<String>):
    required: true
    

    The name of a thing type.

    
    
  • thing_type_properties(ThingTypeProperties) / set_thing_type_properties(Option<ThingTypeProperties>):
    required: false
    

    The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.

    
    
• On success, responds with UpdateThingTypeOutput
• On failure, responds with SdkError<UpdateThingTypeError>

impl Client

pub fn update_topic_rule_destination( &self, ) -> UpdateTopicRuleDestinationFluentBuilder

Constructs a fluent builder for the UpdateTopicRuleDestination operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The ARN of the topic rule destination.

    
    
  • status(TopicRuleDestinationStatus) / set_status(Option<TopicRuleDestinationStatus>):
    required: true
    

    The status of the topic rule destination. Valid values are:

    IN_PROGRESS

    A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

    ENABLED

    Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

    DISABLED

    Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

    ERROR

    Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

    
    
• On success, responds with UpdateTopicRuleDestinationOutput
• On failure, responds with SdkError<UpdateTopicRuleDestinationError>

impl Client

pub fn validate_security_profile_behaviors( &self, ) -> ValidateSecurityProfileBehaviorsFluentBuilder

Constructs a fluent builder for the ValidateSecurityProfileBehaviors operation.

• The fluent builder is configurable:
  • behaviors(Behavior) / set_behaviors(Option<Vec::<Behavior>>):
    required: true
    

    Specifies the behaviors that, when violated by a device (thing), cause an alert.

    
    
• On success, responds with ValidateSecurityProfileBehaviorsOutput with field(s):
  • valid(bool):

    True if the behaviors were valid.

  • validation_errors(Option<Vec::<ValidationError>>):

    The list of any errors found in the behaviors.

• On failure, responds with SdkError<ValidateSecurityProfileBehaviorsError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.