Struct aws_sdk_iot::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_iot::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_iot::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_iot::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn accept_certificate_transfer(&self) -> AcceptCertificateTransfer
pub fn accept_certificate_transfer(&self) -> AcceptCertificateTransfer
Constructs a fluent builder for the AcceptCertificateTransfer
operation.
- The fluent builder is configurable:
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
:The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
set_as_active(bool)
/set_set_as_active(bool)
:Specifies whether the certificate is active.
- On success, responds with
AcceptCertificateTransferOutput
- On failure, responds with
SdkError<AcceptCertificateTransferError>
sourcepub fn add_thing_to_billing_group(&self) -> AddThingToBillingGroup
pub fn add_thing_to_billing_group(&self) -> AddThingToBillingGroup
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>)
: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>)
:The ARN of the billing group.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing to be added to the billing group.
thing_arn(impl Into<String>)
/set_thing_arn(Option<String>)
:The ARN of the thing to be added to the billing group.
- On success, responds with
AddThingToBillingGroupOutput
- On failure, responds with
SdkError<AddThingToBillingGroupError>
sourcepub fn add_thing_to_thing_group(&self) -> AddThingToThingGroup
pub fn add_thing_to_thing_group(&self) -> AddThingToThingGroup
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>)
:The name of the group to which you are adding a thing.
thing_group_arn(impl Into<String>)
/set_thing_group_arn(Option<String>)
:The ARN of the group to which you are adding a thing.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing to add to a group.
thing_arn(impl Into<String>)
/set_thing_arn(Option<String>)
:The ARN of the thing to add to a group.
override_dynamic_groups(bool)
/set_override_dynamic_groups(bool)
: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>
sourcepub fn associate_targets_with_job(&self) -> AssociateTargetsWithJob
pub fn associate_targets_with_job(&self) -> AssociateTargetsWithJob
Constructs a fluent builder for the AssociateTargetsWithJob
operation.
- The fluent builder is configurable:
targets(Vec<String>)
/set_targets(Option<Vec<String>>)
:A list of thing group ARNs that define the targets of the job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The unique identifier you assigned to this job when it was created.
comment(impl Into<String>)
/set_comment(Option<String>)
:An optional comment string describing why the job was associated with the targets.
namespace_id(impl Into<String>)
/set_namespace_id(Option<String>)
: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 in public preview.
- 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>
sourcepub fn attach_policy(&self) -> AttachPolicy
pub fn attach_policy(&self) -> AttachPolicy
Constructs a fluent builder for the AttachPolicy
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The name of the policy to attach.
target(impl Into<String>)
/set_target(Option<String>)
: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>
sourcepub fn attach_principal_policy(&self) -> AttachPrincipalPolicy
pub fn attach_principal_policy(&self) -> AttachPrincipalPolicy
Constructs a fluent builder for the AttachPrincipalPolicy
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The policy name.
principal(impl Into<String>)
/set_principal(Option<String>)
: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>
sourcepub fn attach_security_profile(&self) -> AttachSecurityProfile
pub fn attach_security_profile(&self) -> AttachSecurityProfile
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>)
:The security profile that is attached.
security_profile_target_arn(impl Into<String>)
/set_security_profile_target_arn(Option<String>)
: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>
sourcepub fn attach_thing_principal(&self) -> AttachThingPrincipal
pub fn attach_thing_principal(&self) -> AttachThingPrincipal
Constructs a fluent builder for the AttachThingPrincipal
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing.
principal(impl Into<String>)
/set_principal(Option<String>)
:The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
- On success, responds with
AttachThingPrincipalOutput
- On failure, responds with
SdkError<AttachThingPrincipalError>
sourcepub fn cancel_audit_mitigation_actions_task(
&self
) -> CancelAuditMitigationActionsTask
pub fn cancel_audit_mitigation_actions_task(
&self
) -> CancelAuditMitigationActionsTask
Constructs a fluent builder for the CancelAuditMitigationActionsTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
:The unique identifier for the task that you want to cancel.
- On success, responds with
CancelAuditMitigationActionsTaskOutput
- On failure, responds with
SdkError<CancelAuditMitigationActionsTaskError>
sourcepub fn cancel_audit_task(&self) -> CancelAuditTask
pub fn cancel_audit_task(&self) -> CancelAuditTask
Constructs a fluent builder for the CancelAuditTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
: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>
sourcepub fn cancel_certificate_transfer(&self) -> CancelCertificateTransfer
pub fn cancel_certificate_transfer(&self) -> CancelCertificateTransfer
Constructs a fluent builder for the CancelCertificateTransfer
operation.
- The fluent builder is configurable:
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
: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>
sourcepub fn cancel_detect_mitigation_actions_task(
&self
) -> CancelDetectMitigationActionsTask
pub fn cancel_detect_mitigation_actions_task(
&self
) -> CancelDetectMitigationActionsTask
Constructs a fluent builder for the CancelDetectMitigationActionsTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
:The unique identifier of the task.
- On success, responds with
CancelDetectMitigationActionsTaskOutput
- On failure, responds with
SdkError<CancelDetectMitigationActionsTaskError>
sourcepub fn cancel_job(&self) -> CancelJob
pub fn cancel_job(&self) -> CancelJob
Constructs a fluent builder for the CancelJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The unique identifier you assigned to this job when it was created.
reason_code(impl Into<String>)
/set_reason_code(Option<String>)
:(Optional)A reason code string that explains why the job was canceled.
comment(impl Into<String>)
/set_comment(Option<String>)
:An optional comment string describing why the job was canceled.
force(bool)
/set_force(bool)
:(Optional) If
true
job executions with status “IN_PROGRESS” and “QUEUED” are canceled, otherwise only job executions with status “QUEUED” are canceled. The default isfalse
.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>
sourcepub fn cancel_job_execution(&self) -> CancelJobExecution
pub fn cancel_job_execution(&self) -> CancelJobExecution
Constructs a fluent builder for the CancelJobExecution
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The ID of the job to be canceled.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing whose execution of the job will be canceled.
force(bool)
/set_force(bool)
:(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 setforce
totrue
, then anInvalidStateTransitionException
will be thrown. The default isfalse
.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>)
:(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(HashMap<String, String>)
/set_status_details(Option<HashMap<String, String>>)
: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>
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>
sourcepub fn confirm_topic_rule_destination(&self) -> ConfirmTopicRuleDestination
pub fn confirm_topic_rule_destination(&self) -> ConfirmTopicRuleDestination
Constructs a fluent builder for the ConfirmTopicRuleDestination
operation.
- The fluent builder is configurable:
confirmation_token(impl Into<String>)
/set_confirmation_token(Option<String>)
: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>
sourcepub fn create_audit_suppression(&self) -> CreateAuditSuppression
pub fn create_audit_suppression(&self) -> CreateAuditSuppression
Constructs a fluent builder for the CreateAuditSuppression
operation.
- The fluent builder is configurable:
check_name(impl Into<String>)
/set_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 useUpdateAccountAuditConfiguration
to select which checks are enabled.)resource_identifier(ResourceIdentifier)
/set_resource_identifier(Option<ResourceIdentifier>)
:Information that identifies the noncompliant resource.
expiration_date(DateTime)
/set_expiration_date(Option<DateTime>)
:The epoch timestamp in seconds at which this suppression expires.
suppress_indefinitely(bool)
/set_suppress_indefinitely(Option<bool>)
:Indicates whether a suppression should exist indefinitely or not.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the audit suppression.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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>
Constructs a fluent builder for the CreateAuthorizer
operation.
- The fluent builder is configurable:
authorizer_name(impl Into<String>)
/set_authorizer_name(Option<String>)
:The authorizer name.
authorizer_function_arn(impl Into<String>)
/set_authorizer_function_arn(Option<String>)
:The ARN of the authorizer’s Lambda function.
token_key_name(impl Into<String>)
/set_token_key_name(Option<String>)
:The name of the token key used to extract the token from the HTTP headers.
token_signing_public_keys(HashMap<String, String>)
/set_token_signing_public_keys(Option<HashMap<String, String>>)
:The public keys used to verify the digital signature returned by your custom authentication service.
status(AuthorizerStatus)
/set_status(Option<AuthorizerStatus>)
:The status of the create authorizer request.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>)
:Specifies whether IoT validates the token signature in an authorization request.
enable_caching_for_http(bool)
/set_enable_caching_for_http(Option<bool>)
: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 inrefreshAfterInSeconds
. 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>
sourcepub fn create_billing_group(&self) -> CreateBillingGroup
pub fn create_billing_group(&self) -> CreateBillingGroup
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>)
:The name you wish to give to the billing group.
billing_group_properties(BillingGroupProperties)
/set_billing_group_properties(Option<BillingGroupProperties>)
:The properties of the billing group.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_certificate_from_csr(&self) -> CreateCertificateFromCsr
pub fn create_certificate_from_csr(&self) -> CreateCertificateFromCsr
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>)
:The certificate signing request (CSR).
set_as_active(bool)
/set_set_as_active(bool)
: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>
sourcepub fn create_custom_metric(&self) -> CreateCustomMetric
pub fn create_custom_metric(&self) -> CreateCustomMetric
Constructs a fluent builder for the CreateCustomMetric
operation.
- The fluent builder is configurable:
metric_name(impl Into<String>)
/set_metric_name(Option<String>)
: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>)
: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>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Metadata that can be used to manage the custom metric.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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>
sourcepub fn create_dimension(&self) -> CreateDimension
pub fn create_dimension(&self) -> CreateDimension
Constructs a fluent builder for the CreateDimension
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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>)
:Specifies the type of dimension. Supported types:
TOPIC_FILTER.
string_values(Vec<String>)
/set_string_values(Option<Vec<String>>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Metadata that can be used to manage the dimension.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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>
sourcepub fn create_domain_configuration(&self) -> CreateDomainConfiguration
pub fn create_domain_configuration(&self) -> CreateDomainConfiguration
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>)
:The name of the domain configuration. This value must be unique to a region.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The name of the domain.
server_certificate_arns(Vec<String>)
/set_server_certificate_arns(Option<Vec<String>>)
: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>)
: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>)
:An object that specifies the authorization service for a domain.
service_type(ServiceType)
/set_service_type(Option<ServiceType>)
:The type of service delivered by the endpoint.
Amazon Web Services IoT Core currently supports only the
DATA
service type.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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…”
- 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>
sourcepub fn create_dynamic_thing_group(&self) -> CreateDynamicThingGroup
pub fn create_dynamic_thing_group(&self) -> CreateDynamicThingGroup
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>)
:The dynamic thing group name to create.
thing_group_properties(ThingGroupProperties)
/set_thing_group_properties(Option<ThingGroupProperties>)
:The dynamic thing group properties.
index_name(impl Into<String>)
/set_index_name(Option<String>)
:The dynamic thing group index name.
Currently one index is supported:
AWS_Things
.query_string(impl Into<String>)
/set_query_string(Option<String>)
: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>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_fleet_metric(&self) -> CreateFleetMetric
pub fn create_fleet_metric(&self) -> CreateFleetMetric
Constructs a fluent builder for the CreateFleetMetric
operation.
- The fluent builder is configurable:
metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:The name of the fleet metric to create.
query_string(impl Into<String>)
/set_query_string(Option<String>)
:The search query string.
aggregation_type(AggregationType)
/set_aggregation_type(Option<AggregationType>)
:The type of the aggregation query.
period(i32)
/set_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(impl Into<String>)
/set_aggregation_field(Option<String>)
:The field to aggregate.
description(impl Into<String>)
/set_description(Option<String>)
:The fleet metric description.
query_version(impl Into<String>)
/set_query_version(Option<String>)
:The query version.
index_name(impl Into<String>)
/set_index_name(Option<String>)
:The name of the index to search.
unit(FleetMetricUnit)
/set_unit(Option<FleetMetricUnit>)
:Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_job(&self) -> CreateJob
pub fn create_job(&self) -> CreateJob
Constructs a fluent builder for the CreateJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, “-” and “_” are valid for use here.
targets(Vec<String>)
/set_targets(Option<Vec<String>>)
:A list of things and thing groups to which the job should be sent.
document_source(impl Into<String>)
/set_document_source(Option<String>)
:An S3 link to the job document. Required if you don’t specify a value for
document
.If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
document(impl Into<String>)
/set_document(Option<String>)
:The job document. Required if you don’t specify a value for
documentSource
.description(impl Into<String>)
/set_description(Option<String>)
:A short text description of the job.
presigned_url_config(PresignedUrlConfig)
/set_presigned_url_config(Option<PresignedUrlConfig>)
:Configuration information for pre-signed S3 URLs.
target_selection(TargetSelection)
/set_target_selection(Option<TargetSelection>)
: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>)
:Allows you to create a staged rollout of the job.
abort_config(AbortConfig)
/set_abort_config(Option<AbortConfig>)
:Allows you to create the criteria to abort a job.
timeout_config(TimeoutConfig)
/set_timeout_config(Option<TimeoutConfig>)
: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 toTIMED_OUT
.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Metadata which can be used to manage the job.
namespace_id(impl Into<String>)
/set_namespace_id(Option<String>)
: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 in public preview.job_template_arn(impl Into<String>)
/set_job_template_arn(Option<String>)
:The ARN of the job template used to create the job.
job_executions_retry_config(JobExecutionsRetryConfig)
/set_job_executions_retry_config(Option<JobExecutionsRetryConfig>)
:Allows you to create the criteria to retry a job.
document_parameters(HashMap<String, String>)
/set_document_parameters(Option<HashMap<String, String>>)
: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.
- 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>
sourcepub fn create_job_template(&self) -> CreateJobTemplate
pub fn create_job_template(&self) -> CreateJobTemplate
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>)
: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>)
:The ARN of the job to use as the basis for the job template.
document_source(impl Into<String>)
/set_document_source(Option<String>)
:An S3 link to the job document to use in the template. Required if you don’t specify a value for
document
.If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
document(impl Into<String>)
/set_document(Option<String>)
:The job document. Required if you don’t specify a value for
documentSource
.description(impl Into<String>)
/set_description(Option<String>)
:A description of the job document.
presigned_url_config(PresignedUrlConfig)
/set_presigned_url_config(Option<PresignedUrlConfig>)
:Configuration for pre-signed S3 URLs.
job_executions_rollout_config(JobExecutionsRolloutConfig)
/set_job_executions_rollout_config(Option<JobExecutionsRolloutConfig>)
:Allows you to create a staged rollout of a job.
abort_config(AbortConfig)
/set_abort_config(Option<AbortConfig>)
:The criteria that determine when and how a job abort takes place.
timeout_config(TimeoutConfig)
/set_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 toTIMED_OUT
.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Metadata that can be used to manage the job template.
job_executions_retry_config(JobExecutionsRetryConfig)
/set_job_executions_retry_config(Option<JobExecutionsRetryConfig>)
:Allows you to create the criteria to retry a job.
- 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>
sourcepub fn create_keys_and_certificate(&self) -> CreateKeysAndCertificate
pub fn create_keys_and_certificate(&self) -> CreateKeysAndCertificate
Constructs a fluent builder for the CreateKeysAndCertificate
operation.
- The fluent builder is configurable:
set_as_active(bool)
/set_set_as_active(bool)
: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>
sourcepub fn create_mitigation_action(&self) -> CreateMitigationAction
pub fn create_mitigation_action(&self) -> CreateMitigationAction
Constructs a fluent builder for the CreateMitigationAction
operation.
- The fluent builder is configurable:
action_name(impl Into<String>)
/set_action_name(Option<String>)
: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>)
:The ARN of the IAM role that is used to apply the mitigation action.
action_params(MitigationActionParams)
/set_action_params(Option<MitigationActionParams>)
:Defines the type of action and the parameters for that action.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_ota_update(&self) -> CreateOTAUpdate
pub fn create_ota_update(&self) -> CreateOTAUpdate
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>)
:The ID of the OTA update to be created.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the OTA update.
targets(Vec<String>)
/set_targets(Option<Vec<String>>)
:The devices targeted to receive OTA updates.
protocols(Vec<Protocol>)
/set_protocols(Option<Vec<Protocol>>)
: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>)
: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>)
:Configuration for the rollout of OTA updates.
aws_job_presigned_url_config(AwsJobPresignedUrlConfig)
/set_aws_job_presigned_url_config(Option<AwsJobPresignedUrlConfig>)
:Configuration information for pre-signed URLs.
aws_job_abort_config(AwsJobAbortConfig)
/set_aws_job_abort_config(Option<AwsJobAbortConfig>)
:The criteria that determine when and how a job abort takes place.
aws_job_timeout_config(AwsJobTimeoutConfig)
/set_aws_job_timeout_config(Option<AwsJobTimeoutConfig>)
: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 toTIMED_OUT
.files(Vec<OtaUpdateFile>)
/set_files(Option<Vec<OtaUpdateFile>>)
:The files to be streamed by the OTA update.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
: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(HashMap<String, String>)
/set_additional_parameters(Option<HashMap<String, String>>)
:A list of additional OTA update parameters which are name-value pairs.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_policy(&self) -> CreatePolicy
pub fn create_policy(&self) -> CreatePolicy
Constructs a fluent builder for the CreatePolicy
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The policy name.
policy_document(impl Into<String>)
/set_policy_document(Option<String>)
:The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_policy_version(&self) -> CreatePolicyVersion
pub fn create_policy_version(&self) -> CreatePolicyVersion
Constructs a fluent builder for the CreatePolicyVersion
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The policy name.
policy_document(impl Into<String>)
/set_policy_document(Option<String>)
: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(bool)
: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>
sourcepub fn create_provisioning_claim(&self) -> CreateProvisioningClaim
pub fn create_provisioning_claim(&self) -> CreateProvisioningClaim
Constructs a fluent builder for the CreateProvisioningClaim
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
: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>
sourcepub fn create_provisioning_template(&self) -> CreateProvisioningTemplate
pub fn create_provisioning_template(&self) -> CreateProvisioningTemplate
Constructs a fluent builder for the CreateProvisioningTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the fleet provisioning template.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the fleet provisioning template.
template_body(impl Into<String>)
/set_template_body(Option<String>)
:The JSON formatted contents of the fleet provisioning template.
enabled(bool)
/set_enabled(bool)
:True to enable the fleet provisioning template, otherwise false.
provisioning_role_arn(impl Into<String>)
/set_provisioning_role_arn(Option<String>)
:The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to provision a device.
pre_provisioning_hook(ProvisioningHook)
/set_pre_provisioning_hook(Option<ProvisioningHook>)
:Creates a pre-provisioning hook template.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Metadata which can be used to manage the fleet 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…”
- 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 fleet provisioning template.
default_version_id(Option<i32>)
:The default version of the fleet provisioning template.
- On failure, responds with
SdkError<CreateProvisioningTemplateError>
sourcepub fn create_provisioning_template_version(
&self
) -> CreateProvisioningTemplateVersion
pub fn create_provisioning_template_version(
&self
) -> CreateProvisioningTemplateVersion
Constructs a fluent builder for the CreateProvisioningTemplateVersion
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the fleet provisioning template.
template_body(impl Into<String>)
/set_template_body(Option<String>)
:The JSON formatted contents of the fleet provisioning template.
set_as_default(bool)
/set_set_as_default(bool)
: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 fleet provisioning template.
version_id(Option<i32>)
:The version of the fleet provisioning template.
is_default_version(bool)
:True if the fleet provisioning template version is the default version, otherwise false.
- On failure, responds with
SdkError<CreateProvisioningTemplateVersionError>
sourcepub fn create_role_alias(&self) -> CreateRoleAlias
pub fn create_role_alias(&self) -> CreateRoleAlias
Constructs a fluent builder for the CreateRoleAlias
operation.
- The fluent builder is configurable:
role_alias(impl Into<String>)
/set_role_alias(Option<String>)
: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>)
:The role ARN.
credential_duration_seconds(i32)
/set_credential_duration_seconds(Option<i32>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_scheduled_audit(&self) -> CreateScheduledAudit
pub fn create_scheduled_audit(&self) -> CreateScheduledAudit
Constructs a fluent builder for the CreateScheduledAudit
operation.
- The fluent builder is configurable:
frequency(AuditFrequency)
/set_frequency(Option<AuditFrequency>)
:How often the scheduled audit takes place, either
DAILY
,WEEKLY
,BIWEEKLY
orMONTHLY
. The start time of each audit is determined by the system.day_of_month(impl Into<String>)
/set_day_of_month(Option<String>)
: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 theLAST
day of the month.day_of_week(DayOfWeek)
/set_day_of_week(Option<DayOfWeek>)
:The day of the week on which the scheduled audit takes place, either
SUN
,MON
,TUE
,WED
,THU
,FRI
, orSAT
. This field is required if thefrequency
parameter is set toWEEKLY
orBIWEEKLY
.target_check_names(Vec<String>)
/set_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 useUpdateAccountAuditConfiguration
to select which checks are enabled.)scheduled_audit_name(impl Into<String>)
/set_scheduled_audit_name(Option<String>)
:The name you want to give to the scheduled audit. (Max. 128 chars)
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_security_profile(&self) -> CreateSecurityProfile
pub fn create_security_profile(&self) -> CreateSecurityProfile
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>)
:The name you are giving to the security profile.
security_profile_description(impl Into<String>)
/set_security_profile_description(Option<String>)
:A description of the security profile.
behaviors(Vec<Behavior>)
/set_behaviors(Option<Vec<Behavior>>)
:Specifies the behaviors that, when violated by a device (thing), cause an alert.
alert_targets(HashMap<AlertTargetType, AlertTarget>)
/set_alert_targets(Option<HashMap<AlertTargetType, AlertTarget>>)
: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(Vec<String>)
/set_additional_metrics_to_retain(Option<Vec<String>>)
: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(Vec<MetricToRetain>)
/set_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.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Metadata that can be used to manage the security profile.
- 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>
sourcepub fn create_stream(&self) -> CreateStream
pub fn create_stream(&self) -> CreateStream
Constructs a fluent builder for the CreateStream
operation.
- The fluent builder is configurable:
stream_id(impl Into<String>)
/set_stream_id(Option<String>)
:The stream ID.
description(impl Into<String>)
/set_description(Option<String>)
:A description of the stream.
files(Vec<StreamFile>)
/set_files(Option<Vec<StreamFile>>)
:The files to stream.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:An IAM role that allows the IoT service principal to access your S3 files.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_thing(&self) -> CreateThing
pub fn create_thing(&self) -> CreateThing
Constructs a fluent builder for the CreateThing
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
: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>)
:The name of the thing type associated with the new thing.
attribute_payload(AttributePayload)
/set_attribute_payload(Option<AttributePayload>)
: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>)
: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>
sourcepub fn create_thing_group(&self) -> CreateThingGroup
pub fn create_thing_group(&self) -> CreateThingGroup
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>)
:The thing group name to create.
parent_group_name(impl Into<String>)
/set_parent_group_name(Option<String>)
:The name of the parent thing group.
thing_group_properties(ThingGroupProperties)
/set_thing_group_properties(Option<ThingGroupProperties>)
:The thing group properties.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_thing_type(&self) -> CreateThingType
pub fn create_thing_type(&self) -> CreateThingType
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>)
:The name of the thing type.
thing_type_properties(ThingTypeProperties)
/set_thing_type_properties(Option<ThingTypeProperties>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_topic_rule(&self) -> CreateTopicRule
pub fn create_topic_rule(&self) -> CreateTopicRule
Constructs a fluent builder for the CreateTopicRule
operation.
- The fluent builder is configurable:
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:The name of the rule.
topic_rule_payload(TopicRulePayload)
/set_topic_rule_payload(Option<TopicRulePayload>)
:The rule payload.
tags(impl Into<String>)
/set_tags(Option<String>)
: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>
sourcepub fn create_topic_rule_destination(&self) -> CreateTopicRuleDestination
pub fn create_topic_rule_destination(&self) -> CreateTopicRuleDestination
Constructs a fluent builder for the CreateTopicRuleDestination
operation.
- The fluent builder is configurable:
destination_configuration(TopicRuleDestinationConfiguration)
/set_destination_configuration(Option<TopicRuleDestinationConfiguration>)
: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>
sourcepub fn delete_account_audit_configuration(
&self
) -> DeleteAccountAuditConfiguration
pub fn delete_account_audit_configuration(
&self
) -> DeleteAccountAuditConfiguration
Constructs a fluent builder for the DeleteAccountAuditConfiguration
operation.
- The fluent builder is configurable:
delete_scheduled_audits(bool)
/set_delete_scheduled_audits(bool)
:If true, all scheduled audits are deleted.
- On success, responds with
DeleteAccountAuditConfigurationOutput
- On failure, responds with
SdkError<DeleteAccountAuditConfigurationError>
sourcepub fn delete_audit_suppression(&self) -> DeleteAuditSuppression
pub fn delete_audit_suppression(&self) -> DeleteAuditSuppression
Constructs a fluent builder for the DeleteAuditSuppression
operation.
- The fluent builder is configurable:
check_name(impl Into<String>)
/set_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 useUpdateAccountAuditConfiguration
to select which checks are enabled.)resource_identifier(ResourceIdentifier)
/set_resource_identifier(Option<ResourceIdentifier>)
:Information that identifies the noncompliant resource.
- On success, responds with
DeleteAuditSuppressionOutput
- On failure, responds with
SdkError<DeleteAuditSuppressionError>
Constructs a fluent builder for the DeleteAuthorizer
operation.
- The fluent builder is configurable:
authorizer_name(impl Into<String>)
/set_authorizer_name(Option<String>)
:The name of the authorizer to delete.
- On success, responds with
DeleteAuthorizerOutput
- On failure, responds with
SdkError<DeleteAuthorizerError>
sourcepub fn delete_billing_group(&self) -> DeleteBillingGroup
pub fn delete_billing_group(&self) -> DeleteBillingGroup
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>)
:The name of the billing group.
expected_version(i64)
/set_expected_version(Option<i64>)
: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 aVersionConflictException
.
- On success, responds with
DeleteBillingGroupOutput
- On failure, responds with
SdkError<DeleteBillingGroupError>
sourcepub fn delete_ca_certificate(&self) -> DeleteCACertificate
pub fn delete_ca_certificate(&self) -> DeleteCACertificate
Constructs a fluent builder for the DeleteCACertificate
operation.
- The fluent builder is configurable:
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
: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>
sourcepub fn delete_certificate(&self) -> DeleteCertificate
pub fn delete_certificate(&self) -> DeleteCertificate
Constructs a fluent builder for the DeleteCertificate
operation.
- The fluent builder is configurable:
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
:The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
force_delete(bool)
/set_force_delete(bool)
: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>
sourcepub fn delete_custom_metric(&self) -> DeleteCustomMetric
pub fn delete_custom_metric(&self) -> DeleteCustomMetric
Constructs a fluent builder for the DeleteCustomMetric
operation.
- The fluent builder is configurable:
metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:The name of the custom metric.
- On success, responds with
DeleteCustomMetricOutput
- On failure, responds with
SdkError<DeleteCustomMetricError>
sourcepub fn delete_dimension(&self) -> DeleteDimension
pub fn delete_dimension(&self) -> DeleteDimension
Constructs a fluent builder for the DeleteDimension
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The unique identifier for the dimension that you want to delete.
- On success, responds with
DeleteDimensionOutput
- On failure, responds with
SdkError<DeleteDimensionError>
sourcepub fn delete_domain_configuration(&self) -> DeleteDomainConfiguration
pub fn delete_domain_configuration(&self) -> DeleteDomainConfiguration
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>)
:The name of the domain configuration to be deleted.
- On success, responds with
DeleteDomainConfigurationOutput
- On failure, responds with
SdkError<DeleteDomainConfigurationError>
sourcepub fn delete_dynamic_thing_group(&self) -> DeleteDynamicThingGroup
pub fn delete_dynamic_thing_group(&self) -> DeleteDynamicThingGroup
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>)
:The name of the dynamic thing group to delete.
expected_version(i64)
/set_expected_version(Option<i64>)
:The expected version of the dynamic thing group to delete.
- On success, responds with
DeleteDynamicThingGroupOutput
- On failure, responds with
SdkError<DeleteDynamicThingGroupError>
sourcepub fn delete_fleet_metric(&self) -> DeleteFleetMetric
pub fn delete_fleet_metric(&self) -> DeleteFleetMetric
Constructs a fluent builder for the DeleteFleetMetric
operation.
- The fluent builder is configurable:
metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:The name of the fleet metric to delete.
expected_version(i64)
/set_expected_version(Option<i64>)
:The expected version of the fleet metric to delete.
- On success, responds with
DeleteFleetMetricOutput
- On failure, responds with
SdkError<DeleteFleetMetricError>
sourcepub fn delete_job(&self) -> DeleteJob
pub fn delete_job(&self) -> DeleteJob
Constructs a fluent builder for the DeleteJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
: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(bool)
:(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>)
: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 in public preview.
- On success, responds with
DeleteJobOutput
- On failure, responds with
SdkError<DeleteJobError>
sourcepub fn delete_job_execution(&self) -> DeleteJobExecution
pub fn delete_job_execution(&self) -> DeleteJobExecution
Constructs a fluent builder for the DeleteJobExecution
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The ID of the job whose execution on a particular device will be deleted.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing whose job execution will be deleted.
execution_number(i64)
/set_execution_number(Option<i64>)
: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(bool)
:(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>)
: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 in public preview.
- On success, responds with
DeleteJobExecutionOutput
- On failure, responds with
SdkError<DeleteJobExecutionError>
sourcepub fn delete_job_template(&self) -> DeleteJobTemplate
pub fn delete_job_template(&self) -> DeleteJobTemplate
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>)
:The unique identifier of the job template to delete.
- On success, responds with
DeleteJobTemplateOutput
- On failure, responds with
SdkError<DeleteJobTemplateError>
sourcepub fn delete_mitigation_action(&self) -> DeleteMitigationAction
pub fn delete_mitigation_action(&self) -> DeleteMitigationAction
Constructs a fluent builder for the DeleteMitigationAction
operation.
- The fluent builder is configurable:
action_name(impl Into<String>)
/set_action_name(Option<String>)
:The name of the mitigation action that you want to delete.
- On success, responds with
DeleteMitigationActionOutput
- On failure, responds with
SdkError<DeleteMitigationActionError>
sourcepub fn delete_ota_update(&self) -> DeleteOTAUpdate
pub fn delete_ota_update(&self) -> DeleteOTAUpdate
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>)
:The ID of the OTA update to delete.
delete_stream(bool)
/set_delete_stream(bool)
: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(bool)
: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>
sourcepub fn delete_policy(&self) -> DeletePolicy
pub fn delete_policy(&self) -> DeletePolicy
Constructs a fluent builder for the DeletePolicy
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The name of the policy to delete.
- On success, responds with
DeletePolicyOutput
- On failure, responds with
SdkError<DeletePolicyError>
sourcepub fn delete_policy_version(&self) -> DeletePolicyVersion
pub fn delete_policy_version(&self) -> DeletePolicyVersion
Constructs a fluent builder for the DeletePolicyVersion
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The name of the policy.
policy_version_id(impl Into<String>)
/set_policy_version_id(Option<String>)
:The policy version ID.
- On success, responds with
DeletePolicyVersionOutput
- On failure, responds with
SdkError<DeletePolicyVersionError>
sourcepub fn delete_provisioning_template(&self) -> DeleteProvisioningTemplate
pub fn delete_provisioning_template(&self) -> DeleteProvisioningTemplate
Constructs a fluent builder for the DeleteProvisioningTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the fleet provision template to delete.
- On success, responds with
DeleteProvisioningTemplateOutput
- On failure, responds with
SdkError<DeleteProvisioningTemplateError>
sourcepub fn delete_provisioning_template_version(
&self
) -> DeleteProvisioningTemplateVersion
pub fn delete_provisioning_template_version(
&self
) -> DeleteProvisioningTemplateVersion
Constructs a fluent builder for the DeleteProvisioningTemplateVersion
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the fleet provisioning template version to delete.
version_id(i32)
/set_version_id(Option<i32>)
:The fleet provisioning template version ID to delete.
- On success, responds with
DeleteProvisioningTemplateVersionOutput
- On failure, responds with
SdkError<DeleteProvisioningTemplateVersionError>
sourcepub fn delete_registration_code(&self) -> DeleteRegistrationCode
pub fn delete_registration_code(&self) -> DeleteRegistrationCode
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>
sourcepub fn delete_role_alias(&self) -> DeleteRoleAlias
pub fn delete_role_alias(&self) -> DeleteRoleAlias
Constructs a fluent builder for the DeleteRoleAlias
operation.
- The fluent builder is configurable:
role_alias(impl Into<String>)
/set_role_alias(Option<String>)
:The role alias to delete.
- On success, responds with
DeleteRoleAliasOutput
- On failure, responds with
SdkError<DeleteRoleAliasError>
sourcepub fn delete_scheduled_audit(&self) -> DeleteScheduledAudit
pub fn delete_scheduled_audit(&self) -> DeleteScheduledAudit
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>)
:The name of the scheduled audit you want to delete.
- On success, responds with
DeleteScheduledAuditOutput
- On failure, responds with
SdkError<DeleteScheduledAuditError>
sourcepub fn delete_security_profile(&self) -> DeleteSecurityProfile
pub fn delete_security_profile(&self) -> DeleteSecurityProfile
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>)
:The name of the security profile to be deleted.
expected_version(i64)
/set_expected_version(Option<i64>)
: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>
sourcepub fn delete_stream(&self) -> DeleteStream
pub fn delete_stream(&self) -> DeleteStream
Constructs a fluent builder for the DeleteStream
operation.
- The fluent builder is configurable:
stream_id(impl Into<String>)
/set_stream_id(Option<String>)
:The stream ID.
- On success, responds with
DeleteStreamOutput
- On failure, responds with
SdkError<DeleteStreamError>
sourcepub fn delete_thing(&self) -> DeleteThing
pub fn delete_thing(&self) -> DeleteThing
Constructs a fluent builder for the DeleteThing
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing to delete.
expected_version(i64)
/set_expected_version(Option<i64>)
: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 aVersionConflictException
.
- On success, responds with
DeleteThingOutput
- On failure, responds with
SdkError<DeleteThingError>
sourcepub fn delete_thing_group(&self) -> DeleteThingGroup
pub fn delete_thing_group(&self) -> DeleteThingGroup
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>)
:The name of the thing group to delete.
expected_version(i64)
/set_expected_version(Option<i64>)
:The expected version of the thing group to delete.
- On success, responds with
DeleteThingGroupOutput
- On failure, responds with
SdkError<DeleteThingGroupError>
sourcepub fn delete_thing_type(&self) -> DeleteThingType
pub fn delete_thing_type(&self) -> DeleteThingType
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>)
:The name of the thing type.
- On success, responds with
DeleteThingTypeOutput
- On failure, responds with
SdkError<DeleteThingTypeError>
sourcepub fn delete_topic_rule(&self) -> DeleteTopicRule
pub fn delete_topic_rule(&self) -> DeleteTopicRule
Constructs a fluent builder for the DeleteTopicRule
operation.
- The fluent builder is configurable:
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:The name of the rule.
- On success, responds with
DeleteTopicRuleOutput
- On failure, responds with
SdkError<DeleteTopicRuleError>
sourcepub fn delete_topic_rule_destination(&self) -> DeleteTopicRuleDestination
pub fn delete_topic_rule_destination(&self) -> DeleteTopicRuleDestination
Constructs a fluent builder for the DeleteTopicRuleDestination
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:The ARN of the topic rule destination to delete.
- On success, responds with
DeleteTopicRuleDestinationOutput
- On failure, responds with
SdkError<DeleteTopicRuleDestinationError>
sourcepub fn delete_v2_logging_level(&self) -> DeleteV2LoggingLevel
pub fn delete_v2_logging_level(&self) -> DeleteV2LoggingLevel
Constructs a fluent builder for the DeleteV2LoggingLevel
operation.
- The fluent builder is configurable:
target_type(LogTargetType)
/set_target_type(Option<LogTargetType>)
:The type of resource for which you are configuring logging. Must be
THING_Group
.target_name(impl Into<String>)
/set_target_name(Option<String>)
:The name of the resource for which you are configuring logging.
- On success, responds with
DeleteV2LoggingLevelOutput
- On failure, responds with
SdkError<DeleteV2LoggingLevelError>
sourcepub fn deprecate_thing_type(&self) -> DeprecateThingType
pub fn deprecate_thing_type(&self) -> DeprecateThingType
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>)
:The name of the thing type to deprecate.
undo_deprecate(bool)
/set_undo_deprecate(bool)
: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>
sourcepub fn describe_account_audit_configuration(
&self
) -> DescribeAccountAuditConfiguration
pub fn describe_account_audit_configuration(
&self
) -> DescribeAccountAuditConfiguration
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>
sourcepub fn describe_audit_finding(&self) -> DescribeAuditFinding
pub fn describe_audit_finding(&self) -> DescribeAuditFinding
Constructs a fluent builder for the DescribeAuditFinding
operation.
- The fluent builder is configurable:
finding_id(impl Into<String>)
/set_finding_id(Option<String>)
: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>
sourcepub fn describe_audit_mitigation_actions_task(
&self
) -> DescribeAuditMitigationActionsTask
pub fn describe_audit_mitigation_actions_task(
&self
) -> DescribeAuditMitigationActionsTask
Constructs a fluent builder for the DescribeAuditMitigationActionsTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
: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>
sourcepub fn describe_audit_suppression(&self) -> DescribeAuditSuppression
pub fn describe_audit_suppression(&self) -> DescribeAuditSuppression
Constructs a fluent builder for the DescribeAuditSuppression
operation.
- The fluent builder is configurable:
check_name(impl Into<String>)
/set_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 useUpdateAccountAuditConfiguration
to select which checks are enabled.)resource_identifier(ResourceIdentifier)
/set_resource_identifier(Option<ResourceIdentifier>)
: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 useUpdateAccountAuditConfiguration
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>
sourcepub fn describe_audit_task(&self) -> DescribeAuditTask
pub fn describe_audit_task(&self) -> DescribeAuditTask
Constructs a fluent builder for the DescribeAuditTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
: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>
Constructs a fluent builder for the DescribeAuthorizer
operation.
- The fluent builder is configurable:
authorizer_name(impl Into<String>)
/set_authorizer_name(Option<String>)
: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>
sourcepub fn describe_billing_group(&self) -> DescribeBillingGroup
pub fn describe_billing_group(&self) -> DescribeBillingGroup
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>)
: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>
sourcepub fn describe_ca_certificate(&self) -> DescribeCACertificate
pub fn describe_ca_certificate(&self) -> DescribeCACertificate
Constructs a fluent builder for the DescribeCACertificate
operation.
- The fluent builder is configurable:
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
: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>
sourcepub fn describe_certificate(&self) -> DescribeCertificate
pub fn describe_certificate(&self) -> DescribeCertificate
Constructs a fluent builder for the DescribeCertificate
operation.
- The fluent builder is configurable:
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
: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>
sourcepub fn describe_custom_metric(&self) -> DescribeCustomMetric
pub fn describe_custom_metric(&self) -> DescribeCustomMetric
Constructs a fluent builder for the DescribeCustomMetric
operation.
- The fluent builder is configurable:
metric_name(impl Into<String>)
/set_metric_name(Option<String>)
: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>
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>
sourcepub fn describe_detect_mitigation_actions_task(
&self
) -> DescribeDetectMitigationActionsTask
pub fn describe_detect_mitigation_actions_task(
&self
) -> DescribeDetectMitigationActionsTask
Constructs a fluent builder for the DescribeDetectMitigationActionsTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
: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>
sourcepub fn describe_dimension(&self) -> DescribeDimension
pub fn describe_dimension(&self) -> DescribeDimension
Constructs a fluent builder for the DescribeDimension
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn describe_domain_configuration(&self) -> DescribeDomainConfiguration
pub fn describe_domain_configuration(&self) -> DescribeDomainConfiguration
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>)
: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.
- On failure, responds with
SdkError<DescribeDomainConfigurationError>
sourcepub fn describe_endpoint(&self) -> DescribeEndpoint
pub fn describe_endpoint(&self) -> DescribeEndpoint
Constructs a fluent builder for the DescribeEndpoint
operation.
- The fluent builder is configurable:
endpoint_type(impl Into<String>)
/set_endpoint_type(Option<String>)
: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.-
- 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>
sourcepub fn describe_event_configurations(&self) -> DescribeEventConfigurations
pub fn describe_event_configurations(&self) -> DescribeEventConfigurations
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>
sourcepub fn describe_fleet_metric(&self) -> DescribeFleetMetric
pub fn describe_fleet_metric(&self) -> DescribeFleetMetric
Constructs a fluent builder for the DescribeFleetMetric
operation.
- The fluent builder is configurable:
metric_name(impl Into<String>)
/set_metric_name(Option<String>)
: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>
sourcepub fn describe_index(&self) -> DescribeIndex
pub fn describe_index(&self) -> DescribeIndex
Constructs a fluent builder for the DescribeIndex
operation.
- The fluent builder is configurable:
index_name(impl Into<String>)
/set_index_name(Option<String>)
: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>
sourcepub fn describe_job(&self) -> DescribeJob
pub fn describe_job(&self) -> DescribeJob
Constructs a fluent builder for the DescribeJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The unique identifier you assigned to this job when it was created.
- 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>
sourcepub fn describe_job_execution(&self) -> DescribeJobExecution
pub fn describe_job_execution(&self) -> DescribeJobExecution
Constructs a fluent builder for the DescribeJobExecution
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The unique identifier you assigned to this job when it was created.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing on which the job execution is running.
execution_number(i64)
/set_execution_number(Option<i64>)
: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>
sourcepub fn describe_job_template(&self) -> DescribeJobTemplate
pub fn describe_job_template(&self) -> DescribeJobTemplate
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>)
: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 toTIMED_OUT
.job_executions_retry_config(Option<JobExecutionsRetryConfig>)
:The configuration that determines how many retries are allowed for each failure type for a job.
- On failure, responds with
SdkError<DescribeJobTemplateError>
sourcepub fn describe_managed_job_template(&self) -> DescribeManagedJobTemplate
pub fn describe_managed_job_template(&self) -> DescribeManagedJobTemplate
Constructs a fluent builder for the DescribeManagedJobTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The unique name of a managed job template, which is required.
template_version(impl Into<String>)
/set_template_version(Option<String>)
: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>
sourcepub fn describe_mitigation_action(&self) -> DescribeMitigationAction
pub fn describe_mitigation_action(&self) -> DescribeMitigationAction
Constructs a fluent builder for the DescribeMitigationAction
operation.
- The fluent builder is configurable:
action_name(impl Into<String>)
/set_action_name(Option<String>)
: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>
sourcepub fn describe_provisioning_template(&self) -> DescribeProvisioningTemplate
pub fn describe_provisioning_template(&self) -> DescribeProvisioningTemplate
Constructs a fluent builder for the DescribeProvisioningTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the fleet provisioning template.
- On success, responds with
DescribeProvisioningTemplateOutput
with field(s):template_arn(Option<String>)
:The ARN of the fleet provisioning template.
template_name(Option<String>)
:The name of the fleet provisioning template.
description(Option<String>)
:The description of the fleet provisioning template.
creation_date(Option<DateTime>)
:The date when the fleet provisioning template was created.
last_modified_date(Option<DateTime>)
:The date when the fleet 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 fleet provisioning template.
enabled(bool)
:True if the fleet 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.
- On failure, responds with
SdkError<DescribeProvisioningTemplateError>
sourcepub fn describe_provisioning_template_version(
&self
) -> DescribeProvisioningTemplateVersion
pub fn describe_provisioning_template_version(
&self
) -> DescribeProvisioningTemplateVersion
Constructs a fluent builder for the DescribeProvisioningTemplateVersion
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The template name.
version_id(i32)
/set_version_id(Option<i32>)
:The fleet provisioning template version ID.
- On success, responds with
DescribeProvisioningTemplateVersionOutput
with field(s):version_id(Option<i32>)
:The fleet provisioning template version ID.
creation_date(Option<DateTime>)
:The date when the fleet provisioning template version was created.
template_body(Option<String>)
:The JSON formatted contents of the fleet provisioning template version.
is_default_version(bool)
:True if the fleet provisioning template version is the default version.
- On failure, responds with
SdkError<DescribeProvisioningTemplateVersionError>
sourcepub fn describe_role_alias(&self) -> DescribeRoleAlias
pub fn describe_role_alias(&self) -> DescribeRoleAlias
Constructs a fluent builder for the DescribeRoleAlias
operation.
- The fluent builder is configurable:
role_alias(impl Into<String>)
/set_role_alias(Option<String>)
: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>
sourcepub fn describe_scheduled_audit(&self) -> DescribeScheduledAudit
pub fn describe_scheduled_audit(&self) -> DescribeScheduledAudit
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>)
: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
, orMONTHLY
. 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
through31
orLAST
. If days29
-31
are specified, and the month does not have that many days, the audit takes place on theLAST
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
, orSAT
.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 useUpdateAccountAuditConfiguration
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>
sourcepub fn describe_security_profile(&self) -> DescribeSecurityProfile
pub fn describe_security_profile(&self) -> DescribeSecurityProfile
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>)
: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.
- On failure, responds with
SdkError<DescribeSecurityProfileError>
sourcepub fn describe_stream(&self) -> DescribeStream
pub fn describe_stream(&self) -> DescribeStream
Constructs a fluent builder for the DescribeStream
operation.
- The fluent builder is configurable:
stream_id(impl Into<String>)
/set_stream_id(Option<String>)
: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>
sourcepub fn describe_thing(&self) -> DescribeThing
pub fn describe_thing(&self) -> DescribeThing
Constructs a fluent builder for the DescribeThing
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
: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 theUpdateThing
andDeleteThing
calls.billing_group_name(Option<String>)
:The name of the billing group the thing belongs to.
- On failure, responds with
SdkError<DescribeThingError>
sourcepub fn describe_thing_group(&self) -> DescribeThingGroup
pub fn describe_thing_group(&self) -> DescribeThingGroup
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>)
: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>
sourcepub fn describe_thing_registration_task(&self) -> DescribeThingRegistrationTask
pub fn describe_thing_registration_task(&self) -> DescribeThingRegistrationTask
Constructs a fluent builder for the DescribeThingRegistrationTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
: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>
sourcepub fn describe_thing_type(&self) -> DescribeThingType
pub fn describe_thing_type(&self) -> DescribeThingType
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>)
: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, and a list of searchable thing attribute names.
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>
sourcepub fn detach_policy(&self) -> DetachPolicy
pub fn detach_policy(&self) -> DetachPolicy
Constructs a fluent builder for the DetachPolicy
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The policy to detach.
target(impl Into<String>)
/set_target(Option<String>)
:The target from which the policy will be detached.
- On success, responds with
DetachPolicyOutput
- On failure, responds with
SdkError<DetachPolicyError>
sourcepub fn detach_principal_policy(&self) -> DetachPrincipalPolicy
pub fn detach_principal_policy(&self) -> DetachPrincipalPolicy
Constructs a fluent builder for the DetachPrincipalPolicy
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The name of the policy to detach.
principal(impl Into<String>)
/set_principal(Option<String>)
: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>
sourcepub fn detach_security_profile(&self) -> DetachSecurityProfile
pub fn detach_security_profile(&self) -> DetachSecurityProfile
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>)
:The security profile that is detached.
security_profile_target_arn(impl Into<String>)
/set_security_profile_target_arn(Option<String>)
:The ARN of the thing group from which the security profile is detached.
- On success, responds with
DetachSecurityProfileOutput
- On failure, responds with
SdkError<DetachSecurityProfileError>
sourcepub fn detach_thing_principal(&self) -> DetachThingPrincipal
pub fn detach_thing_principal(&self) -> DetachThingPrincipal
Constructs a fluent builder for the DetachThingPrincipal
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing.
principal(impl Into<String>)
/set_principal(Option<String>)
: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>
sourcepub fn disable_topic_rule(&self) -> DisableTopicRule
pub fn disable_topic_rule(&self) -> DisableTopicRule
Constructs a fluent builder for the DisableTopicRule
operation.
- The fluent builder is configurable:
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:The name of the rule to disable.
- On success, responds with
DisableTopicRuleOutput
- On failure, responds with
SdkError<DisableTopicRuleError>
sourcepub fn enable_topic_rule(&self) -> EnableTopicRule
pub fn enable_topic_rule(&self) -> EnableTopicRule
Constructs a fluent builder for the EnableTopicRule
operation.
- The fluent builder is configurable:
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:The name of the topic rule to enable.
- On success, responds with
EnableTopicRuleOutput
- On failure, responds with
SdkError<EnableTopicRuleError>
sourcepub fn get_behavior_model_training_summaries(
&self
) -> GetBehaviorModelTrainingSummaries
pub fn get_behavior_model_training_summaries(
&self
) -> GetBehaviorModelTrainingSummaries
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>)
:The name of the security profile.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return at one time. The default is 25.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn get_buckets_aggregation(&self) -> GetBucketsAggregation
pub fn get_buckets_aggregation(&self) -> GetBucketsAggregation
Constructs a fluent builder for the GetBucketsAggregation
operation.
- The fluent builder is configurable:
index_name(impl Into<String>)
/set_index_name(Option<String>)
:The name of the index to search.
query_string(impl Into<String>)
/set_query_string(Option<String>)
:The search query string.
aggregation_field(impl Into<String>)
/set_aggregation_field(Option<String>)
:The aggregation field.
query_version(impl Into<String>)
/set_query_version(Option<String>)
:The version of the query.
buckets_aggregation_type(BucketsAggregationType)
/set_buckets_aggregation_type(Option<BucketsAggregationType>)
: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 acount
.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>
sourcepub fn get_cardinality(&self) -> GetCardinality
pub fn get_cardinality(&self) -> GetCardinality
Constructs a fluent builder for the GetCardinality
operation.
- The fluent builder is configurable:
index_name(impl Into<String>)
/set_index_name(Option<String>)
:The name of the index to search.
query_string(impl Into<String>)
/set_query_string(Option<String>)
:The search query string.
aggregation_field(impl Into<String>)
/set_aggregation_field(Option<String>)
:The field to aggregate.
query_version(impl Into<String>)
/set_query_version(Option<String>)
: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>
sourcepub fn get_effective_policies(&self) -> GetEffectivePolicies
pub fn get_effective_policies(&self) -> GetEffectivePolicies
Constructs a fluent builder for the GetEffectivePolicies
operation.
- The fluent builder is configurable:
principal(impl Into<String>)
/set_principal(Option<String>)
: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>)
:The Cognito identity pool ID.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
: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>
sourcepub fn get_indexing_configuration(&self) -> GetIndexingConfiguration
pub fn get_indexing_configuration(&self) -> GetIndexingConfiguration
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>
sourcepub fn get_job_document(&self) -> GetJobDocument
pub fn get_job_document(&self) -> GetJobDocument
Constructs a fluent builder for the GetJobDocument
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The unique identifier you assigned to this job when it was created.
- On success, responds with
GetJobDocumentOutput
with field(s):document(Option<String>)
:The job document content.
- On failure, responds with
SdkError<GetJobDocumentError>
sourcepub fn get_logging_options(&self) -> GetLoggingOptions
pub fn get_logging_options(&self) -> GetLoggingOptions
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>
sourcepub fn get_ota_update(&self) -> GetOTAUpdate
pub fn get_ota_update(&self) -> GetOTAUpdate
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>)
: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>
sourcepub fn get_percentiles(&self) -> GetPercentiles
pub fn get_percentiles(&self) -> GetPercentiles
Constructs a fluent builder for the GetPercentiles
operation.
- The fluent builder is configurable:
index_name(impl Into<String>)
/set_index_name(Option<String>)
:The name of the index to search.
query_string(impl Into<String>)
/set_query_string(Option<String>)
:The search query string.
aggregation_field(impl Into<String>)
/set_aggregation_field(Option<String>)
:The field to aggregate.
query_version(impl Into<String>)
/set_query_version(Option<String>)
:The query version.
percents(Vec<f64>)
/set_percents(Option<Vec<f64>>)
: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>
sourcepub fn get_policy(&self) -> GetPolicy
pub fn get_policy(&self) -> GetPolicy
Constructs a fluent builder for the GetPolicy
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
: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>
sourcepub fn get_policy_version(&self) -> GetPolicyVersion
pub fn get_policy_version(&self) -> GetPolicyVersion
Constructs a fluent builder for the GetPolicyVersion
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The name of the policy.
policy_version_id(impl Into<String>)
/set_policy_version_id(Option<String>)
: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>
sourcepub fn get_registration_code(&self) -> GetRegistrationCode
pub fn get_registration_code(&self) -> GetRegistrationCode
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>
sourcepub fn get_statistics(&self) -> GetStatistics
pub fn get_statistics(&self) -> GetStatistics
Constructs a fluent builder for the GetStatistics
operation.
- The fluent builder is configurable:
index_name(impl Into<String>)
/set_index_name(Option<String>)
:The name of the index to search. The default value is
AWS_Things
.query_string(impl Into<String>)
/set_query_string(Option<String>)
: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>)
:The aggregation field name.
query_version(impl Into<String>)
/set_query_version(Option<String>)
: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>
sourcepub fn get_topic_rule(&self) -> GetTopicRule
pub fn get_topic_rule(&self) -> GetTopicRule
Constructs a fluent builder for the GetTopicRule
operation.
- The fluent builder is configurable:
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
: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>
sourcepub fn get_topic_rule_destination(&self) -> GetTopicRuleDestination
pub fn get_topic_rule_destination(&self) -> GetTopicRuleDestination
Constructs a fluent builder for the GetTopicRuleDestination
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
: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>
sourcepub fn get_v2_logging_options(&self) -> GetV2LoggingOptions
pub fn get_v2_logging_options(&self) -> GetV2LoggingOptions
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>
sourcepub fn list_active_violations(&self) -> ListActiveViolations
pub fn list_active_violations(&self) -> ListActiveViolations
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>)
:The name of the thing whose active violations are listed.
security_profile_name(impl Into<String>)
/set_security_profile_name(Option<String>)
:The name of the Device Defender security profile for which violations are listed.
behavior_criteria_type(BehaviorCriteriaType)
/set_behavior_criteria_type(Option<BehaviorCriteriaType>)
:The criteria for a behavior.
list_suppressed_alerts(bool)
/set_list_suppressed_alerts(Option<bool>)
:A list of all suppressed alerts.
verification_state(VerificationState)
/set_verification_state(Option<VerificationState>)
:The verification state of the violation (detect alarm).
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn list_attached_policies(&self) -> ListAttachedPolicies
pub fn list_attached_policies(&self) -> ListAttachedPolicies
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>)
: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(bool)
:When true, recursively list attached policies.
marker(impl Into<String>)
/set_marker(Option<String>)
:The token to retrieve the next set of results.
page_size(i32)
/set_page_size(Option<i32>)
: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>
sourcepub fn list_audit_findings(&self) -> ListAuditFindings
pub fn list_audit_findings(&self) -> ListAuditFindings
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>)
: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>)
:A filter to limit results to the findings for the specified audit check.
resource_identifier(ResourceIdentifier)
/set_resource_identifier(Option<ResourceIdentifier>)
:Information identifying the noncompliant resource.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return at one time. The default is 25.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results.
start_time(DateTime)
/set_start_time(Option<DateTime>)
: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>)
: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(bool)
: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>
sourcepub fn list_audit_mitigation_actions_executions(
&self
) -> ListAuditMitigationActionsExecutions
pub fn list_audit_mitigation_actions_executions(
&self
) -> ListAuditMitigationActionsExecutions
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>)
:Specify this filter to limit results to actions for a specific audit mitigation actions task.
action_status(AuditMitigationActionsExecutionStatus)
/set_action_status(Option<AuditMitigationActionsExecutionStatus>)
:Specify this filter to limit results to those with a specific status.
finding_id(impl Into<String>)
/set_finding_id(Option<String>)
:Specify this filter to limit results to those that were applied to a specific audit finding.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return at one time. The default is 25.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_audit_mitigation_actions_tasks(
&self
) -> ListAuditMitigationActionsTasks
pub fn list_audit_mitigation_actions_tasks(
&self
) -> ListAuditMitigationActionsTasks
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>)
: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>)
:Specify this filter to limit results to tasks that were applied to a specific audit finding.
task_status(AuditMitigationActionsTaskStatus)
/set_task_status(Option<AuditMitigationActionsTaskStatus>)
:Specify this filter to limit results to tasks that are in a specific state.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return at one time. The default is 25.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results.
start_time(DateTime)
/set_start_time(Option<DateTime>)
: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>)
: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>
sourcepub fn list_audit_suppressions(&self) -> ListAuditSuppressions
pub fn list_audit_suppressions(&self) -> ListAuditSuppressions
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>)
: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 useUpdateAccountAuditConfiguration
to select which checks are enabled.)resource_identifier(ResourceIdentifier)
/set_resource_identifier(Option<ResourceIdentifier>)
:Information that identifies the noncompliant resource.
ascending_order(bool)
/set_ascending_order(bool)
: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>)
:The token for the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn list_audit_tasks(&self) -> ListAuditTasks
pub fn list_audit_tasks(&self) -> ListAuditTasks
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>)
: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>)
:The end of the time period.
task_type(AuditTaskType)
/set_task_type(Option<AuditTaskType>)
: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>)
: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>)
:The token for the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
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>)
:The maximum number of results to return at one time.
marker(impl Into<String>)
/set_marker(Option<String>)
:A marker used to get the next set of results.
ascending_order(bool)
/set_ascending_order(bool)
:Return the list of authorizers in ascending alphabetical order.
status(AuthorizerStatus)
/set_status(Option<AuthorizerStatus>)
: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>
sourcepub fn list_billing_groups(&self) -> ListBillingGroups
pub fn list_billing_groups(&self) -> ListBillingGroups
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>)
: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>)
:The maximum number of results to return per request.
name_prefix_filter(impl Into<String>)
/set_name_prefix_filter(Option<String>)
: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>
sourcepub fn list_ca_certificates(&self) -> ListCACertificates
pub fn list_ca_certificates(&self) -> ListCACertificates
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>)
:The result page size.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results.
ascending_order(bool)
/set_ascending_order(bool)
:Determines the order of the results.
- 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>
sourcepub fn list_certificates(&self) -> ListCertificates
pub fn list_certificates(&self) -> ListCertificates
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>)
:The result page size.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results.
ascending_order(bool)
/set_ascending_order(bool)
: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>
sourcepub fn list_certificates_by_ca(&self) -> ListCertificatesByCA
pub fn list_certificates_by_ca(&self) -> ListCertificatesByCA
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>)
: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>)
:The result page size.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results.
ascending_order(bool)
/set_ascending_order(bool)
: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>
sourcepub fn list_custom_metrics(&self) -> ListCustomMetrics
pub fn list_custom_metrics(&self) -> ListCustomMetrics
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>)
:The token for the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn list_detect_mitigation_actions_executions(
&self
) -> ListDetectMitigationActionsExecutions
pub fn list_detect_mitigation_actions_executions(
&self
) -> ListDetectMitigationActionsExecutions
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>)
:The unique identifier of the task.
violation_id(impl Into<String>)
/set_violation_id(Option<String>)
:The unique identifier of the violation.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing whose mitigation actions are listed.
start_time(DateTime)
/set_start_time(Option<DateTime>)
: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>)
:The end of the time period for which ML Detect mitigation actions executions are returned.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return at one time. The default is 25.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_detect_mitigation_actions_tasks(
&self
) -> ListDetectMitigationActionsTasks
pub fn list_detect_mitigation_actions_tasks(
&self
) -> ListDetectMitigationActionsTasks
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>)
:The maximum number of results to return at one time. The default is 25.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results.
start_time(DateTime)
/set_start_time(Option<DateTime>)
: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>)
: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>
sourcepub fn list_dimensions(&self) -> ListDimensions
pub fn list_dimensions(&self) -> ListDimensions
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>)
:The token for the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn list_domain_configurations(&self) -> ListDomainConfigurations
pub fn list_domain_configurations(&self) -> ListDomainConfigurations
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>)
:The marker for the next set of results.
page_size(i32)
/set_page_size(Option<i32>)
:The result page size.
service_type(ServiceType)
/set_service_type(Option<ServiceType>)
: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>
sourcepub fn list_fleet_metrics(&self) -> ListFleetMetrics
pub fn list_fleet_metrics(&self) -> ListFleetMetrics
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>)
:To retrieve the next set of results, the
nextToken
value from a previous response; otherwisenull
to receive the first set of results.max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn list_indices(&self) -> ListIndices
pub fn list_indices(&self) -> ListIndices
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>)
: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>)
: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>
sourcepub fn list_job_executions_for_job(&self) -> ListJobExecutionsForJob
pub fn list_job_executions_for_job(&self) -> ListJobExecutionsForJob
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>)
:The unique identifier you assigned to this job when it was created.
status(JobExecutionStatus)
/set_status(Option<JobExecutionStatus>)
:The status of the job.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to be returned per request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_job_executions_for_thing(&self) -> ListJobExecutionsForThing
pub fn list_job_executions_for_thing(&self) -> ListJobExecutionsForThing
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>)
:The thing name.
status(JobExecutionStatus)
/set_status(Option<JobExecutionStatus>)
:An optional filter that lets you search for jobs that have the specified status.
namespace_id(impl Into<String>)
/set_namespace_id(Option<String>)
: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 in public preview.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to be returned per request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to retrieve the next set of results.
job_id(impl Into<String>)
/set_job_id(Option<String>)
: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>
sourcepub fn list_jobs(&self) -> ListJobs
pub fn list_jobs(&self) -> ListJobs
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>)
:An optional filter that lets you search for jobs that have the specified status.
target_selection(TargetSelection)
/set_target_selection(Option<TargetSelection>)
: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>)
:The maximum number of results to return per request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to retrieve the next set of results.
thing_group_name(impl Into<String>)
/set_thing_group_name(Option<String>)
: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>)
:A filter that limits the returned jobs to those for the specified group.
namespace_id(impl Into<String>)
/set_namespace_id(Option<String>)
: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 in public preview.
- 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>
sourcepub fn list_job_templates(&self) -> ListJobTemplates
pub fn list_job_templates(&self) -> ListJobTemplates
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>)
:The maximum number of results to return in the list.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_managed_job_templates(&self) -> ListManagedJobTemplates
pub fn list_managed_job_templates(&self) -> ListManagedJobTemplates
Constructs a fluent builder for the ListManagedJobTemplates
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
: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>)
:Maximum number of entries that can be returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_metric_values(&self) -> ListMetricValues
pub fn list_metric_values(&self) -> ListMetricValues
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>)
:The name of the thing for which security profile metric values are returned.
metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:The name of the security profile metric for which values are returned.
dimension_name(impl Into<String>)
/set_dimension_name(Option<String>)
:The dimension name.
dimension_value_operator(DimensionValueOperator)
/set_dimension_value_operator(Option<DimensionValueOperator>)
:The dimension value operator.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The start of the time period for which metric values are returned.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The end of the time period for which metric values are returned.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return at one time.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_mitigation_actions(&self) -> ListMitigationActions
pub fn list_mitigation_actions(&self) -> ListMitigationActions
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>)
:Specify a value to limit the result to mitigation actions with a specific action type.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return at one time. The default is 25.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_ota_updates(&self) -> ListOTAUpdates
pub fn list_ota_updates(&self) -> ListOTAUpdates
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>)
:The maximum number of results to return at one time.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token used to retrieve the next set of results.
ota_update_status(OtaUpdateStatus)
/set_ota_update_status(Option<OtaUpdateStatus>)
: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>
sourcepub fn list_outgoing_certificates(&self) -> ListOutgoingCertificates
pub fn list_outgoing_certificates(&self) -> ListOutgoingCertificates
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>)
:The result page size.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results.
ascending_order(bool)
/set_ascending_order(bool)
: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>
sourcepub fn list_policies(&self) -> ListPolicies
pub fn list_policies(&self) -> ListPolicies
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>)
:The marker for the next set of results.
page_size(i32)
/set_page_size(Option<i32>)
:The result page size.
ascending_order(bool)
/set_ascending_order(bool)
: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>
sourcepub fn list_policy_principals(&self) -> ListPolicyPrincipals
pub fn list_policy_principals(&self) -> ListPolicyPrincipals
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>)
:The policy name.
marker(impl Into<String>)
/set_marker(Option<String>)
:The marker for the next set of results.
page_size(i32)
/set_page_size(Option<i32>)
:The result page size.
ascending_order(bool)
/set_ascending_order(bool)
: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>
sourcepub fn list_policy_versions(&self) -> ListPolicyVersions
pub fn list_policy_versions(&self) -> ListPolicyVersions
Constructs a fluent builder for the ListPolicyVersions
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
: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>
sourcepub fn list_principal_policies(&self) -> ListPrincipalPolicies
pub fn list_principal_policies(&self) -> ListPrincipalPolicies
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>)
: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>)
:The marker for the next set of results.
page_size(i32)
/set_page_size(Option<i32>)
:The result page size.
ascending_order(bool)
/set_ascending_order(bool)
: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>
sourcepub fn list_principal_things(&self) -> ListPrincipalThings
pub fn list_principal_things(&self) -> ListPrincipalThings
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>)
: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>)
:The maximum number of results to return in this operation.
principal(impl Into<String>)
/set_principal(Option<String>)
: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>
sourcepub fn list_provisioning_templates(&self) -> ListProvisioningTemplates
pub fn list_provisioning_templates(&self) -> ListProvisioningTemplates
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>)
:The maximum number of results to return at one time.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token to retrieve the next set of results.
- On success, responds with
ListProvisioningTemplatesOutput
with field(s):templates(Option<Vec<ProvisioningTemplateSummary>>)
:A list of fleet provisioning templates
next_token(Option<String>)
:A token to retrieve the next set of results.
- On failure, responds with
SdkError<ListProvisioningTemplatesError>
sourcepub fn list_provisioning_template_versions(
&self
) -> ListProvisioningTemplateVersions
pub fn list_provisioning_template_versions(
&self
) -> ListProvisioningTemplateVersions
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>)
:The name of the fleet provisioning template.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return at one time.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token to retrieve the next set of results.
- On success, responds with
ListProvisioningTemplateVersionsOutput
with field(s):versions(Option<Vec<ProvisioningTemplateVersionSummary>>)
:The list of fleet provisioning template versions.
next_token(Option<String>)
:A token to retrieve the next set of results.
- On failure, responds with
SdkError<ListProvisioningTemplateVersionsError>
sourcepub fn list_role_aliases(&self) -> ListRoleAliases
pub fn list_role_aliases(&self) -> ListRoleAliases
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>)
:The maximum number of results to return at one time.
marker(impl Into<String>)
/set_marker(Option<String>)
:A marker used to get the next set of results.
ascending_order(bool)
/set_ascending_order(bool)
: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>
sourcepub fn list_scheduled_audits(&self) -> ListScheduledAudits
pub fn list_scheduled_audits(&self) -> ListScheduledAudits
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>)
:The token for the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn list_security_profiles(&self) -> ListSecurityProfiles
pub fn list_security_profiles(&self) -> ListSecurityProfiles
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>)
:The token for the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return at one time.
dimension_name(impl Into<String>)
/set_dimension_name(Option<String>)
: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>)
: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>
sourcepub fn list_security_profiles_for_target(&self) -> ListSecurityProfilesForTarget
pub fn list_security_profiles_for_target(&self) -> ListSecurityProfilesForTarget
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>)
:The token for the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return at one time.
recursive(bool)
/set_recursive(bool)
:If true, return child groups too.
security_profile_target_arn(impl Into<String>)
/set_security_profile_target_arn(Option<String>)
: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>
sourcepub fn list_streams(&self) -> ListStreams
pub fn list_streams(&self) -> ListStreams
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>)
:The maximum number of results to return at a time.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token used to get the next set of results.
ascending_order(bool)
/set_ascending_order(bool)
: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>
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>)
:The ARN of the resource.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_targets_for_policy(&self) -> ListTargetsForPolicy
pub fn list_targets_for_policy(&self) -> ListTargetsForPolicy
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>)
:The policy name.
marker(impl Into<String>)
/set_marker(Option<String>)
:A marker used to get the next set of results.
page_size(i32)
/set_page_size(Option<i32>)
: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>
sourcepub fn list_targets_for_security_profile(&self) -> ListTargetsForSecurityProfile
pub fn list_targets_for_security_profile(&self) -> ListTargetsForSecurityProfile
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>)
:The security profile.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn list_thing_groups(&self) -> ListThingGroups
pub fn list_thing_groups(&self) -> ListThingGroups
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>)
: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>)
:The maximum number of results to return at one time.
parent_group(impl Into<String>)
/set_parent_group(Option<String>)
: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>)
:A filter that limits the results to those with the specified name prefix.
recursive(bool)
/set_recursive(Option<bool>)
: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>
sourcepub fn list_thing_groups_for_thing(&self) -> ListThingGroupsForThing
pub fn list_thing_groups_for_thing(&self) -> ListThingGroupsForThing
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>)
:The thing name.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
: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>
sourcepub fn list_thing_principals(&self) -> ListThingPrincipals
pub fn list_thing_principals(&self) -> ListThingPrincipals
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>)
: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>)
:The maximum number of results to return in this operation.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
: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>
sourcepub fn list_thing_registration_task_reports(
&self
) -> ListThingRegistrationTaskReports
pub fn list_thing_registration_task_reports(
&self
) -> ListThingRegistrationTaskReports
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>)
:The id of the task.
report_type(ReportType)
/set_report_type(Option<ReportType>)
:The type of task report.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
: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>
sourcepub fn list_thing_registration_tasks(&self) -> ListThingRegistrationTasks
pub fn list_thing_registration_tasks(&self) -> ListThingRegistrationTasks
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>)
: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>)
:The maximum number of results to return at one time.
status(Status)
/set_status(Option<Status>)
: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>
sourcepub fn list_things(&self) -> ListThings
pub fn list_things(&self) -> ListThings
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>)
: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>)
:The maximum number of results to return in this operation.
attribute_name(impl Into<String>)
/set_attribute_name(Option<String>)
:The attribute name used to search for things.
attribute_value(impl Into<String>)
/set_attribute_value(Option<String>)
:The attribute value used to search for things.
thing_type_name(impl Into<String>)
/set_thing_type_name(Option<String>)
:The name of the thing type used to search for things.
use_prefix_attribute_value(bool)
/set_use_prefix_attribute_value(bool)
:When
true
, the action returns the thing resources with attribute values that start with theattributeValue
provided.When
false
, or not present, the action returns only the thing resources with attribute values that match the entireattributeValue
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>
sourcepub fn list_things_in_billing_group(&self) -> ListThingsInBillingGroup
pub fn list_things_in_billing_group(&self) -> ListThingsInBillingGroup
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>)
:The name of the billing group.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
: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>
sourcepub fn list_things_in_thing_group(&self) -> ListThingsInThingGroup
pub fn list_things_in_thing_group(&self) -> ListThingsInThingGroup
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>)
:The thing group name.
recursive(bool)
/set_recursive(bool)
: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>)
: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>)
: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>
sourcepub fn list_thing_types(&self) -> ListThingTypes
pub fn list_thing_types(&self) -> ListThingTypes
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>)
: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>)
:The maximum number of results to return in this operation.
thing_type_name(impl Into<String>)
/set_thing_type_name(Option<String>)
: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>
sourcepub fn list_topic_rule_destinations(&self) -> ListTopicRuleDestinations
pub fn list_topic_rule_destinations(&self) -> ListTopicRuleDestinations
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>)
:The maximum number of results to return at one time.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>
sourcepub fn list_topic_rules(&self) -> ListTopicRules
pub fn list_topic_rules(&self) -> ListTopicRules
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>)
:The topic.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
: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>
sourcepub fn list_v2_logging_levels(&self) -> ListV2LoggingLevels
pub fn list_v2_logging_levels(&self) -> ListV2LoggingLevels
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>)
:The type of resource for which you are configuring logging. Must be
THING_Group
.next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
: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>
sourcepub fn list_violation_events(&self) -> ListViolationEvents
pub fn list_violation_events(&self) -> ListViolationEvents
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>)
:The start time for the alerts to be listed.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The end time for the alerts to be listed.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
: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>)
:A filter to limit results to those alerts generated by the specified security profile.
behavior_criteria_type(BehaviorCriteriaType)
/set_behavior_criteria_type(Option<BehaviorCriteriaType>)
:The criteria for a behavior.
list_suppressed_alerts(bool)
/set_list_suppressed_alerts(Option<bool>)
:A list of all suppressed alerts.
verification_state(VerificationState)
/set_verification_state(Option<VerificationState>)
:The verification state of the violation (detect alarm).
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results.
max_results(i32)
/set_max_results(Option<i32>)
: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>
sourcepub fn put_verification_state_on_violation(
&self
) -> PutVerificationStateOnViolation
pub fn put_verification_state_on_violation(
&self
) -> PutVerificationStateOnViolation
Constructs a fluent builder for the PutVerificationStateOnViolation
operation.
- The fluent builder is configurable:
violation_id(impl Into<String>)
/set_violation_id(Option<String>)
:The violation ID.
verification_state(VerificationState)
/set_verification_state(Option<VerificationState>)
:The verification state of the violation.
verification_state_description(impl Into<String>)
/set_verification_state_description(Option<String>)
:The description of the verification state of the violation (detect alarm).
- On success, responds with
PutVerificationStateOnViolationOutput
- On failure, responds with
SdkError<PutVerificationStateOnViolationError>
sourcepub fn register_ca_certificate(&self) -> RegisterCACertificate
pub fn register_ca_certificate(&self) -> RegisterCACertificate
Constructs a fluent builder for the RegisterCACertificate
operation.
- The fluent builder is configurable:
ca_certificate(impl Into<String>)
/set_ca_certificate(Option<String>)
:The CA certificate.
verification_certificate(impl Into<String>)
/set_verification_certificate(Option<String>)
:The private key verification certificate.
set_as_active(bool)
/set_set_as_active(bool)
: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(bool)
:Allows this CA certificate to be used for auto registration of device certificates.
registration_config(RegistrationConfig)
/set_registration_config(Option<RegistrationConfig>)
:Information about the registration configuration.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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…”
- 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>
sourcepub fn register_certificate(&self) -> RegisterCertificate
pub fn register_certificate(&self) -> RegisterCertificate
Constructs a fluent builder for the RegisterCertificate
operation.
- The fluent builder is configurable:
certificate_pem(impl Into<String>)
/set_certificate_pem(Option<String>)
:The certificate data, in PEM format.
ca_certificate_pem(impl Into<String>)
/set_ca_certificate_pem(Option<String>)
:The CA certificate used to sign the device certificate being registered.
set_as_active(bool)
/set_set_as_active(Option<bool>)
:A boolean value that specifies if the certificate is set to active.
Valid values:
ACTIVE | INACTIVE
status(CertificateStatus)
/set_status(Option<CertificateStatus>)
:The status of the register certificate request. Valid values that you can use include
ACTIVE
,INACTIVE
, andREVOKED
.
- 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>
sourcepub fn register_certificate_without_ca(&self) -> RegisterCertificateWithoutCA
pub fn register_certificate_without_ca(&self) -> RegisterCertificateWithoutCA
Constructs a fluent builder for the RegisterCertificateWithoutCA
operation.
- The fluent builder is configurable:
certificate_pem(impl Into<String>)
/set_certificate_pem(Option<String>)
:The certificate data, in PEM format.
status(CertificateStatus)
/set_status(Option<CertificateStatus>)
: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>
sourcepub fn register_thing(&self) -> RegisterThing
pub fn register_thing(&self) -> RegisterThing
Constructs a fluent builder for the RegisterThing
operation.
- The fluent builder is configurable:
template_body(impl Into<String>)
/set_template_body(Option<String>)
:The provisioning template. See Provisioning Devices That Have Device Certificates for more information.
parameters(HashMap<String, String>)
/set_parameters(Option<HashMap<String, String>>)
: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>
sourcepub fn reject_certificate_transfer(&self) -> RejectCertificateTransfer
pub fn reject_certificate_transfer(&self) -> RejectCertificateTransfer
Constructs a fluent builder for the RejectCertificateTransfer
operation.
- The fluent builder is configurable:
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
: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>)
:The reason the certificate transfer was rejected.
- On success, responds with
RejectCertificateTransferOutput
- On failure, responds with
SdkError<RejectCertificateTransferError>
sourcepub fn remove_thing_from_billing_group(&self) -> RemoveThingFromBillingGroup
pub fn remove_thing_from_billing_group(&self) -> RemoveThingFromBillingGroup
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>)
:The name of the billing group.
billing_group_arn(impl Into<String>)
/set_billing_group_arn(Option<String>)
:The ARN of the billing group.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing to be removed from the billing group.
thing_arn(impl Into<String>)
/set_thing_arn(Option<String>)
:The ARN of the thing to be removed from the billing group.
- On success, responds with
RemoveThingFromBillingGroupOutput
- On failure, responds with
SdkError<RemoveThingFromBillingGroupError>
sourcepub fn remove_thing_from_thing_group(&self) -> RemoveThingFromThingGroup
pub fn remove_thing_from_thing_group(&self) -> RemoveThingFromThingGroup
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>)
:The group name.
thing_group_arn(impl Into<String>)
/set_thing_group_arn(Option<String>)
:The group ARN.
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the thing to remove from the group.
thing_arn(impl Into<String>)
/set_thing_arn(Option<String>)
:The ARN of the thing to remove from the group.
- On success, responds with
RemoveThingFromThingGroupOutput
- On failure, responds with
SdkError<RemoveThingFromThingGroupError>
sourcepub fn replace_topic_rule(&self) -> ReplaceTopicRule
pub fn replace_topic_rule(&self) -> ReplaceTopicRule
Constructs a fluent builder for the ReplaceTopicRule
operation.
- The fluent builder is configurable:
rule_name(impl Into<String>)
/set_rule_name(Option<String>)
:The name of the rule.
topic_rule_payload(TopicRulePayload)
/set_topic_rule_payload(Option<TopicRulePayload>)
:The rule payload.
- On success, responds with
ReplaceTopicRuleOutput
- On failure, responds with
SdkError<ReplaceTopicRuleError>
sourcepub fn search_index(&self) -> SearchIndex
pub fn search_index(&self) -> SearchIndex
Constructs a fluent builder for the SearchIndex
operation.
- The fluent builder is configurable:
index_name(impl Into<String>)
/set_index_name(Option<String>)
:The search index name.
query_string(impl Into<String>)
/set_query_string(Option<String>)
:The search query string.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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>)
:The maximum number of results to return at one time.
query_version(impl Into<String>)
/set_query_version(Option<String>)
: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>
Constructs a fluent builder for the SetDefaultAuthorizer
operation.
- The fluent builder is configurable:
authorizer_name(impl Into<String>)
/set_authorizer_name(Option<String>)
: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>
sourcepub fn set_default_policy_version(&self) -> SetDefaultPolicyVersion
pub fn set_default_policy_version(&self) -> SetDefaultPolicyVersion
Constructs a fluent builder for the SetDefaultPolicyVersion
operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)
/set_policy_name(Option<String>)
:The policy name.
policy_version_id(impl Into<String>)
/set_policy_version_id(Option<String>)
:The policy version ID.
- On success, responds with
SetDefaultPolicyVersionOutput
- On failure, responds with
SdkError<SetDefaultPolicyVersionError>
sourcepub fn set_logging_options(&self) -> SetLoggingOptions
pub fn set_logging_options(&self) -> SetLoggingOptions
Constructs a fluent builder for the SetLoggingOptions
operation.
- The fluent builder is configurable:
logging_options_payload(LoggingOptionsPayload)
/set_logging_options_payload(Option<LoggingOptionsPayload>)
:The logging options payload.
- On success, responds with
SetLoggingOptionsOutput
- On failure, responds with
SdkError<SetLoggingOptionsError>
sourcepub fn set_v2_logging_level(&self) -> SetV2LoggingLevel
pub fn set_v2_logging_level(&self) -> SetV2LoggingLevel
Constructs a fluent builder for the SetV2LoggingLevel
operation.
- The fluent builder is configurable:
log_target(LogTarget)
/set_log_target(Option<LogTarget>)
:The log target.
log_level(LogLevel)
/set_log_level(Option<LogLevel>)
:The log level.
- On success, responds with
SetV2LoggingLevelOutput
- On failure, responds with
SdkError<SetV2LoggingLevelError>
sourcepub fn set_v2_logging_options(&self) -> SetV2LoggingOptions
pub fn set_v2_logging_options(&self) -> SetV2LoggingOptions
Constructs a fluent builder for the SetV2LoggingOptions
operation.
- The fluent builder is configurable:
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The ARN of the role that allows IoT to write to Cloudwatch logs.
default_log_level(LogLevel)
/set_default_log_level(Option<LogLevel>)
:The default logging level.
disable_all_logs(bool)
/set_disable_all_logs(bool)
:If true all logs are disabled. The default is false.
- On success, responds with
SetV2LoggingOptionsOutput
- On failure, responds with
SdkError<SetV2LoggingOptionsError>
sourcepub fn start_audit_mitigation_actions_task(
&self
) -> StartAuditMitigationActionsTask
pub fn start_audit_mitigation_actions_task(
&self
) -> StartAuditMitigationActionsTask
Constructs a fluent builder for the StartAuditMitigationActionsTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
: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>)
: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(HashMap<String, Vec<String>>)
/set_audit_check_to_actions_mapping(Option<HashMap<String, Vec<String>>>)
: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>)
: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>
sourcepub fn start_detect_mitigation_actions_task(
&self
) -> StartDetectMitigationActionsTask
pub fn start_detect_mitigation_actions_task(
&self
) -> StartDetectMitigationActionsTask
Constructs a fluent builder for the StartDetectMitigationActionsTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
:The unique identifier of the task.
target(DetectMitigationActionsTaskTarget)
/set_target(Option<DetectMitigationActionsTaskTarget>)
:Specifies the ML Detect findings to which the mitigation actions are applied.
actions(Vec<String>)
/set_actions(Option<Vec<String>>)
:The actions to be performed when a device has unexpected behavior.
violation_event_occurrence_range(ViolationEventOccurrenceRange)
/set_violation_event_occurrence_range(Option<ViolationEventOccurrenceRange>)
:Specifies the time period of which violation events occurred between.
include_only_active_violations(bool)
/set_include_only_active_violations(Option<bool>)
:Specifies to list only active violations.
include_suppressed_alerts(bool)
/set_include_suppressed_alerts(Option<bool>)
:Specifies to include suppressed alerts.
client_request_token(impl Into<String>)
/set_client_request_token(Option<String>)
: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>
sourcepub fn start_on_demand_audit_task(&self) -> StartOnDemandAuditTask
pub fn start_on_demand_audit_task(&self) -> StartOnDemandAuditTask
Constructs a fluent builder for the StartOnDemandAuditTask
operation.
- The fluent builder is configurable:
target_check_names(Vec<String>)
/set_target_check_names(Option<Vec<String>>)
: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 orUpdateAccountAuditConfiguration
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>
sourcepub fn start_thing_registration_task(&self) -> StartThingRegistrationTask
pub fn start_thing_registration_task(&self) -> StartThingRegistrationTask
Constructs a fluent builder for the StartThingRegistrationTask
operation.
- The fluent builder is configurable:
template_body(impl Into<String>)
/set_template_body(Option<String>)
:The provisioning template.
input_file_bucket(impl Into<String>)
/set_input_file_bucket(Option<String>)
:The S3 bucket that contains the input file.
input_file_key(impl Into<String>)
/set_input_file_key(Option<String>)
: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>)
: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>
sourcepub fn stop_thing_registration_task(&self) -> StopThingRegistrationTask
pub fn stop_thing_registration_task(&self) -> StopThingRegistrationTask
Constructs a fluent builder for the StopThingRegistrationTask
operation.
- The fluent builder is configurable:
task_id(impl Into<String>)
/set_task_id(Option<String>)
:The bulk thing provisioning task ID.
- On success, responds with
StopThingRegistrationTaskOutput
- On failure, responds with
SdkError<StopThingRegistrationTaskError>
sourcepub fn tag_resource(&self) -> TagResource
pub fn tag_resource(&self) -> TagResource
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The new or modified tags for the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Constructs a fluent builder for the TestAuthorization
operation.
- The fluent builder is configurable:
principal(impl Into<String>)
/set_principal(Option<String>)
: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>)
:The Cognito identity pool ID.
auth_infos(Vec<AuthInfo>)
/set_auth_infos(Option<Vec<AuthInfo>>)
: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>)
:The MQTT client ID.
policy_names_to_add(Vec<String>)
/set_policy_names_to_add(Option<Vec<String>>)
:When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
policy_names_to_skip(Vec<String>)
/set_policy_names_to_skip(Option<Vec<String>>)
: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>
Constructs a fluent builder for the TestInvokeAuthorizer
operation.
- The fluent builder is configurable:
authorizer_name(impl Into<String>)
/set_authorizer_name(Option<String>)
:The custom authorizer name.
token(impl Into<String>)
/set_token(Option<String>)
:The token returned by your custom authentication service.
token_signature(impl Into<String>)
/set_token_signature(Option<String>)
: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>)
:Specifies a test HTTP authorization request.
mqtt_context(MqttContext)
/set_mqtt_context(Option<MqttContext>)
:Specifies a test MQTT authorization request.
tls_context(TlsContext)
/set_tls_context(Option<TlsContext>)
: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>
sourcepub fn transfer_certificate(&self) -> TransferCertificate
pub fn transfer_certificate(&self) -> TransferCertificate
Constructs a fluent builder for the TransferCertificate
operation.
- The fluent builder is configurable:
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
: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>)
:The Amazon Web Services account.
transfer_message(impl Into<String>)
/set_transfer_message(Option<String>)
: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>
sourcepub fn untag_resource(&self) -> UntagResource
pub fn untag_resource(&self) -> UntagResource
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
: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>
sourcepub fn update_account_audit_configuration(
&self
) -> UpdateAccountAuditConfiguration
pub fn update_account_audit_configuration(
&self
) -> UpdateAccountAuditConfiguration
Constructs a fluent builder for the UpdateAccountAuditConfiguration
operation.
- The fluent builder is configurable:
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
: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(HashMap<AuditNotificationType, AuditNotificationTarget>)
/set_audit_notification_target_configurations(Option<HashMap<AuditNotificationType, AuditNotificationTarget>>)
:Information about the targets to which audit notifications are sent.
audit_check_configurations(HashMap<String, AuditCheckConfiguration>)
/set_audit_check_configurations(Option<HashMap<String, AuditCheckConfiguration>>)
: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>
sourcepub fn update_audit_suppression(&self) -> UpdateAuditSuppression
pub fn update_audit_suppression(&self) -> UpdateAuditSuppression
Constructs a fluent builder for the UpdateAuditSuppression
operation.
- The fluent builder is configurable:
check_name(impl Into<String>)
/set_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 useUpdateAccountAuditConfiguration
to select which checks are enabled.)resource_identifier(ResourceIdentifier)
/set_resource_identifier(Option<ResourceIdentifier>)
:Information that identifies the noncompliant resource.
expiration_date(DateTime)
/set_expiration_date(Option<DateTime>)
:The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.
suppress_indefinitely(bool)
/set_suppress_indefinitely(Option<bool>)
:Indicates whether a suppression should exist indefinitely or not.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the audit suppression.
- On success, responds with
UpdateAuditSuppressionOutput
- On failure, responds with
SdkError<UpdateAuditSuppressionError>
Constructs a fluent builder for the UpdateAuthorizer
operation.
- The fluent builder is configurable:
authorizer_name(impl Into<String>)
/set_authorizer_name(Option<String>)
:The authorizer name.
authorizer_function_arn(impl Into<String>)
/set_authorizer_function_arn(Option<String>)
:The ARN of the authorizer’s Lambda function.
token_key_name(impl Into<String>)
/set_token_key_name(Option<String>)
:The key used to extract the token from the HTTP headers.
token_signing_public_keys(HashMap<String, String>)
/set_token_signing_public_keys(Option<HashMap<String, String>>)
:The public keys used to verify the token signature.
status(AuthorizerStatus)
/set_status(Option<AuthorizerStatus>)
:The status of the update authorizer request.
enable_caching_for_http(bool)
/set_enable_caching_for_http(Option<bool>)
:When
true
, the result from the authorizer’s Lambda function is cached for the time specified inrefreshAfterInSeconds
. 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>
sourcepub fn update_billing_group(&self) -> UpdateBillingGroup
pub fn update_billing_group(&self) -> UpdateBillingGroup
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>)
:The name of the billing group.
billing_group_properties(BillingGroupProperties)
/set_billing_group_properties(Option<BillingGroupProperties>)
:The properties of the billing group.
expected_version(i64)
/set_expected_version(Option<i64>)
: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 aVersionConflictException
.
- On success, responds with
UpdateBillingGroupOutput
with field(s):version(i64)
:The latest version of the billing group.
- On failure, responds with
SdkError<UpdateBillingGroupError>
sourcepub fn update_ca_certificate(&self) -> UpdateCACertificate
pub fn update_ca_certificate(&self) -> UpdateCACertificate
Constructs a fluent builder for the UpdateCACertificate
operation.
- The fluent builder is configurable:
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
:The CA certificate identifier.
new_status(CaCertificateStatus)
/set_new_status(Option<CaCertificateStatus>)
: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>)
:The new value for the auto registration status. Valid values are: “ENABLE” or “DISABLE”.
registration_config(RegistrationConfig)
/set_registration_config(Option<RegistrationConfig>)
:Information about the registration configuration.
remove_auto_registration(bool)
/set_remove_auto_registration(bool)
:If true, removes auto registration.
- On success, responds with
UpdateCaCertificateOutput
- On failure, responds with
SdkError<UpdateCACertificateError>
sourcepub fn update_certificate(&self) -> UpdateCertificate
pub fn update_certificate(&self) -> UpdateCertificate
Constructs a fluent builder for the UpdateCertificate
operation.
- The fluent builder is configurable:
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
:The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
new_status(CertificateStatus)
/set_new_status(Option<CertificateStatus>)
: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>
sourcepub fn update_custom_metric(&self) -> UpdateCustomMetric
pub fn update_custom_metric(&self) -> UpdateCustomMetric
Constructs a fluent builder for the UpdateCustomMetric
operation.
- The fluent builder is configurable:
metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:The name of the custom metric. Cannot be updated.
display_name(impl Into<String>)
/set_display_name(Option<String>)
: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>
sourcepub fn update_dimension(&self) -> UpdateDimension
pub fn update_dimension(&self) -> UpdateDimension
Constructs a fluent builder for the UpdateDimension
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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(Vec<String>)
/set_string_values(Option<Vec<String>>)
: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>
sourcepub fn update_domain_configuration(&self) -> UpdateDomainConfiguration
pub fn update_domain_configuration(&self) -> UpdateDomainConfiguration
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>)
:The name of the domain configuration to be updated.
authorizer_config(AuthorizerConfig)
/set_authorizer_config(Option<AuthorizerConfig>)
:An object that specifies the authorization service for a domain.
domain_configuration_status(DomainConfigurationStatus)
/set_domain_configuration_status(Option<DomainConfigurationStatus>)
:The status to which the domain configuration should be updated.
remove_authorizer_config(bool)
/set_remove_authorizer_config(bool)
:Removes the authorization configuration from 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>
sourcepub fn update_dynamic_thing_group(&self) -> UpdateDynamicThingGroup
pub fn update_dynamic_thing_group(&self) -> UpdateDynamicThingGroup
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>)
:The name of the dynamic thing group to update.
thing_group_properties(ThingGroupProperties)
/set_thing_group_properties(Option<ThingGroupProperties>)
:The dynamic thing group properties to update.
expected_version(i64)
/set_expected_version(Option<i64>)
:The expected version of the dynamic thing group to update.
index_name(impl Into<String>)
/set_index_name(Option<String>)
:The dynamic thing group index to update.
Currently one index is supported:
AWS_Things
.query_string(impl Into<String>)
/set_query_string(Option<String>)
:The dynamic thing group search query string to update.
query_version(impl Into<String>)
/set_query_version(Option<String>)
: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>
sourcepub fn update_event_configurations(&self) -> UpdateEventConfigurations
pub fn update_event_configurations(&self) -> UpdateEventConfigurations
Constructs a fluent builder for the UpdateEventConfigurations
operation.
- The fluent builder is configurable:
event_configurations(HashMap<EventType, Configuration>)
/set_event_configurations(Option<HashMap<EventType, Configuration>>)
:The new event configuration values.
- On success, responds with
UpdateEventConfigurationsOutput
- On failure, responds with
SdkError<UpdateEventConfigurationsError>
sourcepub fn update_fleet_metric(&self) -> UpdateFleetMetric
pub fn update_fleet_metric(&self) -> UpdateFleetMetric
Constructs a fluent builder for the UpdateFleetMetric
operation.
- The fluent builder is configurable:
metric_name(impl Into<String>)
/set_metric_name(Option<String>)
:The name of the fleet metric to update.
query_string(impl Into<String>)
/set_query_string(Option<String>)
:The search query string.
aggregation_type(AggregationType)
/set_aggregation_type(Option<AggregationType>)
:The type of the aggregation query.
period(i32)
/set_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(impl Into<String>)
/set_aggregation_field(Option<String>)
:The field to aggregate.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the fleet metric.
query_version(impl Into<String>)
/set_query_version(Option<String>)
:The version of the query.
index_name(impl Into<String>)
/set_index_name(Option<String>)
:The name of the index to search.
unit(FleetMetricUnit)
/set_unit(Option<FleetMetricUnit>)
: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>)
:The expected version of the fleet metric record in the registry.
- On success, responds with
UpdateFleetMetricOutput
- On failure, responds with
SdkError<UpdateFleetMetricError>
sourcepub fn update_indexing_configuration(&self) -> UpdateIndexingConfiguration
pub fn update_indexing_configuration(&self) -> UpdateIndexingConfiguration
Constructs a fluent builder for the UpdateIndexingConfiguration
operation.
- The fluent builder is configurable:
thing_indexing_configuration(ThingIndexingConfiguration)
/set_thing_indexing_configuration(Option<ThingIndexingConfiguration>)
:Thing indexing configuration.
thing_group_indexing_configuration(ThingGroupIndexingConfiguration)
/set_thing_group_indexing_configuration(Option<ThingGroupIndexingConfiguration>)
:Thing group indexing configuration.
- On success, responds with
UpdateIndexingConfigurationOutput
- On failure, responds with
SdkError<UpdateIndexingConfigurationError>
sourcepub fn update_job(&self) -> UpdateJob
pub fn update_job(&self) -> UpdateJob
Constructs a fluent builder for the UpdateJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The ID of the job to be updated.
description(impl Into<String>)
/set_description(Option<String>)
:A short text description of the job.
presigned_url_config(PresignedUrlConfig)
/set_presigned_url_config(Option<PresignedUrlConfig>)
:Configuration information for pre-signed S3 URLs.
job_executions_rollout_config(JobExecutionsRolloutConfig)
/set_job_executions_rollout_config(Option<JobExecutionsRolloutConfig>)
:Allows you to create a staged rollout of the job.
abort_config(AbortConfig)
/set_abort_config(Option<AbortConfig>)
:Allows you to create criteria to abort a job.
timeout_config(TimeoutConfig)
/set_timeout_config(Option<TimeoutConfig>)
: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 toTIMED_OUT
.namespace_id(impl Into<String>)
/set_namespace_id(Option<String>)
: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 in public preview.job_executions_retry_config(JobExecutionsRetryConfig)
/set_job_executions_retry_config(Option<JobExecutionsRetryConfig>)
:Allows you to create the criteria to retry a job.
- On success, responds with
UpdateJobOutput
- On failure, responds with
SdkError<UpdateJobError>
sourcepub fn update_mitigation_action(&self) -> UpdateMitigationAction
pub fn update_mitigation_action(&self) -> UpdateMitigationAction
Constructs a fluent builder for the UpdateMitigationAction
operation.
- The fluent builder is configurable:
action_name(impl Into<String>)
/set_action_name(Option<String>)
: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>)
:The ARN of the IAM role that is used to apply the mitigation action.
action_params(MitigationActionParams)
/set_action_params(Option<MitigationActionParams>)
: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>
sourcepub fn update_provisioning_template(&self) -> UpdateProvisioningTemplate
pub fn update_provisioning_template(&self) -> UpdateProvisioningTemplate
Constructs a fluent builder for the UpdateProvisioningTemplate
operation.
- The fluent builder is configurable:
template_name(impl Into<String>)
/set_template_name(Option<String>)
:The name of the fleet provisioning template.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the fleet provisioning template.
enabled(bool)
/set_enabled(bool)
:True to enable the fleet provisioning template, otherwise false.
default_version_id(i32)
/set_default_version_id(Option<i32>)
:The ID of the default provisioning template version.
provisioning_role_arn(impl Into<String>)
/set_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(ProvisioningHook)
/set_pre_provisioning_hook(Option<ProvisioningHook>)
:Updates the pre-provisioning hook template.
remove_pre_provisioning_hook(bool)
/set_remove_pre_provisioning_hook(Option<bool>)
:Removes pre-provisioning hook template.
- On success, responds with
UpdateProvisioningTemplateOutput
- On failure, responds with
SdkError<UpdateProvisioningTemplateError>
sourcepub fn update_role_alias(&self) -> UpdateRoleAlias
pub fn update_role_alias(&self) -> UpdateRoleAlias
Constructs a fluent builder for the UpdateRoleAlias
operation.
- The fluent builder is configurable:
role_alias(impl Into<String>)
/set_role_alias(Option<String>)
:The role alias to update.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The role ARN.
credential_duration_seconds(i32)
/set_credential_duration_seconds(Option<i32>)
: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>
sourcepub fn update_scheduled_audit(&self) -> UpdateScheduledAudit
pub fn update_scheduled_audit(&self) -> UpdateScheduledAudit
Constructs a fluent builder for the UpdateScheduledAudit
operation.
- The fluent builder is configurable:
frequency(AuditFrequency)
/set_frequency(Option<AuditFrequency>)
:How often the scheduled audit takes place, either
DAILY
,WEEKLY
,BIWEEKLY
, orMONTHLY
. The start time of each audit is determined by the system.day_of_month(impl Into<String>)
/set_day_of_month(Option<String>)
:The day of the month on which the scheduled audit takes place. This can be
1
through31
orLAST
. This field is required if thefrequency
parameter is set toMONTHLY
. 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>)
:The day of the week on which the scheduled audit takes place. This can be one of
SUN
,MON
,TUE
,WED
,THU
,FRI
, orSAT
. This field is required if the “frequency” parameter is set toWEEKLY
orBIWEEKLY
.target_check_names(Vec<String>)
/set_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 useUpdateAccountAuditConfiguration
to select which checks are enabled.)scheduled_audit_name(impl Into<String>)
/set_scheduled_audit_name(Option<String>)
: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>
sourcepub fn update_security_profile(&self) -> UpdateSecurityProfile
pub fn update_security_profile(&self) -> UpdateSecurityProfile
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>)
:The name of the security profile you want to update.
security_profile_description(impl Into<String>)
/set_security_profile_description(Option<String>)
:A description of the security profile.
behaviors(Vec<Behavior>)
/set_behaviors(Option<Vec<Behavior>>)
:Specifies the behaviors that, when violated by a device (thing), cause an alert.
alert_targets(HashMap<AlertTargetType, AlertTarget>)
/set_alert_targets(Option<HashMap<AlertTargetType, AlertTarget>>)
:Where the alerts are sent. (Alerts are always sent to the console.)
additional_metrics_to_retain(Vec<String>)
/set_additional_metrics_to_retain(Option<Vec<String>>)
: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(Vec<MetricToRetain>)
/set_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.
delete_behaviors(bool)
/set_delete_behaviors(bool)
:If true, delete all
behaviors
defined for this security profile. If anybehaviors
are defined in the current invocation, an exception occurs.delete_alert_targets(bool)
/set_delete_alert_targets(bool)
:If true, delete all
alertTargets
defined for this security profile. If anyalertTargets
are defined in the current invocation, an exception occurs.delete_additional_metrics_to_retain(bool)
/set_delete_additional_metrics_to_retain(bool)
:If true, delete all
additionalMetricsToRetain
defined for this security profile. If anyadditionalMetricsToRetain
are defined in the current invocation, an exception occurs.expected_version(i64)
/set_expected_version(Option<i64>)
: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
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.
- On failure, responds with
SdkError<UpdateSecurityProfileError>
sourcepub fn update_stream(&self) -> UpdateStream
pub fn update_stream(&self) -> UpdateStream
Constructs a fluent builder for the UpdateStream
operation.
- The fluent builder is configurable:
stream_id(impl Into<String>)
/set_stream_id(Option<String>)
:The stream ID.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the stream.
files(Vec<StreamFile>)
/set_files(Option<Vec<StreamFile>>)
:The files associated with the stream.
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
: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>
sourcepub fn update_thing(&self) -> UpdateThing
pub fn update_thing(&self) -> UpdateThing
Constructs a fluent builder for the UpdateThing
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
: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>)
:The name of the thing type.
attribute_payload(AttributePayload)
/set_attribute_payload(Option<AttributePayload>)
: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>)
: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 aVersionConflictException
.remove_thing_type(bool)
/set_remove_thing_type(bool)
:Remove a thing type association. If true, the association is removed.
- On success, responds with
UpdateThingOutput
- On failure, responds with
SdkError<UpdateThingError>
sourcepub fn update_thing_group(&self) -> UpdateThingGroup
pub fn update_thing_group(&self) -> UpdateThingGroup
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>)
:The thing group to update.
thing_group_properties(ThingGroupProperties)
/set_thing_group_properties(Option<ThingGroupProperties>)
:The thing group properties.
expected_version(i64)
/set_expected_version(Option<i64>)
: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>
sourcepub fn update_thing_groups_for_thing(&self) -> UpdateThingGroupsForThing
pub fn update_thing_groups_for_thing(&self) -> UpdateThingGroupsForThing
Constructs a fluent builder for the UpdateThingGroupsForThing
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The thing whose group memberships will be updated.
thing_groups_to_add(Vec<String>)
/set_thing_groups_to_add(Option<Vec<String>>)
:The groups to which the thing will be added.
thing_groups_to_remove(Vec<String>)
/set_thing_groups_to_remove(Option<Vec<String>>)
:The groups from which the thing will be removed.
override_dynamic_groups(bool)
/set_override_dynamic_groups(bool)
: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>
sourcepub fn update_topic_rule_destination(&self) -> UpdateTopicRuleDestination
pub fn update_topic_rule_destination(&self) -> UpdateTopicRuleDestination
Constructs a fluent builder for the UpdateTopicRuleDestination
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:The ARN of the topic rule destination.
status(TopicRuleDestinationStatus)
/set_status(Option<TopicRuleDestinationStatus>)
: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
toIN_PROGRESS
by callingUpdateTopicRuleDestination
. CallingUpdateTopicRuleDestination
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
toDISABLED
by callingUpdateTopicRuleDestination
. - DISABLED
-
Confirmation was completed, and traffic to this destination is not allowed. You can set
status
toENABLED
by callingUpdateTopicRuleDestination
. - ERROR
-
Confirmation could not be completed, for example if the confirmation timed out. You can call
GetTopicRuleDestination
for details about the error. You can setstatus
toIN_PROGRESS
by callingUpdateTopicRuleDestination
. CallingUpdateTopicRuleDestination
causes a new confirmation challenge to be sent to your confirmation endpoint.
- On success, responds with
UpdateTopicRuleDestinationOutput
- On failure, responds with
SdkError<UpdateTopicRuleDestinationError>
sourcepub fn validate_security_profile_behaviors(
&self
) -> ValidateSecurityProfileBehaviors
pub fn validate_security_profile_behaviors(
&self
) -> ValidateSecurityProfileBehaviors
Constructs a fluent builder for the ValidateSecurityProfileBehaviors
operation.
- The fluent builder is configurable:
behaviors(Vec<Behavior>)
/set_behaviors(Option<Vec<Behavior>>)
: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>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more