amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.Lens

Contents

Description

 
Synopsis

Operations

AcceptCertificateTransfer

acceptCertificateTransfer_setAsActive :: Lens' AcceptCertificateTransfer (Maybe Bool) Source #

Specifies whether the certificate is active.

acceptCertificateTransfer_certificateId :: Lens' AcceptCertificateTransfer Text Source #

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

AddThingToBillingGroup

addThingToBillingGroup_billingGroupArn :: Lens' AddThingToBillingGroup (Maybe Text) Source #

The ARN of the billing group.

addThingToBillingGroup_billingGroupName :: Lens' AddThingToBillingGroup (Maybe Text) Source #

The name of the billing group.

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

addThingToBillingGroup_thingArn :: Lens' AddThingToBillingGroup (Maybe Text) Source #

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

addThingToBillingGroup_thingName :: Lens' AddThingToBillingGroup (Maybe Text) Source #

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

addThingToBillingGroupResponse_httpStatus :: Lens' AddThingToBillingGroupResponse Int Source #

The response's http status code.

AddThingToThingGroup

addThingToThingGroup_overrideDynamicGroups :: Lens' AddThingToThingGroup (Maybe Bool) Source #

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.

addThingToThingGroup_thingArn :: Lens' AddThingToThingGroup (Maybe Text) Source #

The ARN of the thing to add to a group.

addThingToThingGroup_thingGroupArn :: Lens' AddThingToThingGroup (Maybe Text) Source #

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

addThingToThingGroup_thingGroupName :: Lens' AddThingToThingGroup (Maybe Text) Source #

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

addThingToThingGroup_thingName :: Lens' AddThingToThingGroup (Maybe Text) Source #

The name of the thing to add to a group.

addThingToThingGroupResponse_httpStatus :: Lens' AddThingToThingGroupResponse Int Source #

The response's http status code.

AssociateTargetsWithJob

associateTargetsWithJob_comment :: Lens' AssociateTargetsWithJob (Maybe Text) Source #

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

associateTargetsWithJob_namespaceId :: Lens' AssociateTargetsWithJob (Maybe Text) Source #

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.

associateTargetsWithJob_targets :: Lens' AssociateTargetsWithJob (NonEmpty Text) Source #

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

associateTargetsWithJob_jobId :: Lens' AssociateTargetsWithJob Text Source #

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

associateTargetsWithJobResponse_description :: Lens' AssociateTargetsWithJobResponse (Maybe Text) Source #

A short text description of the job.

associateTargetsWithJobResponse_jobArn :: Lens' AssociateTargetsWithJobResponse (Maybe Text) Source #

An ARN identifying the job.

associateTargetsWithJobResponse_jobId :: Lens' AssociateTargetsWithJobResponse (Maybe Text) Source #

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

associateTargetsWithJobResponse_httpStatus :: Lens' AssociateTargetsWithJobResponse Int Source #

The response's http status code.

AttachPolicy

attachPolicy_policyName :: Lens' AttachPolicy Text Source #

The name of the policy to attach.

attachPolicy_target :: Lens' AttachPolicy Text Source #

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

AttachSecurityProfile

attachSecurityProfile_securityProfileName :: Lens' AttachSecurityProfile Text Source #

The security profile that is attached.

attachSecurityProfile_securityProfileTargetArn :: Lens' AttachSecurityProfile Text Source #

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

attachSecurityProfileResponse_httpStatus :: Lens' AttachSecurityProfileResponse Int Source #

The response's http status code.

AttachThingPrincipal

attachThingPrincipal_thingName :: Lens' AttachThingPrincipal Text Source #

The name of the thing.

attachThingPrincipal_principal :: Lens' AttachThingPrincipal Text Source #

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

attachThingPrincipalResponse_httpStatus :: Lens' AttachThingPrincipalResponse Int Source #

The response's http status code.

CancelAuditMitigationActionsTask

cancelAuditMitigationActionsTask_taskId :: Lens' CancelAuditMitigationActionsTask Text Source #

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

cancelAuditMitigationActionsTaskResponse_httpStatus :: Lens' CancelAuditMitigationActionsTaskResponse Int Source #

The response's http status code.

CancelAuditTask

cancelAuditTask_taskId :: Lens' CancelAuditTask Text Source #

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

cancelAuditTaskResponse_httpStatus :: Lens' CancelAuditTaskResponse Int Source #

The response's http status code.

CancelCertificateTransfer

cancelCertificateTransfer_certificateId :: Lens' CancelCertificateTransfer Text Source #

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

CancelDetectMitigationActionsTask

cancelDetectMitigationActionsTask_taskId :: Lens' CancelDetectMitigationActionsTask Text Source #

The unique identifier of the task.

cancelDetectMitigationActionsTaskResponse_httpStatus :: Lens' CancelDetectMitigationActionsTaskResponse Int Source #

The response's http status code.

CancelJob

cancelJob_comment :: Lens' CancelJob (Maybe Text) Source #

An optional comment string describing why the job was canceled.

cancelJob_force :: Lens' CancelJob (Maybe Bool) Source #

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

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

cancelJob_reasonCode :: Lens' CancelJob (Maybe Text) Source #

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

cancelJob_jobId :: Lens' CancelJob Text Source #

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

cancelJobResponse_description :: Lens' CancelJobResponse (Maybe Text) Source #

A short text description of the job.

cancelJobResponse_jobArn :: Lens' CancelJobResponse (Maybe Text) Source #

The job ARN.

cancelJobResponse_jobId :: Lens' CancelJobResponse (Maybe Text) Source #

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

cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int Source #

The response's http status code.

CancelJobExecution

cancelJobExecution_expectedVersion :: Lens' CancelJobExecution (Maybe Integer) Source #

(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.)

cancelJobExecution_force :: Lens' CancelJobExecution (Maybe Bool) Source #

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

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

cancelJobExecution_statusDetails :: Lens' CancelJobExecution (Maybe (HashMap Text Text)) Source #

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.

cancelJobExecution_jobId :: Lens' CancelJobExecution Text Source #

The ID of the job to be canceled.

cancelJobExecution_thingName :: Lens' CancelJobExecution Text Source #

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

ClearDefaultAuthorizer

clearDefaultAuthorizerResponse_httpStatus :: Lens' ClearDefaultAuthorizerResponse Int Source #

The response's http status code.

ConfirmTopicRuleDestination

confirmTopicRuleDestination_confirmationToken :: Lens' ConfirmTopicRuleDestination Text Source #

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

confirmTopicRuleDestinationResponse_httpStatus :: Lens' ConfirmTopicRuleDestinationResponse Int Source #

The response's http status code.

CreateAuditSuppression

createAuditSuppression_description :: Lens' CreateAuditSuppression (Maybe Text) Source #

The description of the audit suppression.

createAuditSuppression_expirationDate :: Lens' CreateAuditSuppression (Maybe UTCTime) Source #

The epoch timestamp in seconds at which this suppression expires.

createAuditSuppression_suppressIndefinitely :: Lens' CreateAuditSuppression (Maybe Bool) Source #

Indicates whether a suppression should exist indefinitely or not.

createAuditSuppression_checkName :: Lens' CreateAuditSuppression Text Source #

Undocumented member.

createAuditSuppression_resourceIdentifier :: Lens' CreateAuditSuppression ResourceIdentifier Source #

Undocumented member.

createAuditSuppression_clientRequestToken :: Lens' CreateAuditSuppression Text Source #

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.

createAuditSuppressionResponse_httpStatus :: Lens' CreateAuditSuppressionResponse Int Source #

The response's http status code.

CreateAuthorizer

createAuthorizer_enableCachingForHttp :: Lens' CreateAuthorizer (Maybe Bool) Source #

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

The default value is false.

createAuthorizer_signingDisabled :: Lens' CreateAuthorizer (Maybe Bool) Source #

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

createAuthorizer_status :: Lens' CreateAuthorizer (Maybe AuthorizerStatus) Source #

The status of the create authorizer request.

createAuthorizer_tags :: Lens' CreateAuthorizer (Maybe [Tag]) Source #

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..."

createAuthorizer_tokenKeyName :: Lens' CreateAuthorizer (Maybe Text) Source #

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

createAuthorizer_tokenSigningPublicKeys :: Lens' CreateAuthorizer (Maybe (HashMap Text Text)) Source #

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

createAuthorizer_authorizerName :: Lens' CreateAuthorizer Text Source #

The authorizer name.

createAuthorizer_authorizerFunctionArn :: Lens' CreateAuthorizer Text Source #

The ARN of the authorizer's Lambda function.

createAuthorizerResponse_authorizerArn :: Lens' CreateAuthorizerResponse (Maybe Text) Source #

The authorizer ARN.

createAuthorizerResponse_authorizerName :: Lens' CreateAuthorizerResponse (Maybe Text) Source #

The authorizer's name.

createAuthorizerResponse_httpStatus :: Lens' CreateAuthorizerResponse Int Source #

The response's http status code.

CreateBillingGroup

createBillingGroup_billingGroupProperties :: Lens' CreateBillingGroup (Maybe BillingGroupProperties) Source #

The properties of the billing group.

createBillingGroup_tags :: Lens' CreateBillingGroup (Maybe [Tag]) Source #

Metadata which can be used to manage the billing group.

createBillingGroup_billingGroupName :: Lens' CreateBillingGroup Text Source #

The name you wish to give to the billing group.

createBillingGroupResponse_billingGroupArn :: Lens' CreateBillingGroupResponse (Maybe Text) Source #

The ARN of the billing group.

createBillingGroupResponse_billingGroupId :: Lens' CreateBillingGroupResponse (Maybe Text) Source #

The ID of the billing group.

createBillingGroupResponse_billingGroupName :: Lens' CreateBillingGroupResponse (Maybe Text) Source #

The name you gave to the billing group.

createBillingGroupResponse_httpStatus :: Lens' CreateBillingGroupResponse Int Source #

The response's http status code.

CreateCertificateFromCsr

createCertificateFromCsr_setAsActive :: Lens' CreateCertificateFromCsr (Maybe Bool) Source #

Specifies whether the certificate is active.

createCertificateFromCsr_certificateSigningRequest :: Lens' CreateCertificateFromCsr Text Source #

The certificate signing request (CSR).

createCertificateFromCsrResponse_certificateArn :: Lens' CreateCertificateFromCsrResponse (Maybe Text) Source #

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

createCertificateFromCsrResponse_certificateId :: Lens' CreateCertificateFromCsrResponse (Maybe Text) Source #

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

createCertificateFromCsrResponse_certificatePem :: Lens' CreateCertificateFromCsrResponse (Maybe Text) Source #

The certificate data, in PEM format.

createCertificateFromCsrResponse_httpStatus :: Lens' CreateCertificateFromCsrResponse Int Source #

The response's http status code.

CreateCustomMetric

createCustomMetric_displayName :: Lens' CreateCustomMetric (Maybe Text) Source #

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.

createCustomMetric_tags :: Lens' CreateCustomMetric (Maybe [Tag]) Source #

Metadata that can be used to manage the custom metric.

createCustomMetric_metricName :: Lens' CreateCustomMetric Text Source #

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.

createCustomMetric_metricType :: Lens' CreateCustomMetric CustomMetricType Source #

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.

createCustomMetric_clientRequestToken :: Lens' CreateCustomMetric Text Source #

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.

createCustomMetricResponse_metricArn :: Lens' CreateCustomMetricResponse (Maybe Text) Source #

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

createCustomMetricResponse_metricName :: Lens' CreateCustomMetricResponse (Maybe Text) Source #

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

createCustomMetricResponse_httpStatus :: Lens' CreateCustomMetricResponse Int Source #

The response's http status code.

CreateDimension

createDimension_tags :: Lens' CreateDimension (Maybe [Tag]) Source #

Metadata that can be used to manage the dimension.

createDimension_name :: Lens' CreateDimension Text Source #

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

createDimension_type :: Lens' CreateDimension DimensionType Source #

Specifies the type of dimension. Supported types: TOPIC_FILTER.

createDimension_stringValues :: Lens' CreateDimension (NonEmpty Text) Source #

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/#").

createDimension_clientRequestToken :: Lens' CreateDimension Text Source #

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.

createDimensionResponse_arn :: Lens' CreateDimensionResponse (Maybe Text) Source #

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

createDimensionResponse_name :: Lens' CreateDimensionResponse (Maybe Text) Source #

A unique identifier for the dimension.

createDimensionResponse_httpStatus :: Lens' CreateDimensionResponse Int Source #

The response's http status code.

CreateDomainConfiguration

createDomainConfiguration_authorizerConfig :: Lens' CreateDomainConfiguration (Maybe AuthorizerConfig) Source #

An object that specifies the authorization service for a domain.

createDomainConfiguration_domainName :: Lens' CreateDomainConfiguration (Maybe Text) Source #

The name of the domain.

createDomainConfiguration_serverCertificateArns :: Lens' CreateDomainConfiguration (Maybe [Text]) Source #

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.

createDomainConfiguration_serviceType :: Lens' CreateDomainConfiguration (Maybe ServiceType) Source #

The type of service delivered by the endpoint.

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

createDomainConfiguration_tags :: Lens' CreateDomainConfiguration (Maybe [Tag]) Source #

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..."

createDomainConfiguration_validationCertificateArn :: Lens' CreateDomainConfiguration (Maybe Text) Source #

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.

createDomainConfiguration_domainConfigurationName :: Lens' CreateDomainConfiguration Text Source #

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

createDomainConfigurationResponse_domainConfigurationArn :: Lens' CreateDomainConfigurationResponse (Maybe Text) Source #

The ARN of the domain configuration.

createDomainConfigurationResponse_domainConfigurationName :: Lens' CreateDomainConfigurationResponse (Maybe Text) Source #

The name of the domain configuration.

createDomainConfigurationResponse_httpStatus :: Lens' CreateDomainConfigurationResponse Int Source #

The response's http status code.

CreateDynamicThingGroup

createDynamicThingGroup_indexName :: Lens' CreateDynamicThingGroup (Maybe Text) Source #

The dynamic thing group index name.

Currently one index is supported: AWS_Things.

createDynamicThingGroup_queryVersion :: Lens' CreateDynamicThingGroup (Maybe Text) Source #

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.

createDynamicThingGroup_tags :: Lens' CreateDynamicThingGroup (Maybe [Tag]) Source #

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

createDynamicThingGroup_thingGroupProperties :: Lens' CreateDynamicThingGroup (Maybe ThingGroupProperties) Source #

The dynamic thing group properties.

createDynamicThingGroup_thingGroupName :: Lens' CreateDynamicThingGroup Text Source #

The dynamic thing group name to create.

createDynamicThingGroup_queryString :: Lens' CreateDynamicThingGroup Text Source #

The dynamic thing group search query string.

See Query Syntax for information about query string syntax.

createDynamicThingGroupResponse_indexName :: Lens' CreateDynamicThingGroupResponse (Maybe Text) Source #

The dynamic thing group index name.

createDynamicThingGroupResponse_queryString :: Lens' CreateDynamicThingGroupResponse (Maybe Text) Source #

The dynamic thing group search query string.

createDynamicThingGroupResponse_queryVersion :: Lens' CreateDynamicThingGroupResponse (Maybe Text) Source #

The dynamic thing group query version.

createDynamicThingGroupResponse_thingGroupArn :: Lens' CreateDynamicThingGroupResponse (Maybe Text) Source #

The dynamic thing group ARN.

createDynamicThingGroupResponse_thingGroupId :: Lens' CreateDynamicThingGroupResponse (Maybe Text) Source #

The dynamic thing group ID.

createDynamicThingGroupResponse_thingGroupName :: Lens' CreateDynamicThingGroupResponse (Maybe Text) Source #

The dynamic thing group name.

createDynamicThingGroupResponse_httpStatus :: Lens' CreateDynamicThingGroupResponse Int Source #

The response's http status code.

CreateFleetMetric

createFleetMetric_description :: Lens' CreateFleetMetric (Maybe Text) Source #

The fleet metric description.

createFleetMetric_indexName :: Lens' CreateFleetMetric (Maybe Text) Source #

The name of the index to search.

createFleetMetric_queryVersion :: Lens' CreateFleetMetric (Maybe Text) Source #

The query version.

createFleetMetric_tags :: Lens' CreateFleetMetric (Maybe [Tag]) Source #

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

createFleetMetric_unit :: Lens' CreateFleetMetric (Maybe FleetMetricUnit) Source #

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

createFleetMetric_metricName :: Lens' CreateFleetMetric Text Source #

The name of the fleet metric to create.

createFleetMetric_queryString :: Lens' CreateFleetMetric Text Source #

The search query string.

createFleetMetric_aggregationType :: Lens' CreateFleetMetric AggregationType Source #

The type of the aggregation query.

createFleetMetric_period :: Lens' CreateFleetMetric Natural Source #

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

createFleetMetric_aggregationField :: Lens' CreateFleetMetric Text Source #

The field to aggregate.

createFleetMetricResponse_metricArn :: Lens' CreateFleetMetricResponse (Maybe Text) Source #

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

createFleetMetricResponse_metricName :: Lens' CreateFleetMetricResponse (Maybe Text) Source #

The name of the fleet metric to create.

createFleetMetricResponse_httpStatus :: Lens' CreateFleetMetricResponse Int Source #

The response's http status code.

CreateJob

createJob_abortConfig :: Lens' CreateJob (Maybe AbortConfig) Source #

Allows you to create the criteria to abort a job.

createJob_description :: Lens' CreateJob (Maybe Text) Source #

A short text description of the job.

createJob_document :: Lens' CreateJob (Maybe Text) Source #

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

createJob_documentParameters :: Lens' CreateJob (Maybe (HashMap Text Text)) Source #

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.

createJob_documentSource :: Lens' CreateJob (Maybe Text) Source #

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.

createJob_jobExecutionsRetryConfig :: Lens' CreateJob (Maybe JobExecutionsRetryConfig) Source #

Allows you to create the criteria to retry a job.

createJob_jobExecutionsRolloutConfig :: Lens' CreateJob (Maybe JobExecutionsRolloutConfig) Source #

Allows you to create a staged rollout of the job.

createJob_jobTemplateArn :: Lens' CreateJob (Maybe Text) Source #

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

createJob_namespaceId :: Lens' CreateJob (Maybe Text) Source #

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.

createJob_presignedUrlConfig :: Lens' CreateJob (Maybe PresignedUrlConfig) Source #

Configuration information for pre-signed S3 URLs.

createJob_schedulingConfig :: Lens' CreateJob (Maybe SchedulingConfig) Source #

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

createJob_tags :: Lens' CreateJob (Maybe [Tag]) Source #

Metadata which can be used to manage the job.

createJob_targetSelection :: Lens' CreateJob (Maybe TargetSelection) Source #

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.

createJob_timeoutConfig :: Lens' CreateJob (Maybe TimeoutConfig) Source #

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

createJob_jobId :: Lens' CreateJob Text Source #

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.

createJob_targets :: Lens' CreateJob (NonEmpty Text) Source #

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

createJobResponse_description :: Lens' CreateJobResponse (Maybe Text) Source #

The job description.

createJobResponse_jobArn :: Lens' CreateJobResponse (Maybe Text) Source #

The job ARN.

createJobResponse_jobId :: Lens' CreateJobResponse (Maybe Text) Source #

The unique identifier you assigned to this job.

createJobResponse_httpStatus :: Lens' CreateJobResponse Int Source #

The response's http status code.

CreateJobTemplate

createJobTemplate_abortConfig :: Lens' CreateJobTemplate (Maybe AbortConfig) Source #

Undocumented member.

createJobTemplate_document :: Lens' CreateJobTemplate (Maybe Text) Source #

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

createJobTemplate_documentSource :: Lens' CreateJobTemplate (Maybe Text) Source #

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.

createJobTemplate_jobArn :: Lens' CreateJobTemplate (Maybe Text) Source #

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

createJobTemplate_jobExecutionsRetryConfig :: Lens' CreateJobTemplate (Maybe JobExecutionsRetryConfig) Source #

Allows you to create the criteria to retry a job.

createJobTemplate_jobExecutionsRolloutConfig :: Lens' CreateJobTemplate (Maybe JobExecutionsRolloutConfig) Source #

Undocumented member.

createJobTemplate_presignedUrlConfig :: Lens' CreateJobTemplate (Maybe PresignedUrlConfig) Source #

Undocumented member.

createJobTemplate_tags :: Lens' CreateJobTemplate (Maybe [Tag]) Source #

Metadata that can be used to manage the job template.

createJobTemplate_timeoutConfig :: Lens' CreateJobTemplate (Maybe TimeoutConfig) Source #

Undocumented member.

createJobTemplate_jobTemplateId :: Lens' CreateJobTemplate Text Source #

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

createJobTemplate_description :: Lens' CreateJobTemplate Text Source #

A description of the job document.

createJobTemplateResponse_jobTemplateArn :: Lens' CreateJobTemplateResponse (Maybe Text) Source #

The ARN of the job template.

createJobTemplateResponse_jobTemplateId :: Lens' CreateJobTemplateResponse (Maybe Text) Source #

The unique identifier of the job template.

createJobTemplateResponse_httpStatus :: Lens' CreateJobTemplateResponse Int Source #

The response's http status code.

CreateKeysAndCertificate

createKeysAndCertificate_setAsActive :: Lens' CreateKeysAndCertificate (Maybe Bool) Source #

Specifies whether the certificate is active.

createKeysAndCertificateResponse_certificateArn :: Lens' CreateKeysAndCertificateResponse (Maybe Text) Source #

The ARN of the certificate.

createKeysAndCertificateResponse_certificateId :: Lens' CreateKeysAndCertificateResponse (Maybe Text) Source #

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

createKeysAndCertificateResponse_certificatePem :: Lens' CreateKeysAndCertificateResponse (Maybe Text) Source #

The certificate data, in PEM format.

createKeysAndCertificateResponse_keyPair :: Lens' CreateKeysAndCertificateResponse (Maybe KeyPair) Source #

The generated key pair.

createKeysAndCertificateResponse_httpStatus :: Lens' CreateKeysAndCertificateResponse Int Source #

The response's http status code.

CreateMitigationAction

createMitigationAction_tags :: Lens' CreateMitigationAction (Maybe [Tag]) Source #

Metadata that can be used to manage the mitigation action.

createMitigationAction_actionName :: Lens' CreateMitigationAction Text Source #

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

createMitigationAction_roleArn :: Lens' CreateMitigationAction Text Source #

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

createMitigationAction_actionParams :: Lens' CreateMitigationAction MitigationActionParams Source #

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

createMitigationActionResponse_actionArn :: Lens' CreateMitigationActionResponse (Maybe Text) Source #

The ARN for the new mitigation action.

createMitigationActionResponse_actionId :: Lens' CreateMitigationActionResponse (Maybe Text) Source #

A unique identifier for the new mitigation action.

createMitigationActionResponse_httpStatus :: Lens' CreateMitigationActionResponse Int Source #

The response's http status code.

CreateOTAUpdate

createOTAUpdate_additionalParameters :: Lens' CreateOTAUpdate (Maybe (HashMap Text Text)) Source #

A list of additional OTA update parameters which are name-value pairs.

createOTAUpdate_awsJobAbortConfig :: Lens' CreateOTAUpdate (Maybe AwsJobAbortConfig) Source #

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

createOTAUpdate_awsJobExecutionsRolloutConfig :: Lens' CreateOTAUpdate (Maybe AwsJobExecutionsRolloutConfig) Source #

Configuration for the rollout of OTA updates.

createOTAUpdate_awsJobPresignedUrlConfig :: Lens' CreateOTAUpdate (Maybe AwsJobPresignedUrlConfig) Source #

Configuration information for pre-signed URLs.

createOTAUpdate_awsJobTimeoutConfig :: Lens' CreateOTAUpdate (Maybe AwsJobTimeoutConfig) Source #

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

createOTAUpdate_description :: Lens' CreateOTAUpdate (Maybe Text) Source #

The description of the OTA update.

createOTAUpdate_protocols :: Lens' CreateOTAUpdate (Maybe (NonEmpty Protocol)) Source #

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.

createOTAUpdate_tags :: Lens' CreateOTAUpdate (Maybe [Tag]) Source #

Metadata which can be used to manage updates.

createOTAUpdate_targetSelection :: Lens' CreateOTAUpdate (Maybe TargetSelection) Source #

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.

createOTAUpdate_otaUpdateId :: Lens' CreateOTAUpdate Text Source #

The ID of the OTA update to be created.

createOTAUpdate_targets :: Lens' CreateOTAUpdate (NonEmpty Text) Source #

The devices targeted to receive OTA updates.

createOTAUpdate_files :: Lens' CreateOTAUpdate (NonEmpty OTAUpdateFile) Source #

The files to be streamed by the OTA update.

createOTAUpdate_roleArn :: Lens' CreateOTAUpdate Text Source #

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.

createOTAUpdateResponse_awsIotJobArn :: Lens' CreateOTAUpdateResponse (Maybe Text) Source #

The IoT job ARN associated with the OTA update.

createOTAUpdateResponse_awsIotJobId :: Lens' CreateOTAUpdateResponse (Maybe Text) Source #

The IoT job ID associated with the OTA update.

createOTAUpdateResponse_otaUpdateArn :: Lens' CreateOTAUpdateResponse (Maybe Text) Source #

The OTA update ARN.

createOTAUpdateResponse_otaUpdateId :: Lens' CreateOTAUpdateResponse (Maybe Text) Source #

The OTA update ID.

createOTAUpdateResponse_otaUpdateStatus :: Lens' CreateOTAUpdateResponse (Maybe OTAUpdateStatus) Source #

The OTA update status.

createOTAUpdateResponse_httpStatus :: Lens' CreateOTAUpdateResponse Int Source #

The response's http status code.

CreatePolicy

createPolicy_tags :: Lens' CreatePolicy (Maybe [Tag]) Source #

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..."

createPolicy_policyName :: Lens' CreatePolicy Text Source #

The policy name.

createPolicy_policyDocument :: Lens' CreatePolicy Text Source #

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

createPolicyResponse_policyArn :: Lens' CreatePolicyResponse (Maybe Text) Source #

The policy ARN.

createPolicyResponse_policyDocument :: Lens' CreatePolicyResponse (Maybe Text) Source #

The JSON document that describes the policy.

createPolicyResponse_policyName :: Lens' CreatePolicyResponse (Maybe Text) Source #

The policy name.

createPolicyResponse_policyVersionId :: Lens' CreatePolicyResponse (Maybe Text) Source #

The policy version ID.

createPolicyResponse_httpStatus :: Lens' CreatePolicyResponse Int Source #

The response's http status code.

CreatePolicyVersion

createPolicyVersion_setAsDefault :: Lens' CreatePolicyVersion (Maybe Bool) Source #

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).

createPolicyVersion_policyName :: Lens' CreatePolicyVersion Text Source #

The policy name.

createPolicyVersion_policyDocument :: Lens' CreatePolicyVersion Text Source #

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

createPolicyVersionResponse_isDefaultVersion :: Lens' CreatePolicyVersionResponse (Maybe Bool) Source #

Specifies whether the policy version is the default.

createPolicyVersionResponse_policyArn :: Lens' CreatePolicyVersionResponse (Maybe Text) Source #

The policy ARN.

createPolicyVersionResponse_policyDocument :: Lens' CreatePolicyVersionResponse (Maybe Text) Source #

The JSON document that describes the policy.

createPolicyVersionResponse_policyVersionId :: Lens' CreatePolicyVersionResponse (Maybe Text) Source #

The policy version ID.

createPolicyVersionResponse_httpStatus :: Lens' CreatePolicyVersionResponse Int Source #

The response's http status code.

CreateProvisioningClaim

createProvisioningClaim_templateName :: Lens' CreateProvisioningClaim Text Source #

The name of the provisioning template to use.

createProvisioningClaimResponse_certificateId :: Lens' CreateProvisioningClaimResponse (Maybe Text) Source #

The ID of the certificate.

createProvisioningClaimResponse_certificatePem :: Lens' CreateProvisioningClaimResponse (Maybe Text) Source #

The provisioning claim certificate.

createProvisioningClaimResponse_expiration :: Lens' CreateProvisioningClaimResponse (Maybe UTCTime) Source #

The provisioning claim expiration time.

createProvisioningClaimResponse_keyPair :: Lens' CreateProvisioningClaimResponse (Maybe KeyPair) Source #

The provisioning claim key pair.

createProvisioningClaimResponse_httpStatus :: Lens' CreateProvisioningClaimResponse Int Source #

The response's http status code.

CreateProvisioningTemplate

createProvisioningTemplate_description :: Lens' CreateProvisioningTemplate (Maybe Text) Source #

The description of the provisioning template.

createProvisioningTemplate_enabled :: Lens' CreateProvisioningTemplate (Maybe Bool) Source #

True to enable the provisioning template, otherwise false.

createProvisioningTemplate_preProvisioningHook :: Lens' CreateProvisioningTemplate (Maybe ProvisioningHook) Source #

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

createProvisioningTemplate_tags :: Lens' CreateProvisioningTemplate (Maybe [Tag]) Source #

Metadata which can be used to manage the provisioning template.

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

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

createProvisioningTemplate_type :: Lens' CreateProvisioningTemplate (Maybe TemplateType) Source #

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

createProvisioningTemplate_templateName :: Lens' CreateProvisioningTemplate Text Source #

The name of the provisioning template.

createProvisioningTemplate_templateBody :: Lens' CreateProvisioningTemplate Text Source #

The JSON formatted contents of the provisioning template.

createProvisioningTemplate_provisioningRoleArn :: Lens' CreateProvisioningTemplate Text Source #

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

createProvisioningTemplateResponse_defaultVersionId :: Lens' CreateProvisioningTemplateResponse (Maybe Int) Source #

The default version of the provisioning template.

createProvisioningTemplateResponse_templateArn :: Lens' CreateProvisioningTemplateResponse (Maybe Text) Source #

The ARN that identifies the provisioning template.

createProvisioningTemplateResponse_templateName :: Lens' CreateProvisioningTemplateResponse (Maybe Text) Source #

The name of the provisioning template.

createProvisioningTemplateResponse_httpStatus :: Lens' CreateProvisioningTemplateResponse Int Source #

The response's http status code.

CreateProvisioningTemplateVersion

createProvisioningTemplateVersion_setAsDefault :: Lens' CreateProvisioningTemplateVersion (Maybe Bool) Source #

Sets a fleet provision template version as the default version.

createProvisioningTemplateVersion_templateName :: Lens' CreateProvisioningTemplateVersion Text Source #

The name of the provisioning template.

createProvisioningTemplateVersion_templateBody :: Lens' CreateProvisioningTemplateVersion Text Source #

The JSON formatted contents of the provisioning template.

createProvisioningTemplateVersionResponse_isDefaultVersion :: Lens' CreateProvisioningTemplateVersionResponse (Maybe Bool) Source #

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

createProvisioningTemplateVersionResponse_templateArn :: Lens' CreateProvisioningTemplateVersionResponse (Maybe Text) Source #

The ARN that identifies the provisioning template.

createProvisioningTemplateVersionResponse_templateName :: Lens' CreateProvisioningTemplateVersionResponse (Maybe Text) Source #

The name of the provisioning template.

createProvisioningTemplateVersionResponse_versionId :: Lens' CreateProvisioningTemplateVersionResponse (Maybe Int) Source #

The version of the provisioning template.

createProvisioningTemplateVersionResponse_httpStatus :: Lens' CreateProvisioningTemplateVersionResponse Int Source #

The response's http status code.

CreateRoleAlias

createRoleAlias_credentialDurationSeconds :: Lens' CreateRoleAlias (Maybe Natural) Source #

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.

createRoleAlias_tags :: Lens' CreateRoleAlias (Maybe [Tag]) Source #

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..."

createRoleAlias_roleAlias :: Lens' CreateRoleAlias Text Source #

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

createRoleAlias_roleArn :: Lens' CreateRoleAlias Text Source #

The role ARN.

createRoleAliasResponse_roleAlias :: Lens' CreateRoleAliasResponse (Maybe Text) Source #

The role alias.

createRoleAliasResponse_roleAliasArn :: Lens' CreateRoleAliasResponse (Maybe Text) Source #

The role alias ARN.

createRoleAliasResponse_httpStatus :: Lens' CreateRoleAliasResponse Int Source #

The response's http status code.

CreateScheduledAudit

createScheduledAudit_dayOfMonth :: Lens' CreateScheduledAudit (Maybe Text) Source #

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

createScheduledAudit_dayOfWeek :: Lens' CreateScheduledAudit (Maybe DayOfWeek) Source #

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

createScheduledAudit_tags :: Lens' CreateScheduledAudit (Maybe [Tag]) Source #

Metadata that can be used to manage the scheduled audit.

createScheduledAudit_frequency :: Lens' CreateScheduledAudit AuditFrequency Source #

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

createScheduledAudit_targetCheckNames :: Lens' CreateScheduledAudit [Text] Source #

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

createScheduledAudit_scheduledAuditName :: Lens' CreateScheduledAudit Text Source #

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

createScheduledAuditResponse_scheduledAuditArn :: Lens' CreateScheduledAuditResponse (Maybe Text) Source #

The ARN of the scheduled audit.

createScheduledAuditResponse_httpStatus :: Lens' CreateScheduledAuditResponse Int Source #

The response's http status code.

CreateSecurityProfile

createSecurityProfile_additionalMetricsToRetain :: Lens' CreateSecurityProfile (Maybe [Text]) Source #

/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.

createSecurityProfile_additionalMetricsToRetainV2 :: Lens' CreateSecurityProfile (Maybe [MetricToRetain]) Source #

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.

createSecurityProfile_alertTargets :: Lens' CreateSecurityProfile (Maybe (HashMap AlertTargetType AlertTarget)) Source #

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.

createSecurityProfile_behaviors :: Lens' CreateSecurityProfile (Maybe [Behavior]) Source #

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

createSecurityProfile_securityProfileDescription :: Lens' CreateSecurityProfile (Maybe Text) Source #

A description of the security profile.

createSecurityProfile_tags :: Lens' CreateSecurityProfile (Maybe [Tag]) Source #

Metadata that can be used to manage the security profile.

createSecurityProfile_securityProfileName :: Lens' CreateSecurityProfile Text Source #

The name you are giving to the security profile.

createSecurityProfileResponse_securityProfileArn :: Lens' CreateSecurityProfileResponse (Maybe Text) Source #

The ARN of the security profile.

createSecurityProfileResponse_securityProfileName :: Lens' CreateSecurityProfileResponse (Maybe Text) Source #

The name you gave to the security profile.

createSecurityProfileResponse_httpStatus :: Lens' CreateSecurityProfileResponse Int Source #

The response's http status code.

CreateStream

createStream_description :: Lens' CreateStream (Maybe Text) Source #

A description of the stream.

createStream_tags :: Lens' CreateStream (Maybe [Tag]) Source #

Metadata which can be used to manage streams.

createStream_streamId :: Lens' CreateStream Text Source #

The stream ID.

createStream_files :: Lens' CreateStream (NonEmpty StreamFile) Source #

The files to stream.

createStream_roleArn :: Lens' CreateStream Text Source #

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

createStreamResponse_description :: Lens' CreateStreamResponse (Maybe Text) Source #

A description of the stream.

createStreamResponse_streamArn :: Lens' CreateStreamResponse (Maybe Text) Source #

The stream ARN.

createStreamResponse_streamId :: Lens' CreateStreamResponse (Maybe Text) Source #

The stream ID.

createStreamResponse_streamVersion :: Lens' CreateStreamResponse (Maybe Natural) Source #

The version of the stream.

createStreamResponse_httpStatus :: Lens' CreateStreamResponse Int Source #

The response's http status code.

CreateThing

createThing_attributePayload :: Lens' CreateThing (Maybe AttributePayload) Source #

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

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

createThing_billingGroupName :: Lens' CreateThing (Maybe Text) Source #

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

createThing_thingTypeName :: Lens' CreateThing (Maybe Text) Source #

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

createThing_thingName :: Lens' CreateThing Text Source #

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.

createThingResponse_thingArn :: Lens' CreateThingResponse (Maybe Text) Source #

The ARN of the new thing.

createThingResponse_thingId :: Lens' CreateThingResponse (Maybe Text) Source #

The thing ID.

createThingResponse_thingName :: Lens' CreateThingResponse (Maybe Text) Source #

The name of the new thing.

createThingResponse_httpStatus :: Lens' CreateThingResponse Int Source #

The response's http status code.

CreateThingGroup

createThingGroup_parentGroupName :: Lens' CreateThingGroup (Maybe Text) Source #

The name of the parent thing group.

createThingGroup_tags :: Lens' CreateThingGroup (Maybe [Tag]) Source #

Metadata which can be used to manage the thing group.

createThingGroup_thingGroupProperties :: Lens' CreateThingGroup (Maybe ThingGroupProperties) Source #

The thing group properties.

createThingGroup_thingGroupName :: Lens' CreateThingGroup Text Source #

The thing group name to create.

createThingGroupResponse_thingGroupArn :: Lens' CreateThingGroupResponse (Maybe Text) Source #

The thing group ARN.

createThingGroupResponse_thingGroupId :: Lens' CreateThingGroupResponse (Maybe Text) Source #

The thing group ID.

createThingGroupResponse_thingGroupName :: Lens' CreateThingGroupResponse (Maybe Text) Source #

The thing group name.

createThingGroupResponse_httpStatus :: Lens' CreateThingGroupResponse Int Source #

The response's http status code.

CreateThingType

createThingType_tags :: Lens' CreateThingType (Maybe [Tag]) Source #

Metadata which can be used to manage the thing type.

createThingType_thingTypeProperties :: Lens' CreateThingType (Maybe ThingTypeProperties) Source #

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.

createThingType_thingTypeName :: Lens' CreateThingType Text Source #

The name of the thing type.

createThingTypeResponse_thingTypeArn :: Lens' CreateThingTypeResponse (Maybe Text) Source #

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

createThingTypeResponse_thingTypeId :: Lens' CreateThingTypeResponse (Maybe Text) Source #

The thing type ID.

createThingTypeResponse_thingTypeName :: Lens' CreateThingTypeResponse (Maybe Text) Source #

The name of the thing type.

createThingTypeResponse_httpStatus :: Lens' CreateThingTypeResponse Int Source #

The response's http status code.

CreateTopicRule

createTopicRule_tags :: Lens' CreateTopicRule (Maybe Text) Source #

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..."

createTopicRule_ruleName :: Lens' CreateTopicRule Text Source #

The name of the rule.

createTopicRule_topicRulePayload :: Lens' CreateTopicRule TopicRulePayload Source #

The rule payload.

CreateTopicRuleDestination

createTopicRuleDestination_destinationConfiguration :: Lens' CreateTopicRuleDestination TopicRuleDestinationConfiguration Source #

The topic rule destination configuration.

createTopicRuleDestinationResponse_topicRuleDestination :: Lens' CreateTopicRuleDestinationResponse (Maybe TopicRuleDestination) Source #

The topic rule destination.

createTopicRuleDestinationResponse_httpStatus :: Lens' CreateTopicRuleDestinationResponse Int Source #

The response's http status code.

DeleteAccountAuditConfiguration

deleteAccountAuditConfiguration_deleteScheduledAudits :: Lens' DeleteAccountAuditConfiguration (Maybe Bool) Source #

If true, all scheduled audits are deleted.

deleteAccountAuditConfigurationResponse_httpStatus :: Lens' DeleteAccountAuditConfigurationResponse Int Source #

The response's http status code.

DeleteAuditSuppression

deleteAuditSuppression_checkName :: Lens' DeleteAuditSuppression Text Source #

Undocumented member.

deleteAuditSuppression_resourceIdentifier :: Lens' DeleteAuditSuppression ResourceIdentifier Source #

Undocumented member.

deleteAuditSuppressionResponse_httpStatus :: Lens' DeleteAuditSuppressionResponse Int Source #

The response's http status code.

DeleteAuthorizer

deleteAuthorizer_authorizerName :: Lens' DeleteAuthorizer Text Source #

The name of the authorizer to delete.

deleteAuthorizerResponse_httpStatus :: Lens' DeleteAuthorizerResponse Int Source #

The response's http status code.

DeleteBillingGroup

deleteBillingGroup_expectedVersion :: Lens' DeleteBillingGroup (Maybe Integer) Source #

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

deleteBillingGroup_billingGroupName :: Lens' DeleteBillingGroup Text Source #

The name of the billing group.

deleteBillingGroupResponse_httpStatus :: Lens' DeleteBillingGroupResponse Int Source #

The response's http status code.

DeleteCACertificate

deleteCACertificate_certificateId :: Lens' DeleteCACertificate Text Source #

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

deleteCACertificateResponse_httpStatus :: Lens' DeleteCACertificateResponse Int Source #

The response's http status code.

DeleteCertificate

deleteCertificate_forceDelete :: Lens' DeleteCertificate (Maybe Bool) Source #

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

deleteCertificate_certificateId :: Lens' DeleteCertificate Text Source #

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

DeleteCustomMetric

deleteCustomMetric_metricName :: Lens' DeleteCustomMetric Text Source #

The name of the custom metric.

deleteCustomMetricResponse_httpStatus :: Lens' DeleteCustomMetricResponse Int Source #

The response's http status code.

DeleteDimension

deleteDimension_name :: Lens' DeleteDimension Text Source #

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

deleteDimensionResponse_httpStatus :: Lens' DeleteDimensionResponse Int Source #

The response's http status code.

DeleteDomainConfiguration

deleteDomainConfiguration_domainConfigurationName :: Lens' DeleteDomainConfiguration Text Source #

The name of the domain configuration to be deleted.

deleteDomainConfigurationResponse_httpStatus :: Lens' DeleteDomainConfigurationResponse Int Source #

The response's http status code.

DeleteDynamicThingGroup

deleteDynamicThingGroup_expectedVersion :: Lens' DeleteDynamicThingGroup (Maybe Integer) Source #

The expected version of the dynamic thing group to delete.

deleteDynamicThingGroup_thingGroupName :: Lens' DeleteDynamicThingGroup Text Source #

The name of the dynamic thing group to delete.

deleteDynamicThingGroupResponse_httpStatus :: Lens' DeleteDynamicThingGroupResponse Int Source #

The response's http status code.

DeleteFleetMetric

deleteFleetMetric_expectedVersion :: Lens' DeleteFleetMetric (Maybe Integer) Source #

The expected version of the fleet metric to delete.

deleteFleetMetric_metricName :: Lens' DeleteFleetMetric Text Source #

The name of the fleet metric to delete.

DeleteJob

deleteJob_force :: Lens' DeleteJob (Maybe Bool) Source #

(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.

deleteJob_namespaceId :: Lens' DeleteJob (Maybe Text) Source #

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.

deleteJob_jobId :: Lens' DeleteJob Text Source #

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.

DeleteJobExecution

deleteJobExecution_force :: Lens' DeleteJobExecution (Maybe Bool) Source #

(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.

deleteJobExecution_namespaceId :: Lens' DeleteJobExecution (Maybe Text) Source #

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.

deleteJobExecution_jobId :: Lens' DeleteJobExecution Text Source #

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

deleteJobExecution_thingName :: Lens' DeleteJobExecution Text Source #

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

deleteJobExecution_executionNumber :: Lens' DeleteJobExecution Integer Source #

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.

DeleteJobTemplate

deleteJobTemplate_jobTemplateId :: Lens' DeleteJobTemplate Text Source #

The unique identifier of the job template to delete.

DeleteMitigationAction

deleteMitigationAction_actionName :: Lens' DeleteMitigationAction Text Source #

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

deleteMitigationActionResponse_httpStatus :: Lens' DeleteMitigationActionResponse Int Source #

The response's http status code.

DeleteOTAUpdate

deleteOTAUpdate_deleteStream :: Lens' DeleteOTAUpdate (Maybe Bool) Source #

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.

deleteOTAUpdate_forceDeleteAWSJob :: Lens' DeleteOTAUpdate (Maybe Bool) Source #

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.

deleteOTAUpdate_otaUpdateId :: Lens' DeleteOTAUpdate Text Source #

The ID of the OTA update to delete.

deleteOTAUpdateResponse_httpStatus :: Lens' DeleteOTAUpdateResponse Int Source #

The response's http status code.

DeletePolicy

deletePolicy_policyName :: Lens' DeletePolicy Text Source #

The name of the policy to delete.

DeletePolicyVersion

deletePolicyVersion_policyName :: Lens' DeletePolicyVersion Text Source #

The name of the policy.

deletePolicyVersion_policyVersionId :: Lens' DeletePolicyVersion Text Source #

The policy version ID.

DeleteProvisioningTemplate

deleteProvisioningTemplate_templateName :: Lens' DeleteProvisioningTemplate Text Source #

The name of the fleet provision template to delete.

deleteProvisioningTemplateResponse_httpStatus :: Lens' DeleteProvisioningTemplateResponse Int Source #

The response's http status code.

DeleteProvisioningTemplateVersion

deleteProvisioningTemplateVersion_templateName :: Lens' DeleteProvisioningTemplateVersion Text Source #

The name of the provisioning template version to delete.

deleteProvisioningTemplateVersion_versionId :: Lens' DeleteProvisioningTemplateVersion Int Source #

The provisioning template version ID to delete.

deleteProvisioningTemplateVersionResponse_httpStatus :: Lens' DeleteProvisioningTemplateVersionResponse Int Source #

The response's http status code.

DeleteRegistrationCode

deleteRegistrationCodeResponse_httpStatus :: Lens' DeleteRegistrationCodeResponse Int Source #

The response's http status code.

DeleteRoleAlias

deleteRoleAlias_roleAlias :: Lens' DeleteRoleAlias Text Source #

The role alias to delete.

deleteRoleAliasResponse_httpStatus :: Lens' DeleteRoleAliasResponse Int Source #

The response's http status code.

DeleteScheduledAudit

deleteScheduledAudit_scheduledAuditName :: Lens' DeleteScheduledAudit Text Source #

The name of the scheduled audit you want to delete.

deleteScheduledAuditResponse_httpStatus :: Lens' DeleteScheduledAuditResponse Int Source #

The response's http status code.

DeleteSecurityProfile

deleteSecurityProfile_expectedVersion :: Lens' DeleteSecurityProfile (Maybe Integer) Source #

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.

deleteSecurityProfile_securityProfileName :: Lens' DeleteSecurityProfile Text Source #

The name of the security profile to be deleted.

deleteSecurityProfileResponse_httpStatus :: Lens' DeleteSecurityProfileResponse Int Source #

The response's http status code.

DeleteStream

deleteStream_streamId :: Lens' DeleteStream Text Source #

The stream ID.

deleteStreamResponse_httpStatus :: Lens' DeleteStreamResponse Int Source #

The response's http status code.

DeleteThing

deleteThing_expectedVersion :: Lens' DeleteThing (Maybe Integer) Source #

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

deleteThing_thingName :: Lens' DeleteThing Text Source #

The name of the thing to delete.

deleteThingResponse_httpStatus :: Lens' DeleteThingResponse Int Source #

The response's http status code.

DeleteThingGroup

deleteThingGroup_expectedVersion :: Lens' DeleteThingGroup (Maybe Integer) Source #

The expected version of the thing group to delete.

deleteThingGroup_thingGroupName :: Lens' DeleteThingGroup Text Source #

The name of the thing group to delete.

deleteThingGroupResponse_httpStatus :: Lens' DeleteThingGroupResponse Int Source #

The response's http status code.

DeleteThingType

deleteThingType_thingTypeName :: Lens' DeleteThingType Text Source #

The name of the thing type.

deleteThingTypeResponse_httpStatus :: Lens' DeleteThingTypeResponse Int Source #

The response's http status code.

DeleteTopicRule

deleteTopicRule_ruleName :: Lens' DeleteTopicRule Text Source #

The name of the rule.

DeleteTopicRuleDestination

deleteTopicRuleDestination_arn :: Lens' DeleteTopicRuleDestination Text Source #

The ARN of the topic rule destination to delete.

deleteTopicRuleDestinationResponse_httpStatus :: Lens' DeleteTopicRuleDestinationResponse Int Source #

The response's http status code.

DeleteV2LoggingLevel

deleteV2LoggingLevel_targetType :: Lens' DeleteV2LoggingLevel LogTargetType Source #

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

deleteV2LoggingLevel_targetName :: Lens' DeleteV2LoggingLevel Text Source #

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

DeprecateThingType

deprecateThingType_undoDeprecate :: Lens' DeprecateThingType (Maybe Bool) Source #

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

deprecateThingType_thingTypeName :: Lens' DeprecateThingType Text Source #

The name of the thing type to deprecate.

deprecateThingTypeResponse_httpStatus :: Lens' DeprecateThingTypeResponse Int Source #

The response's http status code.

DescribeAccountAuditConfiguration

describeAccountAuditConfigurationResponse_auditCheckConfigurations :: Lens' DescribeAccountAuditConfigurationResponse (Maybe (HashMap Text AuditCheckConfiguration)) Source #

Which audit checks are enabled and disabled for this account.

describeAccountAuditConfigurationResponse_auditNotificationTargetConfigurations :: Lens' DescribeAccountAuditConfigurationResponse (Maybe (HashMap AuditNotificationType AuditNotificationTarget)) Source #

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

describeAccountAuditConfigurationResponse_roleArn :: Lens' DescribeAccountAuditConfigurationResponse (Maybe Text) Source #

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.

describeAccountAuditConfigurationResponse_httpStatus :: Lens' DescribeAccountAuditConfigurationResponse Int Source #

The response's http status code.

DescribeAuditFinding

describeAuditFinding_findingId :: Lens' DescribeAuditFinding Text Source #

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

describeAuditFindingResponse_finding :: Lens' DescribeAuditFindingResponse (Maybe AuditFinding) Source #

Undocumented member.

describeAuditFindingResponse_httpStatus :: Lens' DescribeAuditFindingResponse Int Source #

The response's http status code.

DescribeAuditMitigationActionsTask

describeAuditMitigationActionsTask_taskId :: Lens' DescribeAuditMitigationActionsTask Text Source #

The unique identifier for the audit mitigation task.

describeAuditMitigationActionsTaskResponse_actionsDefinition :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe [MitigationAction]) Source #

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

describeAuditMitigationActionsTaskResponse_auditCheckToActionsMapping :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe (HashMap Text (NonEmpty Text))) Source #

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

describeAuditMitigationActionsTaskResponse_endTime :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe UTCTime) Source #

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

describeAuditMitigationActionsTaskResponse_startTime :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe UTCTime) Source #

The date and time when the task was started.

describeAuditMitigationActionsTaskResponse_target :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe AuditMitigationActionsTaskTarget) Source #

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

describeAuditMitigationActionsTaskResponse_taskStatistics :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe (HashMap Text TaskStatisticsForAuditCheck)) Source #

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

describeAuditMitigationActionsTaskResponse_taskStatus :: Lens' DescribeAuditMitigationActionsTaskResponse (Maybe AuditMitigationActionsTaskStatus) Source #

The current status of the task.

describeAuditMitigationActionsTaskResponse_httpStatus :: Lens' DescribeAuditMitigationActionsTaskResponse Int Source #

The response's http status code.

DescribeAuditSuppression

describeAuditSuppression_checkName :: Lens' DescribeAuditSuppression Text Source #

Undocumented member.

describeAuditSuppression_resourceIdentifier :: Lens' DescribeAuditSuppression ResourceIdentifier Source #

Undocumented member.

describeAuditSuppressionResponse_checkName :: Lens' DescribeAuditSuppressionResponse (Maybe Text) Source #

Undocumented member.

describeAuditSuppressionResponse_description :: Lens' DescribeAuditSuppressionResponse (Maybe Text) Source #

The description of the audit suppression.

describeAuditSuppressionResponse_expirationDate :: Lens' DescribeAuditSuppressionResponse (Maybe UTCTime) Source #

The epoch timestamp in seconds at which this suppression expires.

describeAuditSuppressionResponse_resourceIdentifier :: Lens' DescribeAuditSuppressionResponse (Maybe ResourceIdentifier) Source #

Undocumented member.

describeAuditSuppressionResponse_suppressIndefinitely :: Lens' DescribeAuditSuppressionResponse (Maybe Bool) Source #

Indicates whether a suppression should exist indefinitely or not.

describeAuditSuppressionResponse_httpStatus :: Lens' DescribeAuditSuppressionResponse Int Source #

The response's http status code.

DescribeAuditTask

describeAuditTask_taskId :: Lens' DescribeAuditTask Text Source #

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

describeAuditTaskResponse_auditDetails :: Lens' DescribeAuditTaskResponse (Maybe (HashMap Text AuditCheckDetails)) Source #

Detailed information about each check performed during this audit.

describeAuditTaskResponse_scheduledAuditName :: Lens' DescribeAuditTaskResponse (Maybe Text) Source #

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

describeAuditTaskResponse_taskStartTime :: Lens' DescribeAuditTaskResponse (Maybe UTCTime) Source #

The time the audit started.

describeAuditTaskResponse_taskStatistics :: Lens' DescribeAuditTaskResponse (Maybe TaskStatistics) Source #

Statistical information about the audit.

describeAuditTaskResponse_taskStatus :: Lens' DescribeAuditTaskResponse (Maybe AuditTaskStatus) Source #

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

describeAuditTaskResponse_taskType :: Lens' DescribeAuditTaskResponse (Maybe AuditTaskType) Source #

The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

describeAuditTaskResponse_httpStatus :: Lens' DescribeAuditTaskResponse Int Source #

The response's http status code.

DescribeAuthorizer

describeAuthorizer_authorizerName :: Lens' DescribeAuthorizer Text Source #

The name of the authorizer to describe.

describeAuthorizerResponse_authorizerDescription :: Lens' DescribeAuthorizerResponse (Maybe AuthorizerDescription) Source #

The authorizer description.

describeAuthorizerResponse_httpStatus :: Lens' DescribeAuthorizerResponse Int Source #

The response's http status code.

DescribeBillingGroup

describeBillingGroup_billingGroupName :: Lens' DescribeBillingGroup Text Source #

The name of the billing group.

describeBillingGroupResponse_billingGroupArn :: Lens' DescribeBillingGroupResponse (Maybe Text) Source #

The ARN of the billing group.

describeBillingGroupResponse_billingGroupId :: Lens' DescribeBillingGroupResponse (Maybe Text) Source #

The ID of the billing group.

describeBillingGroupResponse_billingGroupMetadata :: Lens' DescribeBillingGroupResponse (Maybe BillingGroupMetadata) Source #

Additional information about the billing group.

describeBillingGroupResponse_billingGroupName :: Lens' DescribeBillingGroupResponse (Maybe Text) Source #

The name of the billing group.

describeBillingGroupResponse_billingGroupProperties :: Lens' DescribeBillingGroupResponse (Maybe BillingGroupProperties) Source #

The properties of the billing group.

describeBillingGroupResponse_version :: Lens' DescribeBillingGroupResponse (Maybe Integer) Source #

The version of the billing group.

describeBillingGroupResponse_httpStatus :: Lens' DescribeBillingGroupResponse Int Source #

The response's http status code.

DescribeCACertificate

describeCACertificate_certificateId :: Lens' DescribeCACertificate Text Source #

The CA certificate identifier.

describeCACertificateResponse_certificateDescription :: Lens' DescribeCACertificateResponse (Maybe CACertificateDescription) Source #

The CA certificate description.

describeCACertificateResponse_registrationConfig :: Lens' DescribeCACertificateResponse (Maybe RegistrationConfig) Source #

Information about the registration configuration.

describeCACertificateResponse_httpStatus :: Lens' DescribeCACertificateResponse Int Source #

The response's http status code.

DescribeCertificate

describeCertificate_certificateId :: Lens' DescribeCertificate Text Source #

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

describeCertificateResponse_certificateDescription :: Lens' DescribeCertificateResponse (Maybe CertificateDescription) Source #

The description of the certificate.

describeCertificateResponse_httpStatus :: Lens' DescribeCertificateResponse Int Source #

The response's http status code.

DescribeCustomMetric

describeCustomMetric_metricName :: Lens' DescribeCustomMetric Text Source #

The name of the custom metric.

describeCustomMetricResponse_creationDate :: Lens' DescribeCustomMetricResponse (Maybe UTCTime) Source #

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

describeCustomMetricResponse_displayName :: Lens' DescribeCustomMetricResponse (Maybe Text) Source #

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.

describeCustomMetricResponse_lastModifiedDate :: Lens' DescribeCustomMetricResponse (Maybe UTCTime) Source #

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

describeCustomMetricResponse_metricArn :: Lens' DescribeCustomMetricResponse (Maybe Text) Source #

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

describeCustomMetricResponse_metricName :: Lens' DescribeCustomMetricResponse (Maybe Text) Source #

The name of the custom metric.

describeCustomMetricResponse_metricType :: Lens' DescribeCustomMetricResponse (Maybe CustomMetricType) Source #

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.

describeCustomMetricResponse_httpStatus :: Lens' DescribeCustomMetricResponse Int Source #

The response's http status code.

DescribeDefaultAuthorizer

describeDefaultAuthorizerResponse_authorizerDescription :: Lens' DescribeDefaultAuthorizerResponse (Maybe AuthorizerDescription) Source #

The default authorizer's description.

describeDefaultAuthorizerResponse_httpStatus :: Lens' DescribeDefaultAuthorizerResponse Int Source #

The response's http status code.

DescribeDetectMitigationActionsTask

describeDetectMitigationActionsTask_taskId :: Lens' DescribeDetectMitigationActionsTask Text Source #

The unique identifier of the task.

describeDetectMitigationActionsTaskResponse_taskSummary :: Lens' DescribeDetectMitigationActionsTaskResponse (Maybe DetectMitigationActionsTaskSummary) Source #

The description of a task.

describeDetectMitigationActionsTaskResponse_httpStatus :: Lens' DescribeDetectMitigationActionsTaskResponse Int Source #

The response's http status code.

DescribeDimension

describeDimension_name :: Lens' DescribeDimension Text Source #

The unique identifier for the dimension.

describeDimensionResponse_arn :: Lens' DescribeDimensionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the dimension.

describeDimensionResponse_creationDate :: Lens' DescribeDimensionResponse (Maybe UTCTime) Source #

The date the dimension was created.

describeDimensionResponse_lastModifiedDate :: Lens' DescribeDimensionResponse (Maybe UTCTime) Source #

The date the dimension was last modified.

describeDimensionResponse_name :: Lens' DescribeDimensionResponse (Maybe Text) Source #

The unique identifier for the dimension.

describeDimensionResponse_stringValues :: Lens' DescribeDimensionResponse (Maybe (NonEmpty Text)) Source #

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.

describeDimensionResponse_type :: Lens' DescribeDimensionResponse (Maybe DimensionType) Source #

The type of the dimension.

describeDimensionResponse_httpStatus :: Lens' DescribeDimensionResponse Int Source #

The response's http status code.

DescribeDomainConfiguration

describeDomainConfiguration_domainConfigurationName :: Lens' DescribeDomainConfiguration Text Source #

The name of the domain configuration.

describeDomainConfigurationResponse_authorizerConfig :: Lens' DescribeDomainConfigurationResponse (Maybe AuthorizerConfig) Source #

An object that specifies the authorization service for a domain.

describeDomainConfigurationResponse_domainConfigurationArn :: Lens' DescribeDomainConfigurationResponse (Maybe Text) Source #

The ARN of the domain configuration.

describeDomainConfigurationResponse_domainConfigurationName :: Lens' DescribeDomainConfigurationResponse (Maybe Text) Source #

The name of the domain configuration.

describeDomainConfigurationResponse_domainConfigurationStatus :: Lens' DescribeDomainConfigurationResponse (Maybe DomainConfigurationStatus) Source #

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

describeDomainConfigurationResponse_domainName :: Lens' DescribeDomainConfigurationResponse (Maybe Text) Source #

The name of the domain.

describeDomainConfigurationResponse_domainType :: Lens' DescribeDomainConfigurationResponse (Maybe DomainType) Source #

The type of the domain.

describeDomainConfigurationResponse_lastStatusChangeDate :: Lens' DescribeDomainConfigurationResponse (Maybe UTCTime) Source #

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

describeDomainConfigurationResponse_serverCertificates :: Lens' DescribeDomainConfigurationResponse (Maybe [ServerCertificateSummary]) Source #

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

describeDomainConfigurationResponse_serviceType :: Lens' DescribeDomainConfigurationResponse (Maybe ServiceType) Source #

The type of service delivered by the endpoint.

describeDomainConfigurationResponse_httpStatus :: Lens' DescribeDomainConfigurationResponse Int Source #

The response's http status code.

DescribeEndpoint

describeEndpoint_endpointType :: Lens' DescribeEndpoint (Maybe Text) Source #

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.

describeEndpointResponse_endpointAddress :: Lens' DescribeEndpointResponse (Maybe Text) Source #

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

describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int Source #

The response's http status code.

DescribeEventConfigurations

describeEventConfigurationsResponse_creationDate :: Lens' DescribeEventConfigurationsResponse (Maybe UTCTime) Source #

The creation date of the event configuration.

describeEventConfigurationsResponse_eventConfigurations :: Lens' DescribeEventConfigurationsResponse (Maybe (HashMap EventType Configuration)) Source #

The event configurations.

describeEventConfigurationsResponse_lastModifiedDate :: Lens' DescribeEventConfigurationsResponse (Maybe UTCTime) Source #

The date the event configurations were last modified.

describeEventConfigurationsResponse_httpStatus :: Lens' DescribeEventConfigurationsResponse Int Source #

The response's http status code.

DescribeFleetMetric

describeFleetMetric_metricName :: Lens' DescribeFleetMetric Text Source #

The name of the fleet metric to describe.

describeFleetMetricResponse_aggregationField :: Lens' DescribeFleetMetricResponse (Maybe Text) Source #

The field to aggregate.

describeFleetMetricResponse_aggregationType :: Lens' DescribeFleetMetricResponse (Maybe AggregationType) Source #

The type of the aggregation query.

describeFleetMetricResponse_creationDate :: Lens' DescribeFleetMetricResponse (Maybe UTCTime) Source #

The date when the fleet metric is created.

describeFleetMetricResponse_description :: Lens' DescribeFleetMetricResponse (Maybe Text) Source #

The fleet metric description.

describeFleetMetricResponse_indexName :: Lens' DescribeFleetMetricResponse (Maybe Text) Source #

The name of the index to search.

describeFleetMetricResponse_lastModifiedDate :: Lens' DescribeFleetMetricResponse (Maybe UTCTime) Source #

The date when the fleet metric is last modified.

describeFleetMetricResponse_metricArn :: Lens' DescribeFleetMetricResponse (Maybe Text) Source #

The ARN of the fleet metric to describe.

describeFleetMetricResponse_metricName :: Lens' DescribeFleetMetricResponse (Maybe Text) Source #

The name of the fleet metric to describe.

describeFleetMetricResponse_period :: Lens' DescribeFleetMetricResponse (Maybe Natural) Source #

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

describeFleetMetricResponse_queryString :: Lens' DescribeFleetMetricResponse (Maybe Text) Source #

The search query string.

describeFleetMetricResponse_queryVersion :: Lens' DescribeFleetMetricResponse (Maybe Text) Source #

The query version.

describeFleetMetricResponse_unit :: Lens' DescribeFleetMetricResponse (Maybe FleetMetricUnit) Source #

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

describeFleetMetricResponse_version :: Lens' DescribeFleetMetricResponse (Maybe Integer) Source #

The version of the fleet metric.

describeFleetMetricResponse_httpStatus :: Lens' DescribeFleetMetricResponse Int Source #

The response's http status code.

DescribeIndex

describeIndex_indexName :: Lens' DescribeIndex Text Source #

The index name.

describeIndexResponse_indexName :: Lens' DescribeIndexResponse (Maybe Text) Source #

The index name.

describeIndexResponse_indexStatus :: Lens' DescribeIndexResponse (Maybe IndexStatus) Source #

The index status.

describeIndexResponse_schema :: Lens' DescribeIndexResponse (Maybe Text) Source #

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.

describeIndexResponse_httpStatus :: Lens' DescribeIndexResponse Int Source #

The response's http status code.

DescribeJob

describeJob_jobId :: Lens' DescribeJob Text Source #

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

describeJobResponse_documentSource :: Lens' DescribeJobResponse (Maybe Text) Source #

An S3 link to the job document.

describeJobResponse_job :: Lens' DescribeJobResponse (Maybe Job) Source #

Information about the job.

describeJobResponse_httpStatus :: Lens' DescribeJobResponse Int Source #

The response's http status code.

DescribeJobExecution

describeJobExecution_executionNumber :: Lens' DescribeJobExecution (Maybe Integer) Source #

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

describeJobExecution_jobId :: Lens' DescribeJobExecution Text Source #

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

describeJobExecution_thingName :: Lens' DescribeJobExecution Text Source #

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

describeJobExecutionResponse_execution :: Lens' DescribeJobExecutionResponse (Maybe JobExecution) Source #

Information about the job execution.

describeJobExecutionResponse_httpStatus :: Lens' DescribeJobExecutionResponse Int Source #

The response's http status code.

DescribeJobTemplate

describeJobTemplate_jobTemplateId :: Lens' DescribeJobTemplate Text Source #

The unique identifier of the job template.

describeJobTemplateResponse_abortConfig :: Lens' DescribeJobTemplateResponse (Maybe AbortConfig) Source #

Undocumented member.

describeJobTemplateResponse_createdAt :: Lens' DescribeJobTemplateResponse (Maybe UTCTime) Source #

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

describeJobTemplateResponse_description :: Lens' DescribeJobTemplateResponse (Maybe Text) Source #

A description of the job template.

describeJobTemplateResponse_document :: Lens' DescribeJobTemplateResponse (Maybe Text) Source #

The job document.

describeJobTemplateResponse_documentSource :: Lens' DescribeJobTemplateResponse (Maybe Text) Source #

An S3 link to the job document.

describeJobTemplateResponse_jobExecutionsRetryConfig :: Lens' DescribeJobTemplateResponse (Maybe JobExecutionsRetryConfig) Source #

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

describeJobTemplateResponse_jobExecutionsRolloutConfig :: Lens' DescribeJobTemplateResponse (Maybe JobExecutionsRolloutConfig) Source #

Undocumented member.

describeJobTemplateResponse_jobTemplateArn :: Lens' DescribeJobTemplateResponse (Maybe Text) Source #

The ARN of the job template.

describeJobTemplateResponse_jobTemplateId :: Lens' DescribeJobTemplateResponse (Maybe Text) Source #

The unique identifier of the job template.

describeJobTemplateResponse_presignedUrlConfig :: Lens' DescribeJobTemplateResponse (Maybe PresignedUrlConfig) Source #

Undocumented member.

describeJobTemplateResponse_timeoutConfig :: Lens' DescribeJobTemplateResponse (Maybe TimeoutConfig) Source #

Undocumented member.

describeJobTemplateResponse_httpStatus :: Lens' DescribeJobTemplateResponse Int Source #

The response's http status code.

DescribeManagedJobTemplate

describeManagedJobTemplate_templateVersion :: Lens' DescribeManagedJobTemplate (Maybe Text) Source #

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

describeManagedJobTemplate_templateName :: Lens' DescribeManagedJobTemplate Text Source #

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

describeManagedJobTemplateResponse_description :: Lens' DescribeManagedJobTemplateResponse (Maybe Text) Source #

The unique description of a managed template.

describeManagedJobTemplateResponse_document :: Lens' DescribeManagedJobTemplateResponse (Maybe Text) Source #

The document schema for a managed job template.

describeManagedJobTemplateResponse_documentParameters :: Lens' DescribeManagedJobTemplateResponse (Maybe [DocumentParameter]) Source #

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.

describeManagedJobTemplateResponse_environments :: Lens' DescribeManagedJobTemplateResponse (Maybe [Text]) Source #

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

describeManagedJobTemplateResponse_templateArn :: Lens' DescribeManagedJobTemplateResponse (Maybe Text) Source #

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

describeManagedJobTemplateResponse_templateName :: Lens' DescribeManagedJobTemplateResponse (Maybe Text) Source #

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

describeManagedJobTemplateResponse_templateVersion :: Lens' DescribeManagedJobTemplateResponse (Maybe Text) Source #

The version for a managed template.

describeManagedJobTemplateResponse_httpStatus :: Lens' DescribeManagedJobTemplateResponse Int Source #

The response's http status code.

DescribeMitigationAction

describeMitigationAction_actionName :: Lens' DescribeMitigationAction Text Source #

The friendly name that uniquely identifies the mitigation action.

describeMitigationActionResponse_actionArn :: Lens' DescribeMitigationActionResponse (Maybe Text) Source #

The ARN that identifies this migration action.

describeMitigationActionResponse_actionId :: Lens' DescribeMitigationActionResponse (Maybe Text) Source #

A unique identifier for this action.

describeMitigationActionResponse_actionName :: Lens' DescribeMitigationActionResponse (Maybe Text) Source #

The friendly name that uniquely identifies the mitigation action.

describeMitigationActionResponse_actionParams :: Lens' DescribeMitigationActionResponse (Maybe MitigationActionParams) Source #

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

describeMitigationActionResponse_actionType :: Lens' DescribeMitigationActionResponse (Maybe MitigationActionType) Source #

The type of mitigation action.

describeMitigationActionResponse_creationDate :: Lens' DescribeMitigationActionResponse (Maybe UTCTime) Source #

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

describeMitigationActionResponse_lastModifiedDate :: Lens' DescribeMitigationActionResponse (Maybe UTCTime) Source #

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

describeMitigationActionResponse_roleArn :: Lens' DescribeMitigationActionResponse (Maybe Text) Source #

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

describeMitigationActionResponse_httpStatus :: Lens' DescribeMitigationActionResponse Int Source #

The response's http status code.

DescribeProvisioningTemplate

describeProvisioningTemplate_templateName :: Lens' DescribeProvisioningTemplate Text Source #

The name of the provisioning template.

describeProvisioningTemplateResponse_creationDate :: Lens' DescribeProvisioningTemplateResponse (Maybe UTCTime) Source #

The date when the provisioning template was created.

describeProvisioningTemplateResponse_defaultVersionId :: Lens' DescribeProvisioningTemplateResponse (Maybe Int) Source #

The default fleet template version ID.

describeProvisioningTemplateResponse_description :: Lens' DescribeProvisioningTemplateResponse (Maybe Text) Source #

The description of the provisioning template.

describeProvisioningTemplateResponse_enabled :: Lens' DescribeProvisioningTemplateResponse (Maybe Bool) Source #

True if the provisioning template is enabled, otherwise false.

describeProvisioningTemplateResponse_lastModifiedDate :: Lens' DescribeProvisioningTemplateResponse (Maybe UTCTime) Source #

The date when the provisioning template was last modified.

describeProvisioningTemplateResponse_preProvisioningHook :: Lens' DescribeProvisioningTemplateResponse (Maybe ProvisioningHook) Source #

Gets information about a pre-provisioned hook.

describeProvisioningTemplateResponse_provisioningRoleArn :: Lens' DescribeProvisioningTemplateResponse (Maybe Text) Source #

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

describeProvisioningTemplateResponse_templateArn :: Lens' DescribeProvisioningTemplateResponse (Maybe Text) Source #

The ARN of the provisioning template.

describeProvisioningTemplateResponse_templateBody :: Lens' DescribeProvisioningTemplateResponse (Maybe Text) Source #

The JSON formatted contents of the provisioning template.

describeProvisioningTemplateResponse_templateName :: Lens' DescribeProvisioningTemplateResponse (Maybe Text) Source #

The name of the provisioning template.

describeProvisioningTemplateResponse_type :: Lens' DescribeProvisioningTemplateResponse (Maybe TemplateType) Source #

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

describeProvisioningTemplateResponse_httpStatus :: Lens' DescribeProvisioningTemplateResponse Int Source #

The response's http status code.

DescribeProvisioningTemplateVersion

describeProvisioningTemplateVersion_templateName :: Lens' DescribeProvisioningTemplateVersion Text Source #

The template name.

describeProvisioningTemplateVersion_versionId :: Lens' DescribeProvisioningTemplateVersion Int Source #

The provisioning template version ID.

describeProvisioningTemplateVersionResponse_creationDate :: Lens' DescribeProvisioningTemplateVersionResponse (Maybe UTCTime) Source #

The date when the provisioning template version was created.

describeProvisioningTemplateVersionResponse_isDefaultVersion :: Lens' DescribeProvisioningTemplateVersionResponse (Maybe Bool) Source #

True if the provisioning template version is the default version.

describeProvisioningTemplateVersionResponse_templateBody :: Lens' DescribeProvisioningTemplateVersionResponse (Maybe Text) Source #

The JSON formatted contents of the provisioning template version.

describeProvisioningTemplateVersionResponse_versionId :: Lens' DescribeProvisioningTemplateVersionResponse (Maybe Int) Source #

The provisioning template version ID.

describeProvisioningTemplateVersionResponse_httpStatus :: Lens' DescribeProvisioningTemplateVersionResponse Int Source #

The response's http status code.

DescribeRoleAlias

describeRoleAlias_roleAlias :: Lens' DescribeRoleAlias Text Source #

The role alias to describe.

describeRoleAliasResponse_roleAliasDescription :: Lens' DescribeRoleAliasResponse (Maybe RoleAliasDescription) Source #

The role alias description.

describeRoleAliasResponse_httpStatus :: Lens' DescribeRoleAliasResponse Int Source #

The response's http status code.

DescribeScheduledAudit

describeScheduledAudit_scheduledAuditName :: Lens' DescribeScheduledAudit Text Source #

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

describeScheduledAuditResponse_dayOfMonth :: Lens' DescribeScheduledAuditResponse (Maybe Text) Source #

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

describeScheduledAuditResponse_dayOfWeek :: Lens' DescribeScheduledAuditResponse (Maybe DayOfWeek) Source #

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

describeScheduledAuditResponse_frequency :: Lens' DescribeScheduledAuditResponse (Maybe AuditFrequency) Source #

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

describeScheduledAuditResponse_scheduledAuditArn :: Lens' DescribeScheduledAuditResponse (Maybe Text) Source #

The ARN of the scheduled audit.

describeScheduledAuditResponse_scheduledAuditName :: Lens' DescribeScheduledAuditResponse (Maybe Text) Source #

The name of the scheduled audit.

describeScheduledAuditResponse_targetCheckNames :: Lens' DescribeScheduledAuditResponse (Maybe [Text]) Source #

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

describeScheduledAuditResponse_httpStatus :: Lens' DescribeScheduledAuditResponse Int Source #

The response's http status code.

DescribeSecurityProfile

describeSecurityProfile_securityProfileName :: Lens' DescribeSecurityProfile Text Source #

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

describeSecurityProfileResponse_additionalMetricsToRetain :: Lens' DescribeSecurityProfileResponse (Maybe [Text]) Source #

/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.

describeSecurityProfileResponse_additionalMetricsToRetainV2 :: Lens' DescribeSecurityProfileResponse (Maybe [MetricToRetain]) Source #

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.

describeSecurityProfileResponse_alertTargets :: Lens' DescribeSecurityProfileResponse (Maybe (HashMap AlertTargetType AlertTarget)) Source #

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

describeSecurityProfileResponse_behaviors :: Lens' DescribeSecurityProfileResponse (Maybe [Behavior]) Source #

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

describeSecurityProfileResponse_creationDate :: Lens' DescribeSecurityProfileResponse (Maybe UTCTime) Source #

The time the security profile was created.

describeSecurityProfileResponse_lastModifiedDate :: Lens' DescribeSecurityProfileResponse (Maybe UTCTime) Source #

The time the security profile was last modified.

describeSecurityProfileResponse_securityProfileArn :: Lens' DescribeSecurityProfileResponse (Maybe Text) Source #

The ARN of the security profile.

describeSecurityProfileResponse_securityProfileDescription :: Lens' DescribeSecurityProfileResponse (Maybe Text) Source #

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

describeSecurityProfileResponse_securityProfileName :: Lens' DescribeSecurityProfileResponse (Maybe Text) Source #

The name of the security profile.

describeSecurityProfileResponse_version :: Lens' DescribeSecurityProfileResponse (Maybe Integer) Source #

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

describeSecurityProfileResponse_httpStatus :: Lens' DescribeSecurityProfileResponse Int Source #

The response's http status code.

DescribeStream

describeStream_streamId :: Lens' DescribeStream Text Source #

The stream ID.

describeStreamResponse_streamInfo :: Lens' DescribeStreamResponse (Maybe StreamInfo) Source #

Information about the stream.

describeStreamResponse_httpStatus :: Lens' DescribeStreamResponse Int Source #

The response's http status code.

DescribeThing

describeThing_thingName :: Lens' DescribeThing Text Source #

The name of the thing.

describeThingResponse_attributes :: Lens' DescribeThingResponse (Maybe (HashMap Text Text)) Source #

The thing attributes.

describeThingResponse_billingGroupName :: Lens' DescribeThingResponse (Maybe Text) Source #

The name of the billing group the thing belongs to.

describeThingResponse_defaultClientId :: Lens' DescribeThingResponse (Maybe Text) Source #

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.

describeThingResponse_thingArn :: Lens' DescribeThingResponse (Maybe Text) Source #

The ARN of the thing to describe.

describeThingResponse_thingId :: Lens' DescribeThingResponse (Maybe Text) Source #

The ID of the thing to describe.

describeThingResponse_thingName :: Lens' DescribeThingResponse (Maybe Text) Source #

The name of the thing.

describeThingResponse_thingTypeName :: Lens' DescribeThingResponse (Maybe Text) Source #

The thing type name.

describeThingResponse_version :: Lens' DescribeThingResponse (Maybe Integer) Source #

The current version of the thing record in the registry.

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

describeThingResponse_httpStatus :: Lens' DescribeThingResponse Int Source #

The response's http status code.

DescribeThingGroup

describeThingGroup_thingGroupName :: Lens' DescribeThingGroup Text Source #

The name of the thing group.

describeThingGroupResponse_indexName :: Lens' DescribeThingGroupResponse (Maybe Text) Source #

The dynamic thing group index name.

describeThingGroupResponse_queryString :: Lens' DescribeThingGroupResponse (Maybe Text) Source #

The dynamic thing group search query string.

describeThingGroupResponse_queryVersion :: Lens' DescribeThingGroupResponse (Maybe Text) Source #

The dynamic thing group query version.

describeThingGroupResponse_status :: Lens' DescribeThingGroupResponse (Maybe DynamicGroupStatus) Source #

The dynamic thing group status.

describeThingGroupResponse_thingGroupArn :: Lens' DescribeThingGroupResponse (Maybe Text) Source #

The thing group ARN.

describeThingGroupResponse_thingGroupId :: Lens' DescribeThingGroupResponse (Maybe Text) Source #

The thing group ID.

describeThingGroupResponse_thingGroupMetadata :: Lens' DescribeThingGroupResponse (Maybe ThingGroupMetadata) Source #

Thing group metadata.

describeThingGroupResponse_thingGroupName :: Lens' DescribeThingGroupResponse (Maybe Text) Source #

The name of the thing group.

describeThingGroupResponse_thingGroupProperties :: Lens' DescribeThingGroupResponse (Maybe ThingGroupProperties) Source #

The thing group properties.

describeThingGroupResponse_version :: Lens' DescribeThingGroupResponse (Maybe Integer) Source #

The version of the thing group.

describeThingGroupResponse_httpStatus :: Lens' DescribeThingGroupResponse Int Source #

The response's http status code.

DescribeThingRegistrationTask

describeThingRegistrationTask_taskId :: Lens' DescribeThingRegistrationTask Text Source #

The task ID.

describeThingRegistrationTaskResponse_creationDate :: Lens' DescribeThingRegistrationTaskResponse (Maybe UTCTime) Source #

The task creation date.

describeThingRegistrationTaskResponse_failureCount :: Lens' DescribeThingRegistrationTaskResponse (Maybe Int) Source #

The number of things that failed to be provisioned.

describeThingRegistrationTaskResponse_inputFileBucket :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #

The S3 bucket that contains the input file.

describeThingRegistrationTaskResponse_inputFileKey :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #

The input file key.

describeThingRegistrationTaskResponse_lastModifiedDate :: Lens' DescribeThingRegistrationTaskResponse (Maybe UTCTime) Source #

The date when the task was last modified.

describeThingRegistrationTaskResponse_message :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #

The message.

describeThingRegistrationTaskResponse_percentageProgress :: Lens' DescribeThingRegistrationTaskResponse (Maybe Natural) Source #

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

describeThingRegistrationTaskResponse_roleArn :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #

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

describeThingRegistrationTaskResponse_status :: Lens' DescribeThingRegistrationTaskResponse (Maybe TaskStatus) Source #

The status of the bulk thing provisioning task.

describeThingRegistrationTaskResponse_successCount :: Lens' DescribeThingRegistrationTaskResponse (Maybe Int) Source #

The number of things successfully provisioned.

describeThingRegistrationTaskResponse_taskId :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #

The task ID.

describeThingRegistrationTaskResponse_templateBody :: Lens' DescribeThingRegistrationTaskResponse (Maybe Text) Source #

The task's template.

describeThingRegistrationTaskResponse_httpStatus :: Lens' DescribeThingRegistrationTaskResponse Int Source #

The response's http status code.

DescribeThingType

describeThingType_thingTypeName :: Lens' DescribeThingType Text Source #

The name of the thing type.

describeThingTypeResponse_thingTypeArn :: Lens' DescribeThingTypeResponse (Maybe Text) Source #

The thing type ARN.

describeThingTypeResponse_thingTypeId :: Lens' DescribeThingTypeResponse (Maybe Text) Source #

The thing type ID.

describeThingTypeResponse_thingTypeMetadata :: Lens' DescribeThingTypeResponse (Maybe ThingTypeMetadata) Source #

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.

describeThingTypeResponse_thingTypeName :: Lens' DescribeThingTypeResponse (Maybe Text) Source #

The name of the thing type.

describeThingTypeResponse_thingTypeProperties :: Lens' DescribeThingTypeResponse (Maybe ThingTypeProperties) Source #

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

describeThingTypeResponse_httpStatus :: Lens' DescribeThingTypeResponse Int Source #

The response's http status code.

DetachPolicy

detachPolicy_policyName :: Lens' DetachPolicy Text Source #

The policy to detach.

detachPolicy_target :: Lens' DetachPolicy Text Source #

The target from which the policy will be detached.

DetachSecurityProfile

detachSecurityProfile_securityProfileName :: Lens' DetachSecurityProfile Text Source #

The security profile that is detached.

detachSecurityProfile_securityProfileTargetArn :: Lens' DetachSecurityProfile Text Source #

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

detachSecurityProfileResponse_httpStatus :: Lens' DetachSecurityProfileResponse Int Source #

The response's http status code.

DetachThingPrincipal

detachThingPrincipal_thingName :: Lens' DetachThingPrincipal Text Source #

The name of the thing.

detachThingPrincipal_principal :: Lens' DetachThingPrincipal Text Source #

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.

detachThingPrincipalResponse_httpStatus :: Lens' DetachThingPrincipalResponse Int Source #

The response's http status code.

DisableTopicRule

disableTopicRule_ruleName :: Lens' DisableTopicRule Text Source #

The name of the rule to disable.

EnableTopicRule

enableTopicRule_ruleName :: Lens' EnableTopicRule Text Source #

The name of the topic rule to enable.

GetBehaviorModelTrainingSummaries

getBehaviorModelTrainingSummaries_maxResults :: Lens' GetBehaviorModelTrainingSummaries (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 10.

getBehaviorModelTrainingSummaries_nextToken :: Lens' GetBehaviorModelTrainingSummaries (Maybe Text) Source #

The token for the next set of results.

getBehaviorModelTrainingSummaries_securityProfileName :: Lens' GetBehaviorModelTrainingSummaries (Maybe Text) Source #

The name of the security profile.

getBehaviorModelTrainingSummariesResponse_nextToken :: Lens' GetBehaviorModelTrainingSummariesResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

getBehaviorModelTrainingSummariesResponse_summaries :: Lens' GetBehaviorModelTrainingSummariesResponse (Maybe [BehaviorModelTrainingSummary]) Source #

A list of all ML Detect behaviors and their model status for a given Security Profile.

getBehaviorModelTrainingSummariesResponse_httpStatus :: Lens' GetBehaviorModelTrainingSummariesResponse Int Source #

The response's http status code.

GetBucketsAggregation

getBucketsAggregation_indexName :: Lens' GetBucketsAggregation (Maybe Text) Source #

The name of the index to search.

getBucketsAggregation_queryVersion :: Lens' GetBucketsAggregation (Maybe Text) Source #

The version of the query.

getBucketsAggregation_queryString :: Lens' GetBucketsAggregation Text Source #

The search query string.

getBucketsAggregation_aggregationField :: Lens' GetBucketsAggregation Text Source #

The aggregation field.

getBucketsAggregation_bucketsAggregationType :: Lens' GetBucketsAggregation BucketsAggregationType Source #

The basic control of the response shape and the bucket aggregation type to perform.

getBucketsAggregationResponse_buckets :: Lens' GetBucketsAggregationResponse (Maybe [Bucket]) Source #

The main part of the response with a list of buckets. Each bucket contains a keyValue and a count.

keyValue: The aggregation field value counted for the particular bucket.

count: The number of documents that have that value.

getBucketsAggregationResponse_totalCount :: Lens' GetBucketsAggregationResponse (Maybe Int) Source #

The total number of things that fit the query string criteria.

getBucketsAggregationResponse_httpStatus :: Lens' GetBucketsAggregationResponse Int Source #

The response's http status code.

GetCardinality

getCardinality_aggregationField :: Lens' GetCardinality (Maybe Text) Source #

The field to aggregate.

getCardinality_indexName :: Lens' GetCardinality (Maybe Text) Source #

The name of the index to search.

getCardinality_queryVersion :: Lens' GetCardinality (Maybe Text) Source #

The query version.

getCardinality_queryString :: Lens' GetCardinality Text Source #

The search query string.

getCardinalityResponse_cardinality :: Lens' GetCardinalityResponse (Maybe Int) Source #

The approximate count of unique values that match the query.

getCardinalityResponse_httpStatus :: Lens' GetCardinalityResponse Int Source #

The response's http status code.

GetEffectivePolicies

getEffectivePolicies_cognitoIdentityPoolId :: Lens' GetEffectivePolicies (Maybe Text) Source #

The Cognito identity pool ID.

getEffectivePolicies_principal :: Lens' GetEffectivePolicies (Maybe Text) Source #

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).

getEffectivePolicies_thingName :: Lens' GetEffectivePolicies (Maybe Text) Source #

The thing name.

getEffectivePoliciesResponse_effectivePolicies :: Lens' GetEffectivePoliciesResponse (Maybe [EffectivePolicy]) Source #

The effective policies.

getEffectivePoliciesResponse_httpStatus :: Lens' GetEffectivePoliciesResponse Int Source #

The response's http status code.

GetIndexingConfiguration

getIndexingConfigurationResponse_thingGroupIndexingConfiguration :: Lens' GetIndexingConfigurationResponse (Maybe ThingGroupIndexingConfiguration) Source #

The index configuration.

getIndexingConfigurationResponse_thingIndexingConfiguration :: Lens' GetIndexingConfigurationResponse (Maybe ThingIndexingConfiguration) Source #

Thing indexing configuration.

getIndexingConfigurationResponse_httpStatus :: Lens' GetIndexingConfigurationResponse Int Source #

The response's http status code.

GetJobDocument

getJobDocument_jobId :: Lens' GetJobDocument Text Source #

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

getJobDocumentResponse_document :: Lens' GetJobDocumentResponse (Maybe Text) Source #

The job document content.

getJobDocumentResponse_httpStatus :: Lens' GetJobDocumentResponse Int Source #

The response's http status code.

GetLoggingOptions

getLoggingOptionsResponse_logLevel :: Lens' GetLoggingOptionsResponse (Maybe LogLevel) Source #

The logging level.

getLoggingOptionsResponse_roleArn :: Lens' GetLoggingOptionsResponse (Maybe Text) Source #

The ARN of the IAM role that grants access.

getLoggingOptionsResponse_httpStatus :: Lens' GetLoggingOptionsResponse Int Source #

The response's http status code.

GetOTAUpdate

getOTAUpdate_otaUpdateId :: Lens' GetOTAUpdate Text Source #

The OTA update ID.

getOTAUpdateResponse_otaUpdateInfo :: Lens' GetOTAUpdateResponse (Maybe OTAUpdateInfo) Source #

The OTA update info.

getOTAUpdateResponse_httpStatus :: Lens' GetOTAUpdateResponse Int Source #

The response's http status code.

GetPercentiles

getPercentiles_aggregationField :: Lens' GetPercentiles (Maybe Text) Source #

The field to aggregate.

getPercentiles_indexName :: Lens' GetPercentiles (Maybe Text) Source #

The name of the index to search.

getPercentiles_percents :: Lens' GetPercentiles (Maybe [Double]) Source #

The percentile groups returned.

getPercentiles_queryVersion :: Lens' GetPercentiles (Maybe Text) Source #

The query version.

getPercentiles_queryString :: Lens' GetPercentiles Text Source #

The search query string.

getPercentilesResponse_percentiles :: Lens' GetPercentilesResponse (Maybe [PercentPair]) Source #

The percentile values of the aggregated fields.

getPercentilesResponse_httpStatus :: Lens' GetPercentilesResponse Int Source #

The response's http status code.

GetPolicy

getPolicy_policyName :: Lens' GetPolicy Text Source #

The name of the policy.

getPolicyResponse_creationDate :: Lens' GetPolicyResponse (Maybe UTCTime) Source #

The date the policy was created.

getPolicyResponse_defaultVersionId :: Lens' GetPolicyResponse (Maybe Text) Source #

The default policy version ID.

getPolicyResponse_generationId :: Lens' GetPolicyResponse (Maybe Text) Source #

The generation ID of the policy.

getPolicyResponse_lastModifiedDate :: Lens' GetPolicyResponse (Maybe UTCTime) Source #

The date the policy was last modified.

getPolicyResponse_policyArn :: Lens' GetPolicyResponse (Maybe Text) Source #

The policy ARN.

getPolicyResponse_policyDocument :: Lens' GetPolicyResponse (Maybe Text) Source #

The JSON document that describes the policy.

getPolicyResponse_policyName :: Lens' GetPolicyResponse (Maybe Text) Source #

The policy name.

getPolicyResponse_httpStatus :: Lens' GetPolicyResponse Int Source #

The response's http status code.

GetPolicyVersion

getPolicyVersion_policyName :: Lens' GetPolicyVersion Text Source #

The name of the policy.

getPolicyVersion_policyVersionId :: Lens' GetPolicyVersion Text Source #

The policy version ID.

getPolicyVersionResponse_creationDate :: Lens' GetPolicyVersionResponse (Maybe UTCTime) Source #

The date the policy was created.

getPolicyVersionResponse_generationId :: Lens' GetPolicyVersionResponse (Maybe Text) Source #

The generation ID of the policy version.

getPolicyVersionResponse_isDefaultVersion :: Lens' GetPolicyVersionResponse (Maybe Bool) Source #

Specifies whether the policy version is the default.

getPolicyVersionResponse_lastModifiedDate :: Lens' GetPolicyVersionResponse (Maybe UTCTime) Source #

The date the policy was last modified.

getPolicyVersionResponse_policyArn :: Lens' GetPolicyVersionResponse (Maybe Text) Source #

The policy ARN.

getPolicyVersionResponse_policyDocument :: Lens' GetPolicyVersionResponse (Maybe Text) Source #

The JSON document that describes the policy.

getPolicyVersionResponse_policyName :: Lens' GetPolicyVersionResponse (Maybe Text) Source #

The policy name.

getPolicyVersionResponse_policyVersionId :: Lens' GetPolicyVersionResponse (Maybe Text) Source #

The policy version ID.

getPolicyVersionResponse_httpStatus :: Lens' GetPolicyVersionResponse Int Source #

The response's http status code.

GetRegistrationCode

getRegistrationCodeResponse_registrationCode :: Lens' GetRegistrationCodeResponse (Maybe Text) Source #

The CA certificate registration code.

getRegistrationCodeResponse_httpStatus :: Lens' GetRegistrationCodeResponse Int Source #

The response's http status code.

GetStatistics

getStatistics_aggregationField :: Lens' GetStatistics (Maybe Text) Source #

The aggregation field name.

getStatistics_indexName :: Lens' GetStatistics (Maybe Text) Source #

The name of the index to search. The default value is AWS_Things.

getStatistics_queryVersion :: Lens' GetStatistics (Maybe Text) Source #

The version of the query used to search.

getStatistics_queryString :: Lens' GetStatistics Text Source #

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.

getStatisticsResponse_statistics :: Lens' GetStatisticsResponse (Maybe Statistics) Source #

The statistics returned by the Fleet Indexing service based on the query and aggregation field.

getStatisticsResponse_httpStatus :: Lens' GetStatisticsResponse Int Source #

The response's http status code.

GetTopicRule

getTopicRule_ruleName :: Lens' GetTopicRule Text Source #

The name of the rule.

getTopicRuleResponse_rule :: Lens' GetTopicRuleResponse (Maybe TopicRule) Source #

The rule.

getTopicRuleResponse_ruleArn :: Lens' GetTopicRuleResponse (Maybe Text) Source #

The rule ARN.

getTopicRuleResponse_httpStatus :: Lens' GetTopicRuleResponse Int Source #

The response's http status code.

GetTopicRuleDestination

getTopicRuleDestination_arn :: Lens' GetTopicRuleDestination Text Source #

The ARN of the topic rule destination.

getTopicRuleDestinationResponse_topicRuleDestination :: Lens' GetTopicRuleDestinationResponse (Maybe TopicRuleDestination) Source #

The topic rule destination.

getTopicRuleDestinationResponse_httpStatus :: Lens' GetTopicRuleDestinationResponse Int Source #

The response's http status code.

GetV2LoggingOptions

getV2LoggingOptionsResponse_defaultLogLevel :: Lens' GetV2LoggingOptionsResponse (Maybe LogLevel) Source #

The default log level.

getV2LoggingOptionsResponse_disableAllLogs :: Lens' GetV2LoggingOptionsResponse (Maybe Bool) Source #

Disables all logs.

getV2LoggingOptionsResponse_roleArn :: Lens' GetV2LoggingOptionsResponse (Maybe Text) Source #

The IAM role ARN IoT uses to write to your CloudWatch logs.

getV2LoggingOptionsResponse_httpStatus :: Lens' GetV2LoggingOptionsResponse Int Source #

The response's http status code.

ListActiveViolations

listActiveViolations_behaviorCriteriaType :: Lens' ListActiveViolations (Maybe BehaviorCriteriaType) Source #

The criteria for a behavior.

listActiveViolations_listSuppressedAlerts :: Lens' ListActiveViolations (Maybe Bool) Source #

A list of all suppressed alerts.

listActiveViolations_maxResults :: Lens' ListActiveViolations (Maybe Natural) Source #

The maximum number of results to return at one time.

listActiveViolations_nextToken :: Lens' ListActiveViolations (Maybe Text) Source #

The token for the next set of results.

listActiveViolations_securityProfileName :: Lens' ListActiveViolations (Maybe Text) Source #

The name of the Device Defender security profile for which violations are listed.

listActiveViolations_thingName :: Lens' ListActiveViolations (Maybe Text) Source #

The name of the thing whose active violations are listed.

listActiveViolations_verificationState :: Lens' ListActiveViolations (Maybe VerificationState) Source #

The verification state of the violation (detect alarm).

listActiveViolationsResponse_activeViolations :: Lens' ListActiveViolationsResponse (Maybe [ActiveViolation]) Source #

The list of active violations.

listActiveViolationsResponse_nextToken :: Lens' ListActiveViolationsResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listActiveViolationsResponse_httpStatus :: Lens' ListActiveViolationsResponse Int Source #

The response's http status code.

ListAttachedPolicies

listAttachedPolicies_marker :: Lens' ListAttachedPolicies (Maybe Text) Source #

The token to retrieve the next set of results.

listAttachedPolicies_pageSize :: Lens' ListAttachedPolicies (Maybe Natural) Source #

The maximum number of results to be returned per request.

listAttachedPolicies_recursive :: Lens' ListAttachedPolicies (Maybe Bool) Source #

When true, recursively list attached policies.

listAttachedPolicies_target :: Lens' ListAttachedPolicies Text Source #

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).

listAttachedPoliciesResponse_nextMarker :: Lens' ListAttachedPoliciesResponse (Maybe Text) Source #

The token to retrieve the next set of results, or ``null`` if there are no more results.

listAttachedPoliciesResponse_policies :: Lens' ListAttachedPoliciesResponse (Maybe [Policy]) Source #

The policies.

listAttachedPoliciesResponse_httpStatus :: Lens' ListAttachedPoliciesResponse Int Source #

The response's http status code.

ListAuditFindings

listAuditFindings_checkName :: Lens' ListAuditFindings (Maybe Text) Source #

A filter to limit results to the findings for the specified audit check.

listAuditFindings_endTime :: Lens' ListAuditFindings (Maybe UTCTime) Source #

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.

listAuditFindings_listSuppressedFindings :: Lens' ListAuditFindings (Maybe Bool) Source #

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.

listAuditFindings_maxResults :: Lens' ListAuditFindings (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listAuditFindings_nextToken :: Lens' ListAuditFindings (Maybe Text) Source #

The token for the next set of results.

listAuditFindings_resourceIdentifier :: Lens' ListAuditFindings (Maybe ResourceIdentifier) Source #

Information identifying the noncompliant resource.

listAuditFindings_startTime :: Lens' ListAuditFindings (Maybe UTCTime) Source #

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.

listAuditFindings_taskId :: Lens' ListAuditFindings (Maybe Text) Source #

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.

listAuditFindingsResponse_findings :: Lens' ListAuditFindingsResponse (Maybe [AuditFinding]) Source #

The findings (results) of the audit.

listAuditFindingsResponse_nextToken :: Lens' ListAuditFindingsResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listAuditFindingsResponse_httpStatus :: Lens' ListAuditFindingsResponse Int Source #

The response's http status code.

ListAuditMitigationActionsExecutions

listAuditMitigationActionsExecutions_actionStatus :: Lens' ListAuditMitigationActionsExecutions (Maybe AuditMitigationActionsExecutionStatus) Source #

Specify this filter to limit results to those with a specific status.

listAuditMitigationActionsExecutions_maxResults :: Lens' ListAuditMitigationActionsExecutions (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listAuditMitigationActionsExecutions_nextToken :: Lens' ListAuditMitigationActionsExecutions (Maybe Text) Source #

The token for the next set of results.

listAuditMitigationActionsExecutions_taskId :: Lens' ListAuditMitigationActionsExecutions Text Source #

Specify this filter to limit results to actions for a specific audit mitigation actions task.

listAuditMitigationActionsExecutions_findingId :: Lens' ListAuditMitigationActionsExecutions Text Source #

Specify this filter to limit results to those that were applied to a specific audit finding.

listAuditMitigationActionsExecutionsResponse_actionsExecutions :: Lens' ListAuditMitigationActionsExecutionsResponse (Maybe [AuditMitigationActionExecutionMetadata]) Source #

A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

listAuditMitigationActionsExecutionsResponse_nextToken :: Lens' ListAuditMitigationActionsExecutionsResponse (Maybe Text) Source #

The token for the next set of results.

listAuditMitigationActionsExecutionsResponse_httpStatus :: Lens' ListAuditMitigationActionsExecutionsResponse Int Source #

The response's http status code.

ListAuditMitigationActionsTasks

listAuditMitigationActionsTasks_auditTaskId :: Lens' ListAuditMitigationActionsTasks (Maybe Text) Source #

Specify this filter to limit results to tasks that were applied to results for a specific audit.

listAuditMitigationActionsTasks_findingId :: Lens' ListAuditMitigationActionsTasks (Maybe Text) Source #

Specify this filter to limit results to tasks that were applied to a specific audit finding.

listAuditMitigationActionsTasks_maxResults :: Lens' ListAuditMitigationActionsTasks (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listAuditMitigationActionsTasks_nextToken :: Lens' ListAuditMitigationActionsTasks (Maybe Text) Source #

The token for the next set of results.

listAuditMitigationActionsTasks_taskStatus :: Lens' ListAuditMitigationActionsTasks (Maybe AuditMitigationActionsTaskStatus) Source #

Specify this filter to limit results to tasks that are in a specific state.

listAuditMitigationActionsTasks_startTime :: Lens' ListAuditMitigationActionsTasks UTCTime Source #

Specify this filter to limit results to tasks that began on or after a specific date and time.

listAuditMitigationActionsTasks_endTime :: Lens' ListAuditMitigationActionsTasks UTCTime Source #

Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

listAuditMitigationActionsTasksResponse_nextToken :: Lens' ListAuditMitigationActionsTasksResponse (Maybe Text) Source #

The token for the next set of results.

listAuditMitigationActionsTasksResponse_tasks :: Lens' ListAuditMitigationActionsTasksResponse (Maybe [AuditMitigationActionsTaskMetadata]) Source #

The collection of audit mitigation tasks that matched the filter criteria.

listAuditMitigationActionsTasksResponse_httpStatus :: Lens' ListAuditMitigationActionsTasksResponse Int Source #

The response's http status code.

ListAuditSuppressions

listAuditSuppressions_ascendingOrder :: Lens' ListAuditSuppressions (Maybe Bool) Source #

Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn't provided, ascendingOrder=true.

listAuditSuppressions_checkName :: Lens' ListAuditSuppressions (Maybe Text) Source #

Undocumented member.

listAuditSuppressions_maxResults :: Lens' ListAuditSuppressions (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listAuditSuppressions_nextToken :: Lens' ListAuditSuppressions (Maybe Text) Source #

The token for the next set of results.

listAuditSuppressions_resourceIdentifier :: Lens' ListAuditSuppressions (Maybe ResourceIdentifier) Source #

Undocumented member.

listAuditSuppressionsResponse_nextToken :: Lens' ListAuditSuppressionsResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listAuditSuppressionsResponse_suppressions :: Lens' ListAuditSuppressionsResponse (Maybe [AuditSuppression]) Source #

List of audit suppressions.

listAuditSuppressionsResponse_httpStatus :: Lens' ListAuditSuppressionsResponse Int Source #

The response's http status code.

ListAuditTasks

listAuditTasks_maxResults :: Lens' ListAuditTasks (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listAuditTasks_nextToken :: Lens' ListAuditTasks (Maybe Text) Source #

The token for the next set of results.

listAuditTasks_taskStatus :: Lens' ListAuditTasks (Maybe AuditTaskStatus) Source #

A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

listAuditTasks_taskType :: Lens' ListAuditTasks (Maybe AuditTaskType) Source #

A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".

listAuditTasks_startTime :: Lens' ListAuditTasks UTCTime Source #

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".

listAuditTasks_endTime :: Lens' ListAuditTasks UTCTime Source #

The end of the time period.

listAuditTasksResponse_nextToken :: Lens' ListAuditTasksResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listAuditTasksResponse_tasks :: Lens' ListAuditTasksResponse (Maybe [AuditTaskMetadata]) Source #

The audits that were performed during the specified time period.

listAuditTasksResponse_httpStatus :: Lens' ListAuditTasksResponse Int Source #

The response's http status code.

ListAuthorizers

listAuthorizers_ascendingOrder :: Lens' ListAuthorizers (Maybe Bool) Source #

Return the list of authorizers in ascending alphabetical order.

listAuthorizers_marker :: Lens' ListAuthorizers (Maybe Text) Source #

A marker used to get the next set of results.

listAuthorizers_pageSize :: Lens' ListAuthorizers (Maybe Natural) Source #

The maximum number of results to return at one time.

listAuthorizers_status :: Lens' ListAuthorizers (Maybe AuthorizerStatus) Source #

The status of the list authorizers request.

listAuthorizersResponse_authorizers :: Lens' ListAuthorizersResponse (Maybe [AuthorizerSummary]) Source #

The authorizers.

listAuthorizersResponse_nextMarker :: Lens' ListAuthorizersResponse (Maybe Text) Source #

A marker used to get the next set of results.

listAuthorizersResponse_httpStatus :: Lens' ListAuthorizersResponse Int Source #

The response's http status code.

ListBillingGroups

listBillingGroups_maxResults :: Lens' ListBillingGroups (Maybe Natural) Source #

The maximum number of results to return per request.

listBillingGroups_namePrefixFilter :: Lens' ListBillingGroups (Maybe Text) Source #

Limit the results to billing groups whose names have the given prefix.

listBillingGroups_nextToken :: Lens' ListBillingGroups (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listBillingGroupsResponse_billingGroups :: Lens' ListBillingGroupsResponse (Maybe [GroupNameAndArn]) Source #

The list of billing groups.

listBillingGroupsResponse_nextToken :: Lens' ListBillingGroupsResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listBillingGroupsResponse_httpStatus :: Lens' ListBillingGroupsResponse Int Source #

The response's http status code.

ListCACertificates

listCACertificates_ascendingOrder :: Lens' ListCACertificates (Maybe Bool) Source #

Determines the order of the results.

listCACertificates_marker :: Lens' ListCACertificates (Maybe Text) Source #

The marker for the next set of results.

listCACertificates_pageSize :: Lens' ListCACertificates (Maybe Natural) Source #

The result page size.

listCACertificates_templateName :: Lens' ListCACertificates (Maybe Text) Source #

The name of the provisioning template.

listCACertificatesResponse_certificates :: Lens' ListCACertificatesResponse (Maybe [CACertificate]) Source #

The CA certificates registered in your Amazon Web Services account.

listCACertificatesResponse_nextMarker :: Lens' ListCACertificatesResponse (Maybe Text) Source #

The current position within the list of CA certificates.

listCACertificatesResponse_httpStatus :: Lens' ListCACertificatesResponse Int Source #

The response's http status code.

ListCertificates

listCertificates_ascendingOrder :: Lens' ListCertificates (Maybe Bool) Source #

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

listCertificates_marker :: Lens' ListCertificates (Maybe Text) Source #

The marker for the next set of results.

listCertificates_pageSize :: Lens' ListCertificates (Maybe Natural) Source #

The result page size.

listCertificatesResponse_certificates :: Lens' ListCertificatesResponse (Maybe [Certificate]) Source #

The descriptions of the certificates.

listCertificatesResponse_nextMarker :: Lens' ListCertificatesResponse (Maybe Text) Source #

The marker for the next set of results, or null if there are no additional results.

listCertificatesResponse_httpStatus :: Lens' ListCertificatesResponse Int Source #

The response's http status code.

ListCertificatesByCA

listCertificatesByCA_ascendingOrder :: Lens' ListCertificatesByCA (Maybe Bool) Source #

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

listCertificatesByCA_marker :: Lens' ListCertificatesByCA (Maybe Text) Source #

The marker for the next set of results.

listCertificatesByCA_pageSize :: Lens' ListCertificatesByCA (Maybe Natural) Source #

The result page size.

listCertificatesByCA_caCertificateId :: Lens' ListCertificatesByCA Text Source #

The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

listCertificatesByCAResponse_certificates :: Lens' ListCertificatesByCAResponse (Maybe [Certificate]) Source #

The device certificates signed by the specified CA certificate.

listCertificatesByCAResponse_nextMarker :: Lens' ListCertificatesByCAResponse (Maybe Text) Source #

The marker for the next set of results, or null if there are no additional results.

listCertificatesByCAResponse_httpStatus :: Lens' ListCertificatesByCAResponse Int Source #

The response's http status code.

ListCustomMetrics

listCustomMetrics_maxResults :: Lens' ListCustomMetrics (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listCustomMetrics_nextToken :: Lens' ListCustomMetrics (Maybe Text) Source #

The token for the next set of results.

listCustomMetricsResponse_metricNames :: Lens' ListCustomMetricsResponse (Maybe [Text]) Source #

The name of the custom metric.

listCustomMetricsResponse_nextToken :: Lens' ListCustomMetricsResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listCustomMetricsResponse_httpStatus :: Lens' ListCustomMetricsResponse Int Source #

The response's http status code.

ListDetectMitigationActionsExecutions

listDetectMitigationActionsExecutions_endTime :: Lens' ListDetectMitigationActionsExecutions (Maybe UTCTime) Source #

The end of the time period for which ML Detect mitigation actions executions are returned.

listDetectMitigationActionsExecutions_maxResults :: Lens' ListDetectMitigationActionsExecutions (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listDetectMitigationActionsExecutions_nextToken :: Lens' ListDetectMitigationActionsExecutions (Maybe Text) Source #

The token for the next set of results.

listDetectMitigationActionsExecutions_startTime :: Lens' ListDetectMitigationActionsExecutions (Maybe UTCTime) Source #

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.

listDetectMitigationActionsExecutions_taskId :: Lens' ListDetectMitigationActionsExecutions (Maybe Text) Source #

The unique identifier of the task.

listDetectMitigationActionsExecutions_thingName :: Lens' ListDetectMitigationActionsExecutions (Maybe Text) Source #

The name of the thing whose mitigation actions are listed.

listDetectMitigationActionsExecutions_violationId :: Lens' ListDetectMitigationActionsExecutions (Maybe Text) Source #

The unique identifier of the violation.

listDetectMitigationActionsExecutionsResponse_actionsExecutions :: Lens' ListDetectMitigationActionsExecutionsResponse (Maybe [DetectMitigationActionExecution]) Source #

List of actions executions.

listDetectMitigationActionsExecutionsResponse_nextToken :: Lens' ListDetectMitigationActionsExecutionsResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listDetectMitigationActionsExecutionsResponse_httpStatus :: Lens' ListDetectMitigationActionsExecutionsResponse Int Source #

The response's http status code.

ListDetectMitigationActionsTasks

listDetectMitigationActionsTasks_maxResults :: Lens' ListDetectMitigationActionsTasks (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listDetectMitigationActionsTasks_nextToken :: Lens' ListDetectMitigationActionsTasks (Maybe Text) Source #

The token for the next set of results.

listDetectMitigationActionsTasks_startTime :: Lens' ListDetectMitigationActionsTasks UTCTime Source #

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.

listDetectMitigationActionsTasks_endTime :: Lens' ListDetectMitigationActionsTasks UTCTime Source #

The end of the time period for which ML Detect mitigation actions tasks are returned.

listDetectMitigationActionsTasksResponse_nextToken :: Lens' ListDetectMitigationActionsTasksResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listDetectMitigationActionsTasksResponse_tasks :: Lens' ListDetectMitigationActionsTasksResponse (Maybe [DetectMitigationActionsTaskSummary]) Source #

The collection of ML Detect mitigation tasks that matched the filter criteria.

listDetectMitigationActionsTasksResponse_httpStatus :: Lens' ListDetectMitigationActionsTasksResponse Int Source #

The response's http status code.

ListDimensions

listDimensions_maxResults :: Lens' ListDimensions (Maybe Natural) Source #

The maximum number of results to retrieve at one time.

listDimensions_nextToken :: Lens' ListDimensions (Maybe Text) Source #

The token for the next set of results.

listDimensionsResponse_dimensionNames :: Lens' ListDimensionsResponse (Maybe [Text]) Source #

A list of the names of the defined dimensions. Use DescribeDimension to get details for a dimension.

listDimensionsResponse_nextToken :: Lens' ListDimensionsResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listDimensionsResponse_httpStatus :: Lens' ListDimensionsResponse Int Source #

The response's http status code.

ListDomainConfigurations

listDomainConfigurations_marker :: Lens' ListDomainConfigurations (Maybe Text) Source #

The marker for the next set of results.

listDomainConfigurations_pageSize :: Lens' ListDomainConfigurations (Maybe Natural) Source #

The result page size.

listDomainConfigurations_serviceType :: Lens' ListDomainConfigurations (Maybe ServiceType) Source #

The type of service delivered by the endpoint.

listDomainConfigurationsResponse_domainConfigurations :: Lens' ListDomainConfigurationsResponse (Maybe [DomainConfigurationSummary]) Source #

A list of objects that contain summary information about the user's domain configurations.

listDomainConfigurationsResponse_nextMarker :: Lens' ListDomainConfigurationsResponse (Maybe Text) Source #

The marker for the next set of results.

listDomainConfigurationsResponse_httpStatus :: Lens' ListDomainConfigurationsResponse Int Source #

The response's http status code.

ListFleetMetrics

listFleetMetrics_maxResults :: Lens' ListFleetMetrics (Maybe Natural) Source #

The maximum number of results to return in this operation.

listFleetMetrics_nextToken :: Lens' ListFleetMetrics (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listFleetMetricsResponse_fleetMetrics :: Lens' ListFleetMetricsResponse (Maybe [FleetMetricNameAndArn]) Source #

The list of fleet metrics objects.

listFleetMetricsResponse_nextToken :: Lens' ListFleetMetricsResponse (Maybe Text) Source #

The token for the next set of results. Will not be returned if the operation has returned all results.

listFleetMetricsResponse_httpStatus :: Lens' ListFleetMetricsResponse Int Source #

The response's http status code.

ListIndices

listIndices_maxResults :: Lens' ListIndices (Maybe Natural) Source #

The maximum number of results to return at one time.

listIndices_nextToken :: Lens' ListIndices (Maybe Text) Source #

The token used to get the next set of results, or null if there are no additional results.

listIndicesResponse_indexNames :: Lens' ListIndicesResponse (Maybe [Text]) Source #

The index names.

listIndicesResponse_nextToken :: Lens' ListIndicesResponse (Maybe Text) Source #

The token used to get the next set of results, or null if there are no additional results.

listIndicesResponse_httpStatus :: Lens' ListIndicesResponse Int Source #

The response's http status code.

ListJobExecutionsForJob

listJobExecutionsForJob_maxResults :: Lens' ListJobExecutionsForJob (Maybe Natural) Source #

The maximum number of results to be returned per request.

listJobExecutionsForJob_nextToken :: Lens' ListJobExecutionsForJob (Maybe Text) Source #

The token to retrieve the next set of results.

listJobExecutionsForJob_status :: Lens' ListJobExecutionsForJob (Maybe JobExecutionStatus) Source #

The status of the job.

listJobExecutionsForJob_jobId :: Lens' ListJobExecutionsForJob Text Source #

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

listJobExecutionsForJobResponse_executionSummaries :: Lens' ListJobExecutionsForJobResponse (Maybe [JobExecutionSummaryForJob]) Source #

A list of job execution summaries.

listJobExecutionsForJobResponse_nextToken :: Lens' ListJobExecutionsForJobResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

listJobExecutionsForJobResponse_httpStatus :: Lens' ListJobExecutionsForJobResponse Int Source #

The response's http status code.

ListJobExecutionsForThing

listJobExecutionsForThing_jobId :: Lens' ListJobExecutionsForThing (Maybe Text) Source #

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

listJobExecutionsForThing_maxResults :: Lens' ListJobExecutionsForThing (Maybe Natural) Source #

The maximum number of results to be returned per request.

listJobExecutionsForThing_namespaceId :: Lens' ListJobExecutionsForThing (Maybe Text) Source #

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.

listJobExecutionsForThing_nextToken :: Lens' ListJobExecutionsForThing (Maybe Text) Source #

The token to retrieve the next set of results.

listJobExecutionsForThing_status :: Lens' ListJobExecutionsForThing (Maybe JobExecutionStatus) Source #

An optional filter that lets you search for jobs that have the specified status.

listJobExecutionsForThing_thingName :: Lens' ListJobExecutionsForThing Text Source #

The thing name.

listJobExecutionsForThingResponse_executionSummaries :: Lens' ListJobExecutionsForThingResponse (Maybe [JobExecutionSummaryForThing]) Source #

A list of job execution summaries.

listJobExecutionsForThingResponse_nextToken :: Lens' ListJobExecutionsForThingResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

listJobExecutionsForThingResponse_httpStatus :: Lens' ListJobExecutionsForThingResponse Int Source #

The response's http status code.

ListJobTemplates

listJobTemplates_maxResults :: Lens' ListJobTemplates (Maybe Natural) Source #

The maximum number of results to return in the list.

listJobTemplates_nextToken :: Lens' ListJobTemplates (Maybe Text) Source #

The token to use to return the next set of results in the list.

listJobTemplatesResponse_jobTemplates :: Lens' ListJobTemplatesResponse (Maybe [JobTemplateSummary]) Source #

A list of objects that contain information about the job templates.

listJobTemplatesResponse_nextToken :: Lens' ListJobTemplatesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

listJobTemplatesResponse_httpStatus :: Lens' ListJobTemplatesResponse Int Source #

The response's http status code.

ListJobs

listJobs_maxResults :: Lens' ListJobs (Maybe Natural) Source #

The maximum number of results to return per request.

listJobs_namespaceId :: Lens' ListJobs (Maybe Text) Source #

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.

listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #

The token to retrieve the next set of results.

listJobs_status :: Lens' ListJobs (Maybe JobStatus) Source #

An optional filter that lets you search for jobs that have the specified status.

listJobs_targetSelection :: Lens' ListJobs (Maybe TargetSelection) Source #

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.

listJobs_thingGroupId :: Lens' ListJobs (Maybe Text) Source #

A filter that limits the returned jobs to those for the specified group.

listJobs_thingGroupName :: Lens' ListJobs (Maybe Text) Source #

A filter that limits the returned jobs to those for the specified group.

listJobsResponse_jobs :: Lens' ListJobsResponse (Maybe [JobSummary]) Source #

A list of jobs.

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int Source #

The response's http status code.

ListManagedJobTemplates

listManagedJobTemplates_maxResults :: Lens' ListManagedJobTemplates (Maybe Natural) Source #

Maximum number of entries that can be returned.

listManagedJobTemplates_nextToken :: Lens' ListManagedJobTemplates (Maybe Text) Source #

The token to retrieve the next set of results.

listManagedJobTemplates_templateName :: Lens' ListManagedJobTemplates (Maybe Text) Source #

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.

listManagedJobTemplatesResponse_managedJobTemplates :: Lens' ListManagedJobTemplatesResponse (Maybe [ManagedJobTemplateSummary]) Source #

A list of managed job templates that are returned.

listManagedJobTemplatesResponse_nextToken :: Lens' ListManagedJobTemplatesResponse (Maybe Text) Source #

The token to retrieve the next set of results.

listManagedJobTemplatesResponse_httpStatus :: Lens' ListManagedJobTemplatesResponse Int Source #

The response's http status code.

ListMetricValues

listMetricValues_dimensionName :: Lens' ListMetricValues (Maybe Text) Source #

The dimension name.

listMetricValues_dimensionValueOperator :: Lens' ListMetricValues (Maybe DimensionValueOperator) Source #

The dimension value operator.

listMetricValues_maxResults :: Lens' ListMetricValues (Maybe Natural) Source #

The maximum number of results to return at one time.

listMetricValues_nextToken :: Lens' ListMetricValues (Maybe Text) Source #

The token for the next set of results.

listMetricValues_thingName :: Lens' ListMetricValues Text Source #

The name of the thing for which security profile metric values are returned.

listMetricValues_metricName :: Lens' ListMetricValues Text Source #

The name of the security profile metric for which values are returned.

listMetricValues_startTime :: Lens' ListMetricValues UTCTime Source #

The start of the time period for which metric values are returned.

listMetricValues_endTime :: Lens' ListMetricValues UTCTime Source #

The end of the time period for which metric values are returned.

listMetricValuesResponse_metricDatumList :: Lens' ListMetricValuesResponse (Maybe [MetricDatum]) Source #

The data the thing reports for the metric during the specified time period.

listMetricValuesResponse_nextToken :: Lens' ListMetricValuesResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listMetricValuesResponse_httpStatus :: Lens' ListMetricValuesResponse Int Source #

The response's http status code.

ListMitigationActions

listMitigationActions_actionType :: Lens' ListMitigationActions (Maybe MitigationActionType) Source #

Specify a value to limit the result to mitigation actions with a specific action type.

listMitigationActions_maxResults :: Lens' ListMitigationActions (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listMitigationActions_nextToken :: Lens' ListMitigationActions (Maybe Text) Source #

The token for the next set of results.

listMitigationActionsResponse_actionIdentifiers :: Lens' ListMitigationActionsResponse (Maybe [MitigationActionIdentifier]) Source #

A set of actions that matched the specified filter criteria.

listMitigationActionsResponse_nextToken :: Lens' ListMitigationActionsResponse (Maybe Text) Source #

The token for the next set of results.

listMitigationActionsResponse_httpStatus :: Lens' ListMitigationActionsResponse Int Source #

The response's http status code.

ListOTAUpdates

listOTAUpdates_maxResults :: Lens' ListOTAUpdates (Maybe Natural) Source #

The maximum number of results to return at one time.

listOTAUpdates_nextToken :: Lens' ListOTAUpdates (Maybe Text) Source #

A token used to retrieve the next set of results.

listOTAUpdates_otaUpdateStatus :: Lens' ListOTAUpdates (Maybe OTAUpdateStatus) Source #

The OTA update job status.

listOTAUpdatesResponse_nextToken :: Lens' ListOTAUpdatesResponse (Maybe Text) Source #

A token to use to get the next set of results.

listOTAUpdatesResponse_otaUpdates :: Lens' ListOTAUpdatesResponse (Maybe [OTAUpdateSummary]) Source #

A list of OTA update jobs.

listOTAUpdatesResponse_httpStatus :: Lens' ListOTAUpdatesResponse Int Source #

The response's http status code.

ListOutgoingCertificates

listOutgoingCertificates_ascendingOrder :: Lens' ListOutgoingCertificates (Maybe Bool) Source #

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

listOutgoingCertificates_marker :: Lens' ListOutgoingCertificates (Maybe Text) Source #

The marker for the next set of results.

listOutgoingCertificates_pageSize :: Lens' ListOutgoingCertificates (Maybe Natural) Source #

The result page size.

listOutgoingCertificatesResponse_nextMarker :: Lens' ListOutgoingCertificatesResponse (Maybe Text) Source #

The marker for the next set of results.

listOutgoingCertificatesResponse_outgoingCertificates :: Lens' ListOutgoingCertificatesResponse (Maybe [OutgoingCertificate]) Source #

The certificates that are being transferred but not yet accepted.

listOutgoingCertificatesResponse_httpStatus :: Lens' ListOutgoingCertificatesResponse Int Source #

The response's http status code.

ListPolicies

listPolicies_ascendingOrder :: Lens' ListPolicies (Maybe Bool) Source #

Specifies the order for results. If true, the results are returned in ascending creation order.

listPolicies_marker :: Lens' ListPolicies (Maybe Text) Source #

The marker for the next set of results.

listPolicies_pageSize :: Lens' ListPolicies (Maybe Natural) Source #

The result page size.

listPoliciesResponse_nextMarker :: Lens' ListPoliciesResponse (Maybe Text) Source #

The marker for the next set of results, or null if there are no additional results.

listPoliciesResponse_policies :: Lens' ListPoliciesResponse (Maybe [Policy]) Source #

The descriptions of the policies.

listPoliciesResponse_httpStatus :: Lens' ListPoliciesResponse Int Source #

The response's http status code.

ListPolicyVersions

listPolicyVersions_policyName :: Lens' ListPolicyVersions Text Source #

The policy name.

listPolicyVersionsResponse_policyVersions :: Lens' ListPolicyVersionsResponse (Maybe [PolicyVersion]) Source #

The policy versions.

listPolicyVersionsResponse_httpStatus :: Lens' ListPolicyVersionsResponse Int Source #

The response's http status code.

ListPrincipalThings

listPrincipalThings_maxResults :: Lens' ListPrincipalThings (Maybe Natural) Source #

The maximum number of results to return in this operation.

listPrincipalThings_nextToken :: Lens' ListPrincipalThings (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listPrincipalThings_principal :: Lens' ListPrincipalThings Text Source #

The principal.

listPrincipalThingsResponse_nextToken :: Lens' ListPrincipalThingsResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listPrincipalThingsResponse_things :: Lens' ListPrincipalThingsResponse (Maybe [Text]) Source #

The things.

listPrincipalThingsResponse_httpStatus :: Lens' ListPrincipalThingsResponse Int Source #

The response's http status code.

ListProvisioningTemplateVersions

listProvisioningTemplateVersions_maxResults :: Lens' ListProvisioningTemplateVersions (Maybe Natural) Source #

The maximum number of results to return at one time.

listProvisioningTemplateVersions_nextToken :: Lens' ListProvisioningTemplateVersions (Maybe Text) Source #

A token to retrieve the next set of results.

listProvisioningTemplateVersions_templateName :: Lens' ListProvisioningTemplateVersions Text Source #

The name of the provisioning template.

listProvisioningTemplateVersionsResponse_nextToken :: Lens' ListProvisioningTemplateVersionsResponse (Maybe Text) Source #

A token to retrieve the next set of results.

listProvisioningTemplateVersionsResponse_versions :: Lens' ListProvisioningTemplateVersionsResponse (Maybe [ProvisioningTemplateVersionSummary]) Source #

The list of provisioning template versions.

listProvisioningTemplateVersionsResponse_httpStatus :: Lens' ListProvisioningTemplateVersionsResponse Int Source #

The response's http status code.

ListProvisioningTemplates

listProvisioningTemplates_maxResults :: Lens' ListProvisioningTemplates (Maybe Natural) Source #

The maximum number of results to return at one time.

listProvisioningTemplates_nextToken :: Lens' ListProvisioningTemplates (Maybe Text) Source #

A token to retrieve the next set of results.

listProvisioningTemplatesResponse_nextToken :: Lens' ListProvisioningTemplatesResponse (Maybe Text) Source #

A token to retrieve the next set of results.

listProvisioningTemplatesResponse_templates :: Lens' ListProvisioningTemplatesResponse (Maybe [ProvisioningTemplateSummary]) Source #

A list of provisioning templates

listProvisioningTemplatesResponse_httpStatus :: Lens' ListProvisioningTemplatesResponse Int Source #

The response's http status code.

ListRelatedResourcesForAuditFinding

listRelatedResourcesForAuditFinding_maxResults :: Lens' ListRelatedResourcesForAuditFinding (Maybe Natural) Source #

The maximum number of results to return at one time.

listRelatedResourcesForAuditFinding_nextToken :: Lens' ListRelatedResourcesForAuditFinding (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listRelatedResourcesForAuditFinding_findingId :: Lens' ListRelatedResourcesForAuditFinding Text Source #

The finding Id.

listRelatedResourcesForAuditFindingResponse_nextToken :: Lens' ListRelatedResourcesForAuditFindingResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null for the first API call.

listRelatedResourcesForAuditFindingResponse_relatedResources :: Lens' ListRelatedResourcesForAuditFindingResponse (Maybe [RelatedResource]) Source #

The related resources.

listRelatedResourcesForAuditFindingResponse_httpStatus :: Lens' ListRelatedResourcesForAuditFindingResponse Int Source #

The response's http status code.

ListRoleAliases

listRoleAliases_ascendingOrder :: Lens' ListRoleAliases (Maybe Bool) Source #

Return the list of role aliases in ascending alphabetical order.

listRoleAliases_marker :: Lens' ListRoleAliases (Maybe Text) Source #

A marker used to get the next set of results.

listRoleAliases_pageSize :: Lens' ListRoleAliases (Maybe Natural) Source #

The maximum number of results to return at one time.

listRoleAliasesResponse_nextMarker :: Lens' ListRoleAliasesResponse (Maybe Text) Source #

A marker used to get the next set of results.

listRoleAliasesResponse_roleAliases :: Lens' ListRoleAliasesResponse (Maybe [Text]) Source #

The role aliases.

listRoleAliasesResponse_httpStatus :: Lens' ListRoleAliasesResponse Int Source #

The response's http status code.

ListScheduledAudits

listScheduledAudits_maxResults :: Lens' ListScheduledAudits (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listScheduledAudits_nextToken :: Lens' ListScheduledAudits (Maybe Text) Source #

The token for the next set of results.

listScheduledAuditsResponse_nextToken :: Lens' ListScheduledAuditsResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listScheduledAuditsResponse_scheduledAudits :: Lens' ListScheduledAuditsResponse (Maybe [ScheduledAuditMetadata]) Source #

The list of scheduled audits.

listScheduledAuditsResponse_httpStatus :: Lens' ListScheduledAuditsResponse Int Source #

The response's http status code.

ListSecurityProfiles

listSecurityProfiles_dimensionName :: Lens' ListSecurityProfiles (Maybe Text) Source #

A filter to limit results to the security profiles that use the defined dimension. Cannot be used with metricName

listSecurityProfiles_maxResults :: Lens' ListSecurityProfiles (Maybe Natural) Source #

The maximum number of results to return at one time.

listSecurityProfiles_metricName :: Lens' ListSecurityProfiles (Maybe Text) Source #

The name of the custom metric. Cannot be used with dimensionName.

listSecurityProfiles_nextToken :: Lens' ListSecurityProfiles (Maybe Text) Source #

The token for the next set of results.

listSecurityProfilesResponse_nextToken :: Lens' ListSecurityProfilesResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listSecurityProfilesResponse_securityProfileIdentifiers :: Lens' ListSecurityProfilesResponse (Maybe [SecurityProfileIdentifier]) Source #

A list of security profile identifiers (names and ARNs).

listSecurityProfilesResponse_httpStatus :: Lens' ListSecurityProfilesResponse Int Source #

The response's http status code.

ListSecurityProfilesForTarget

listSecurityProfilesForTarget_maxResults :: Lens' ListSecurityProfilesForTarget (Maybe Natural) Source #

The maximum number of results to return at one time.

listSecurityProfilesForTarget_nextToken :: Lens' ListSecurityProfilesForTarget (Maybe Text) Source #

The token for the next set of results.

listSecurityProfilesForTarget_recursive :: Lens' ListSecurityProfilesForTarget (Maybe Bool) Source #

If true, return child groups too.

listSecurityProfilesForTarget_securityProfileTargetArn :: Lens' ListSecurityProfilesForTarget Text Source #

The ARN of the target (thing group) whose attached security profiles you want to get.

listSecurityProfilesForTargetResponse_nextToken :: Lens' ListSecurityProfilesForTargetResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listSecurityProfilesForTargetResponse_securityProfileTargetMappings :: Lens' ListSecurityProfilesForTargetResponse (Maybe [SecurityProfileTargetMapping]) Source #

A list of security profiles and their associated targets.

listSecurityProfilesForTargetResponse_httpStatus :: Lens' ListSecurityProfilesForTargetResponse Int Source #

The response's http status code.

ListStreams

listStreams_ascendingOrder :: Lens' ListStreams (Maybe Bool) Source #

Set to true to return the list of streams in ascending order.

listStreams_maxResults :: Lens' ListStreams (Maybe Natural) Source #

The maximum number of results to return at a time.

listStreams_nextToken :: Lens' ListStreams (Maybe Text) Source #

A token used to get the next set of results.

listStreamsResponse_nextToken :: Lens' ListStreamsResponse (Maybe Text) Source #

A token used to get the next set of results.

listStreamsResponse_streams :: Lens' ListStreamsResponse (Maybe [StreamSummary]) Source #

A list of streams.

listStreamsResponse_httpStatus :: Lens' ListStreamsResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The ARN of the resource.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

The list of tags assigned to the resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ListTargetsForPolicy

listTargetsForPolicy_marker :: Lens' ListTargetsForPolicy (Maybe Text) Source #

A marker used to get the next set of results.

listTargetsForPolicy_pageSize :: Lens' ListTargetsForPolicy (Maybe Natural) Source #

The maximum number of results to return at one time.

listTargetsForPolicy_policyName :: Lens' ListTargetsForPolicy Text Source #

The policy name.

listTargetsForPolicyResponse_nextMarker :: Lens' ListTargetsForPolicyResponse (Maybe Text) Source #

A marker used to get the next set of results.

listTargetsForPolicyResponse_targets :: Lens' ListTargetsForPolicyResponse (Maybe [Text]) Source #

The policy targets.

listTargetsForPolicyResponse_httpStatus :: Lens' ListTargetsForPolicyResponse Int Source #

The response's http status code.

ListTargetsForSecurityProfile

listTargetsForSecurityProfile_maxResults :: Lens' ListTargetsForSecurityProfile (Maybe Natural) Source #

The maximum number of results to return at one time.

listTargetsForSecurityProfile_nextToken :: Lens' ListTargetsForSecurityProfile (Maybe Text) Source #

The token for the next set of results.

listTargetsForSecurityProfile_securityProfileName :: Lens' ListTargetsForSecurityProfile Text Source #

The security profile.

listTargetsForSecurityProfileResponse_nextToken :: Lens' ListTargetsForSecurityProfileResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listTargetsForSecurityProfileResponse_securityProfileTargets :: Lens' ListTargetsForSecurityProfileResponse (Maybe [SecurityProfileTarget]) Source #

The thing groups to which the security profile is attached.

listTargetsForSecurityProfileResponse_httpStatus :: Lens' ListTargetsForSecurityProfileResponse Int Source #

The response's http status code.

ListThingGroups

listThingGroups_maxResults :: Lens' ListThingGroups (Maybe Natural) Source #

The maximum number of results to return at one time.

listThingGroups_namePrefixFilter :: Lens' ListThingGroups (Maybe Text) Source #

A filter that limits the results to those with the specified name prefix.

listThingGroups_nextToken :: Lens' ListThingGroups (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThingGroups_parentGroup :: Lens' ListThingGroups (Maybe Text) Source #

A filter that limits the results to those with the specified parent group.

listThingGroups_recursive :: Lens' ListThingGroups (Maybe Bool) Source #

If true, return child groups as well.

listThingGroupsResponse_nextToken :: Lens' ListThingGroupsResponse (Maybe Text) Source #

The token to use to get the next set of results. Will not be returned if operation has returned all results.

listThingGroupsResponse_thingGroups :: Lens' ListThingGroupsResponse (Maybe [GroupNameAndArn]) Source #

The thing groups.

listThingGroupsResponse_httpStatus :: Lens' ListThingGroupsResponse Int Source #

The response's http status code.

ListThingGroupsForThing

listThingGroupsForThing_maxResults :: Lens' ListThingGroupsForThing (Maybe Natural) Source #

The maximum number of results to return at one time.

listThingGroupsForThing_nextToken :: Lens' ListThingGroupsForThing (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThingGroupsForThing_thingName :: Lens' ListThingGroupsForThing Text Source #

The thing name.

listThingGroupsForThingResponse_nextToken :: Lens' ListThingGroupsForThingResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listThingGroupsForThingResponse_thingGroups :: Lens' ListThingGroupsForThingResponse (Maybe [GroupNameAndArn]) Source #

The thing groups.

listThingGroupsForThingResponse_httpStatus :: Lens' ListThingGroupsForThingResponse Int Source #

The response's http status code.

ListThingPrincipals

listThingPrincipals_maxResults :: Lens' ListThingPrincipals (Maybe Natural) Source #

The maximum number of results to return in this operation.

listThingPrincipals_nextToken :: Lens' ListThingPrincipals (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThingPrincipals_thingName :: Lens' ListThingPrincipals Text Source #

The name of the thing.

listThingPrincipalsResponse_nextToken :: Lens' ListThingPrincipalsResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listThingPrincipalsResponse_principals :: Lens' ListThingPrincipalsResponse (Maybe [Text]) Source #

The principals associated with the thing.

listThingPrincipalsResponse_httpStatus :: Lens' ListThingPrincipalsResponse Int Source #

The response's http status code.

ListThingRegistrationTaskReports

listThingRegistrationTaskReports_maxResults :: Lens' ListThingRegistrationTaskReports (Maybe Natural) Source #

The maximum number of results to return per request.

listThingRegistrationTaskReports_nextToken :: Lens' ListThingRegistrationTaskReports (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThingRegistrationTaskReports_taskId :: Lens' ListThingRegistrationTaskReports Text Source #

The id of the task.

listThingRegistrationTaskReports_reportType :: Lens' ListThingRegistrationTaskReports ReportType Source #

The type of task report.

listThingRegistrationTaskReportsResponse_nextToken :: Lens' ListThingRegistrationTaskReportsResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listThingRegistrationTaskReportsResponse_reportType :: Lens' ListThingRegistrationTaskReportsResponse (Maybe ReportType) Source #

The type of task report.

listThingRegistrationTaskReportsResponse_resourceLinks :: Lens' ListThingRegistrationTaskReportsResponse (Maybe [Text]) Source #

Links to the task resources.

listThingRegistrationTaskReportsResponse_httpStatus :: Lens' ListThingRegistrationTaskReportsResponse Int Source #

The response's http status code.

ListThingRegistrationTasks

listThingRegistrationTasks_maxResults :: Lens' ListThingRegistrationTasks (Maybe Natural) Source #

The maximum number of results to return at one time.

listThingRegistrationTasks_nextToken :: Lens' ListThingRegistrationTasks (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThingRegistrationTasks_status :: Lens' ListThingRegistrationTasks (Maybe TaskStatus) Source #

The status of the bulk thing provisioning task.

listThingRegistrationTasksResponse_nextToken :: Lens' ListThingRegistrationTasksResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listThingRegistrationTasksResponse_taskIds :: Lens' ListThingRegistrationTasksResponse (Maybe [Text]) Source #

A list of bulk thing provisioning task IDs.

listThingRegistrationTasksResponse_httpStatus :: Lens' ListThingRegistrationTasksResponse Int Source #

The response's http status code.

ListThingTypes

listThingTypes_maxResults :: Lens' ListThingTypes (Maybe Natural) Source #

The maximum number of results to return in this operation.

listThingTypes_nextToken :: Lens' ListThingTypes (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThingTypes_thingTypeName :: Lens' ListThingTypes (Maybe Text) Source #

The name of the thing type.

listThingTypesResponse_nextToken :: Lens' ListThingTypesResponse (Maybe Text) Source #

The token for the next set of results. Will not be returned if operation has returned all results.

listThingTypesResponse_thingTypes :: Lens' ListThingTypesResponse (Maybe [ThingTypeDefinition]) Source #

The thing types.

listThingTypesResponse_httpStatus :: Lens' ListThingTypesResponse Int Source #

The response's http status code.

ListThings

listThings_attributeName :: Lens' ListThings (Maybe Text) Source #

The attribute name used to search for things.

listThings_attributeValue :: Lens' ListThings (Maybe Text) Source #

The attribute value used to search for things.

listThings_maxResults :: Lens' ListThings (Maybe Natural) Source #

The maximum number of results to return in this operation.

listThings_nextToken :: Lens' ListThings (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThings_thingTypeName :: Lens' ListThings (Maybe Text) Source #

The name of the thing type used to search for things.

listThings_usePrefixAttributeValue :: Lens' ListThings (Maybe Bool) Source #

When true, the action returns the thing resources with attribute values that start with the attributeValue provided.

When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.

listThingsResponse_nextToken :: Lens' ListThingsResponse (Maybe Text) Source #

The token to use to get the next set of results. Will not be returned if operation has returned all results.

listThingsResponse_things :: Lens' ListThingsResponse (Maybe [ThingAttribute]) Source #

The things.

listThingsResponse_httpStatus :: Lens' ListThingsResponse Int Source #

The response's http status code.

ListThingsInBillingGroup

listThingsInBillingGroup_maxResults :: Lens' ListThingsInBillingGroup (Maybe Natural) Source #

The maximum number of results to return per request.

listThingsInBillingGroup_nextToken :: Lens' ListThingsInBillingGroup (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThingsInBillingGroup_billingGroupName :: Lens' ListThingsInBillingGroup Text Source #

The name of the billing group.

listThingsInBillingGroupResponse_nextToken :: Lens' ListThingsInBillingGroupResponse (Maybe Text) Source #

The token to use to get the next set of results. Will not be returned if operation has returned all results.

listThingsInBillingGroupResponse_things :: Lens' ListThingsInBillingGroupResponse (Maybe [Text]) Source #

A list of things in the billing group.

listThingsInBillingGroupResponse_httpStatus :: Lens' ListThingsInBillingGroupResponse Int Source #

The response's http status code.

ListThingsInThingGroup

listThingsInThingGroup_maxResults :: Lens' ListThingsInThingGroup (Maybe Natural) Source #

The maximum number of results to return at one time.

listThingsInThingGroup_nextToken :: Lens' ListThingsInThingGroup (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThingsInThingGroup_recursive :: Lens' ListThingsInThingGroup (Maybe Bool) Source #

When true, list things in this thing group and in all child groups as well.

listThingsInThingGroup_thingGroupName :: Lens' ListThingsInThingGroup Text Source #

The thing group name.

listThingsInThingGroupResponse_nextToken :: Lens' ListThingsInThingGroupResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listThingsInThingGroupResponse_things :: Lens' ListThingsInThingGroupResponse (Maybe [Text]) Source #

The things in the specified thing group.

listThingsInThingGroupResponse_httpStatus :: Lens' ListThingsInThingGroupResponse Int Source #

The response's http status code.

ListTopicRuleDestinations

listTopicRuleDestinations_maxResults :: Lens' ListTopicRuleDestinations (Maybe Natural) Source #

The maximum number of results to return at one time.

listTopicRuleDestinations_nextToken :: Lens' ListTopicRuleDestinations (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listTopicRuleDestinationsResponse_destinationSummaries :: Lens' ListTopicRuleDestinationsResponse (Maybe [TopicRuleDestinationSummary]) Source #

Information about a topic rule destination.

listTopicRuleDestinationsResponse_nextToken :: Lens' ListTopicRuleDestinationsResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listTopicRuleDestinationsResponse_httpStatus :: Lens' ListTopicRuleDestinationsResponse Int Source #

The response's http status code.

ListTopicRules

listTopicRules_maxResults :: Lens' ListTopicRules (Maybe Natural) Source #

The maximum number of results to return.

listTopicRules_nextToken :: Lens' ListTopicRules (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listTopicRules_ruleDisabled :: Lens' ListTopicRules (Maybe Bool) Source #

Specifies whether the rule is disabled.

listTopicRules_topic :: Lens' ListTopicRules (Maybe Text) Source #

The topic.

listTopicRulesResponse_nextToken :: Lens' ListTopicRulesResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listTopicRulesResponse_rules :: Lens' ListTopicRulesResponse (Maybe [TopicRuleListItem]) Source #

The rules.

listTopicRulesResponse_httpStatus :: Lens' ListTopicRulesResponse Int Source #

The response's http status code.

ListV2LoggingLevels

listV2LoggingLevels_maxResults :: Lens' ListV2LoggingLevels (Maybe Natural) Source #

The maximum number of results to return at one time.

listV2LoggingLevels_nextToken :: Lens' ListV2LoggingLevels (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listV2LoggingLevels_targetType :: Lens' ListV2LoggingLevels (Maybe LogTargetType) Source #

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

listV2LoggingLevelsResponse_logTargetConfigurations :: Lens' ListV2LoggingLevelsResponse (Maybe [LogTargetConfiguration]) Source #

The logging configuration for a target.

listV2LoggingLevelsResponse_nextToken :: Lens' ListV2LoggingLevelsResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listV2LoggingLevelsResponse_httpStatus :: Lens' ListV2LoggingLevelsResponse Int Source #

The response's http status code.

ListViolationEvents

listViolationEvents_behaviorCriteriaType :: Lens' ListViolationEvents (Maybe BehaviorCriteriaType) Source #

The criteria for a behavior.

listViolationEvents_listSuppressedAlerts :: Lens' ListViolationEvents (Maybe Bool) Source #

A list of all suppressed alerts.

listViolationEvents_maxResults :: Lens' ListViolationEvents (Maybe Natural) Source #

The maximum number of results to return at one time.

listViolationEvents_nextToken :: Lens' ListViolationEvents (Maybe Text) Source #

The token for the next set of results.

listViolationEvents_securityProfileName :: Lens' ListViolationEvents (Maybe Text) Source #

A filter to limit results to those alerts generated by the specified security profile.

listViolationEvents_thingName :: Lens' ListViolationEvents (Maybe Text) Source #

A filter to limit results to those alerts caused by the specified thing.

listViolationEvents_verificationState :: Lens' ListViolationEvents (Maybe VerificationState) Source #

The verification state of the violation (detect alarm).

listViolationEvents_startTime :: Lens' ListViolationEvents UTCTime Source #

The start time for the alerts to be listed.

listViolationEvents_endTime :: Lens' ListViolationEvents UTCTime Source #

The end time for the alerts to be listed.

listViolationEventsResponse_nextToken :: Lens' ListViolationEventsResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listViolationEventsResponse_violationEvents :: Lens' ListViolationEventsResponse (Maybe [ViolationEvent]) Source #

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.

listViolationEventsResponse_httpStatus :: Lens' ListViolationEventsResponse Int Source #

The response's http status code.

PutVerificationStateOnViolation

putVerificationStateOnViolation_verificationStateDescription :: Lens' PutVerificationStateOnViolation (Maybe Text) Source #

The description of the verification state of the violation (detect alarm).

putVerificationStateOnViolation_violationId :: Lens' PutVerificationStateOnViolation Text Source #

The violation ID.

putVerificationStateOnViolation_verificationState :: Lens' PutVerificationStateOnViolation VerificationState Source #

The verification state of the violation.

putVerificationStateOnViolationResponse_httpStatus :: Lens' PutVerificationStateOnViolationResponse Int Source #

The response's http status code.

RegisterCACertificate

registerCACertificate_allowAutoRegistration :: Lens' RegisterCACertificate (Maybe Bool) Source #

Allows this CA certificate to be used for auto registration of device certificates.

registerCACertificate_certificateMode :: Lens' RegisterCACertificate (Maybe CertificateMode) Source #

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

registerCACertificate_registrationConfig :: Lens' RegisterCACertificate (Maybe RegistrationConfig) Source #

Information about the registration configuration.

registerCACertificate_setAsActive :: Lens' RegisterCACertificate (Maybe Bool) Source #

A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

registerCACertificate_tags :: Lens' RegisterCACertificate (Maybe [Tag]) Source #

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..."

registerCACertificate_verificationCertificate :: Lens' RegisterCACertificate (Maybe Text) Source #

The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

registerCACertificate_caCertificate :: Lens' RegisterCACertificate Text Source #

The CA certificate.

registerCACertificateResponse_certificateArn :: Lens' RegisterCACertificateResponse (Maybe Text) Source #

The CA certificate ARN.

registerCACertificateResponse_certificateId :: Lens' RegisterCACertificateResponse (Maybe Text) Source #

The CA certificate identifier.

registerCACertificateResponse_httpStatus :: Lens' RegisterCACertificateResponse Int Source #

The response's http status code.

RegisterCertificate

registerCertificate_caCertificatePem :: Lens' RegisterCertificate (Maybe Text) Source #

The CA certificate used to sign the device certificate being registered.

registerCertificate_setAsActive :: Lens' RegisterCertificate (Maybe Bool) Source #

A boolean value that specifies if the certificate is set to active.

Valid values: ACTIVE | INACTIVE

registerCertificate_status :: Lens' RegisterCertificate (Maybe CertificateStatus) Source #

The status of the register certificate request. Valid values that you can use include ACTIVE, INACTIVE, and REVOKED.

registerCertificate_certificatePem :: Lens' RegisterCertificate Text Source #

The certificate data, in PEM format.

registerCertificateResponse_certificateArn :: Lens' RegisterCertificateResponse (Maybe Text) Source #

The certificate ARN.

registerCertificateResponse_certificateId :: Lens' RegisterCertificateResponse (Maybe Text) Source #

The certificate identifier.

registerCertificateResponse_httpStatus :: Lens' RegisterCertificateResponse Int Source #

The response's http status code.

RegisterCertificateWithoutCA

registerCertificateWithoutCA_status :: Lens' RegisterCertificateWithoutCA (Maybe CertificateStatus) Source #

The status of the register certificate request.

registerCertificateWithoutCA_certificatePem :: Lens' RegisterCertificateWithoutCA Text Source #

The certificate data, in PEM format.

registerCertificateWithoutCAResponse_certificateArn :: Lens' RegisterCertificateWithoutCAResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the registered certificate.

registerCertificateWithoutCAResponse_certificateId :: Lens' RegisterCertificateWithoutCAResponse (Maybe Text) Source #

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

registerCertificateWithoutCAResponse_httpStatus :: Lens' RegisterCertificateWithoutCAResponse Int Source #

The response's http status code.

RegisterThing

registerThing_parameters :: Lens' RegisterThing (Maybe (HashMap Text Text)) Source #

The parameters for provisioning a thing. See Provisioning Templates for more information.

registerThing_templateBody :: Lens' RegisterThing Text Source #

The provisioning template. See Provisioning Devices That Have Device Certificates for more information.

registerThingResponse_certificatePem :: Lens' RegisterThingResponse (Maybe Text) Source #

The certificate data, in PEM format.

registerThingResponse_resourceArns :: Lens' RegisterThingResponse (Maybe (HashMap Text Text)) Source #

ARNs for the generated resources.

registerThingResponse_httpStatus :: Lens' RegisterThingResponse Int Source #

The response's http status code.

RejectCertificateTransfer

rejectCertificateTransfer_rejectReason :: Lens' RejectCertificateTransfer (Maybe Text) Source #

The reason the certificate transfer was rejected.

rejectCertificateTransfer_certificateId :: Lens' RejectCertificateTransfer Text Source #

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

RemoveThingFromBillingGroup

removeThingFromBillingGroup_billingGroupArn :: Lens' RemoveThingFromBillingGroup (Maybe Text) Source #

The ARN of the billing group.

removeThingFromBillingGroup_billingGroupName :: Lens' RemoveThingFromBillingGroup (Maybe Text) Source #

The name of the billing group.

removeThingFromBillingGroup_thingArn :: Lens' RemoveThingFromBillingGroup (Maybe Text) Source #

The ARN of the thing to be removed from the billing group.

removeThingFromBillingGroup_thingName :: Lens' RemoveThingFromBillingGroup (Maybe Text) Source #

The name of the thing to be removed from the billing group.

removeThingFromBillingGroupResponse_httpStatus :: Lens' RemoveThingFromBillingGroupResponse Int Source #

The response's http status code.

RemoveThingFromThingGroup

removeThingFromThingGroup_thingArn :: Lens' RemoveThingFromThingGroup (Maybe Text) Source #

The ARN of the thing to remove from the group.

removeThingFromThingGroup_thingGroupArn :: Lens' RemoveThingFromThingGroup (Maybe Text) Source #

The group ARN.

removeThingFromThingGroup_thingGroupName :: Lens' RemoveThingFromThingGroup (Maybe Text) Source #

The group name.

removeThingFromThingGroup_thingName :: Lens' RemoveThingFromThingGroup (Maybe Text) Source #

The name of the thing to remove from the group.

removeThingFromThingGroupResponse_httpStatus :: Lens' RemoveThingFromThingGroupResponse Int Source #

The response's http status code.

ReplaceTopicRule

replaceTopicRule_ruleName :: Lens' ReplaceTopicRule Text Source #

The name of the rule.

replaceTopicRule_topicRulePayload :: Lens' ReplaceTopicRule TopicRulePayload Source #

The rule payload.

SearchIndex

searchIndex_indexName :: Lens' SearchIndex (Maybe Text) Source #

The search index name.

searchIndex_maxResults :: Lens' SearchIndex (Maybe Natural) Source #

The maximum number of results to return at one time.

searchIndex_nextToken :: Lens' SearchIndex (Maybe Text) Source #

The token used to get the next set of results, or null if there are no additional results.

searchIndex_queryVersion :: Lens' SearchIndex (Maybe Text) Source #

The query version.

searchIndex_queryString :: Lens' SearchIndex Text Source #

The search query string. For more information about the search query syntax, see Query syntax.

searchIndexResponse_nextToken :: Lens' SearchIndexResponse (Maybe Text) Source #

The token used to get the next set of results, or null if there are no additional results.

searchIndexResponse_thingGroups :: Lens' SearchIndexResponse (Maybe [ThingGroupDocument]) Source #

The thing groups that match the search query.

searchIndexResponse_things :: Lens' SearchIndexResponse (Maybe [ThingDocument]) Source #

The things that match the search query.

searchIndexResponse_httpStatus :: Lens' SearchIndexResponse Int Source #

The response's http status code.

SetDefaultAuthorizer

setDefaultAuthorizer_authorizerName :: Lens' SetDefaultAuthorizer Text Source #

The authorizer name.

setDefaultAuthorizerResponse_authorizerArn :: Lens' SetDefaultAuthorizerResponse (Maybe Text) Source #

The authorizer ARN.

setDefaultAuthorizerResponse_authorizerName :: Lens' SetDefaultAuthorizerResponse (Maybe Text) Source #

The authorizer name.

setDefaultAuthorizerResponse_httpStatus :: Lens' SetDefaultAuthorizerResponse Int Source #

The response's http status code.

SetDefaultPolicyVersion

setDefaultPolicyVersion_policyName :: Lens' SetDefaultPolicyVersion Text Source #

The policy name.

setDefaultPolicyVersion_policyVersionId :: Lens' SetDefaultPolicyVersion Text Source #

The policy version ID.

SetLoggingOptions

setLoggingOptions_loggingOptionsPayload :: Lens' SetLoggingOptions LoggingOptionsPayload Source #

The logging options payload.

SetV2LoggingLevel

setV2LoggingLevel_logTarget :: Lens' SetV2LoggingLevel LogTarget Source #

The log target.

setV2LoggingLevel_logLevel :: Lens' SetV2LoggingLevel LogLevel Source #

The log level.

SetV2LoggingOptions

setV2LoggingOptions_defaultLogLevel :: Lens' SetV2LoggingOptions (Maybe LogLevel) Source #

The default logging level.

setV2LoggingOptions_disableAllLogs :: Lens' SetV2LoggingOptions (Maybe Bool) Source #

If true all logs are disabled. The default is false.

setV2LoggingOptions_roleArn :: Lens' SetV2LoggingOptions (Maybe Text) Source #

The ARN of the role that allows IoT to write to Cloudwatch logs.

StartAuditMitigationActionsTask

startAuditMitigationActionsTask_taskId :: Lens' StartAuditMitigationActionsTask Text Source #

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

startAuditMitigationActionsTask_target :: Lens' StartAuditMitigationActionsTask AuditMitigationActionsTaskTarget Source #

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.

startAuditMitigationActionsTask_auditCheckToActionsMapping :: Lens' StartAuditMitigationActionsTask (HashMap Text (NonEmpty Text)) Source #

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

startAuditMitigationActionsTask_clientRequestToken :: Lens' StartAuditMitigationActionsTask Text Source #

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.

startAuditMitigationActionsTaskResponse_taskId :: Lens' StartAuditMitigationActionsTaskResponse (Maybe Text) Source #

The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

startAuditMitigationActionsTaskResponse_httpStatus :: Lens' StartAuditMitigationActionsTaskResponse Int Source #

The response's http status code.

StartDetectMitigationActionsTask

startDetectMitigationActionsTask_includeOnlyActiveViolations :: Lens' StartDetectMitigationActionsTask (Maybe Bool) Source #

Specifies to list only active violations.

startDetectMitigationActionsTask_includeSuppressedAlerts :: Lens' StartDetectMitigationActionsTask (Maybe Bool) Source #

Specifies to include suppressed alerts.

startDetectMitigationActionsTask_violationEventOccurrenceRange :: Lens' StartDetectMitigationActionsTask (Maybe ViolationEventOccurrenceRange) Source #

Specifies the time period of which violation events occurred between.

startDetectMitigationActionsTask_taskId :: Lens' StartDetectMitigationActionsTask Text Source #

The unique identifier of the task.

startDetectMitigationActionsTask_target :: Lens' StartDetectMitigationActionsTask DetectMitigationActionsTaskTarget Source #

Specifies the ML Detect findings to which the mitigation actions are applied.

startDetectMitigationActionsTask_actions :: Lens' StartDetectMitigationActionsTask (NonEmpty Text) Source #

The actions to be performed when a device has unexpected behavior.

startDetectMitigationActionsTask_clientRequestToken :: Lens' StartDetectMitigationActionsTask Text Source #

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.

startDetectMitigationActionsTaskResponse_taskId :: Lens' StartDetectMitigationActionsTaskResponse (Maybe Text) Source #

The unique identifier of the task.

startDetectMitigationActionsTaskResponse_httpStatus :: Lens' StartDetectMitigationActionsTaskResponse Int Source #

The response's http status code.

StartOnDemandAuditTask

startOnDemandAuditTask_targetCheckNames :: Lens' StartOnDemandAuditTask [Text] Source #

Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.

startOnDemandAuditTaskResponse_taskId :: Lens' StartOnDemandAuditTaskResponse (Maybe Text) Source #

The ID of the on-demand audit you started.

startOnDemandAuditTaskResponse_httpStatus :: Lens' StartOnDemandAuditTaskResponse Int Source #

The response's http status code.

StartThingRegistrationTask

startThingRegistrationTask_templateBody :: Lens' StartThingRegistrationTask Text Source #

The provisioning template.

startThingRegistrationTask_inputFileBucket :: Lens' StartThingRegistrationTask Text Source #

The S3 bucket that contains the input file.

startThingRegistrationTask_inputFileKey :: Lens' StartThingRegistrationTask Text Source #

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).

startThingRegistrationTask_roleArn :: Lens' StartThingRegistrationTask Text Source #

The IAM role ARN that grants permission the input file.

startThingRegistrationTaskResponse_taskId :: Lens' StartThingRegistrationTaskResponse (Maybe Text) Source #

The bulk thing provisioning task ID.

startThingRegistrationTaskResponse_httpStatus :: Lens' StartThingRegistrationTaskResponse Int Source #

The response's http status code.

StopThingRegistrationTask

stopThingRegistrationTask_taskId :: Lens' StopThingRegistrationTask Text Source #

The bulk thing provisioning task ID.

stopThingRegistrationTaskResponse_httpStatus :: Lens' StopThingRegistrationTaskResponse Int Source #

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The ARN of the resource.

tagResource_tags :: Lens' TagResource [Tag] Source #

The new or modified tags for the resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

TestAuthorization

testAuthorization_clientId :: Lens' TestAuthorization (Maybe Text) Source #

The MQTT client ID.

testAuthorization_cognitoIdentityPoolId :: Lens' TestAuthorization (Maybe Text) Source #

The Cognito identity pool ID.

testAuthorization_policyNamesToAdd :: Lens' TestAuthorization (Maybe [Text]) Source #

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

testAuthorization_policyNamesToSkip :: Lens' TestAuthorization (Maybe [Text]) Source #

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

testAuthorization_principal :: Lens' TestAuthorization (Maybe Text) Source #

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).

testAuthorization_authInfos :: Lens' TestAuthorization (NonEmpty AuthInfo) Source #

A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

testAuthorizationResponse_authResults :: Lens' TestAuthorizationResponse (Maybe [AuthResult]) Source #

The authentication results.

testAuthorizationResponse_httpStatus :: Lens' TestAuthorizationResponse Int Source #

The response's http status code.

TestInvokeAuthorizer

testInvokeAuthorizer_httpContext :: Lens' TestInvokeAuthorizer (Maybe HttpContext) Source #

Specifies a test HTTP authorization request.

testInvokeAuthorizer_mqttContext :: Lens' TestInvokeAuthorizer (Maybe MqttContext) Source #

Specifies a test MQTT authorization request.

testInvokeAuthorizer_tlsContext :: Lens' TestInvokeAuthorizer (Maybe TlsContext) Source #

Specifies a test TLS authorization request.

testInvokeAuthorizer_token :: Lens' TestInvokeAuthorizer (Maybe Text) Source #

The token returned by your custom authentication service.

testInvokeAuthorizer_tokenSignature :: Lens' TestInvokeAuthorizer (Maybe Text) Source #

The signature made with the token and your custom authentication service's private key. This value must be Base-64-encoded.

testInvokeAuthorizer_authorizerName :: Lens' TestInvokeAuthorizer Text Source #

The custom authorizer name.

testInvokeAuthorizerResponse_disconnectAfterInSeconds :: Lens' TestInvokeAuthorizerResponse (Maybe Int) Source #

The number of seconds after which the connection is terminated.

testInvokeAuthorizerResponse_isAuthenticated :: Lens' TestInvokeAuthorizerResponse (Maybe Bool) Source #

True if the token is authenticated, otherwise false.

testInvokeAuthorizerResponse_policyDocuments :: Lens' TestInvokeAuthorizerResponse (Maybe [Text]) Source #

IAM policy documents.

testInvokeAuthorizerResponse_principalId :: Lens' TestInvokeAuthorizerResponse (Maybe Text) Source #

The principal ID.

testInvokeAuthorizerResponse_refreshAfterInSeconds :: Lens' TestInvokeAuthorizerResponse (Maybe Int) Source #

The number of seconds after which the temporary credentials are refreshed.

testInvokeAuthorizerResponse_httpStatus :: Lens' TestInvokeAuthorizerResponse Int Source #

The response's http status code.

TransferCertificate

transferCertificate_transferMessage :: Lens' TransferCertificate (Maybe Text) Source #

The transfer message.

transferCertificate_certificateId :: Lens' TransferCertificate Text Source #

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

transferCertificate_targetAwsAccount :: Lens' TransferCertificate Text Source #

The Amazon Web Services account.

transferCertificateResponse_transferredCertificateArn :: Lens' TransferCertificateResponse (Maybe Text) Source #

The ARN of the certificate.

transferCertificateResponse_httpStatus :: Lens' TransferCertificateResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The ARN of the resource.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of the keys of the tags to be removed from the resource.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateAccountAuditConfiguration

updateAccountAuditConfiguration_auditCheckConfigurations :: Lens' UpdateAccountAuditConfiguration (Maybe (HashMap Text AuditCheckConfiguration)) Source #

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.

updateAccountAuditConfiguration_auditNotificationTargetConfigurations :: Lens' UpdateAccountAuditConfiguration (Maybe (HashMap AuditNotificationType AuditNotificationTarget)) Source #

Information about the targets to which audit notifications are sent.

updateAccountAuditConfiguration_roleArn :: Lens' UpdateAccountAuditConfiguration (Maybe Text) Source #

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.

updateAccountAuditConfigurationResponse_httpStatus :: Lens' UpdateAccountAuditConfigurationResponse Int Source #

The response's http status code.

UpdateAuditSuppression

updateAuditSuppression_description :: Lens' UpdateAuditSuppression (Maybe Text) Source #

The description of the audit suppression.

updateAuditSuppression_expirationDate :: Lens' UpdateAuditSuppression (Maybe UTCTime) Source #

The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.

updateAuditSuppression_suppressIndefinitely :: Lens' UpdateAuditSuppression (Maybe Bool) Source #

Indicates whether a suppression should exist indefinitely or not.

updateAuditSuppression_checkName :: Lens' UpdateAuditSuppression Text Source #

Undocumented member.

updateAuditSuppression_resourceIdentifier :: Lens' UpdateAuditSuppression ResourceIdentifier Source #

Undocumented member.

updateAuditSuppressionResponse_httpStatus :: Lens' UpdateAuditSuppressionResponse Int Source #

The response's http status code.

UpdateAuthorizer

updateAuthorizer_authorizerFunctionArn :: Lens' UpdateAuthorizer (Maybe Text) Source #

The ARN of the authorizer's Lambda function.

updateAuthorizer_enableCachingForHttp :: Lens' UpdateAuthorizer (Maybe Bool) Source #

When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

updateAuthorizer_status :: Lens' UpdateAuthorizer (Maybe AuthorizerStatus) Source #

The status of the update authorizer request.

updateAuthorizer_tokenKeyName :: Lens' UpdateAuthorizer (Maybe Text) Source #

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

updateAuthorizer_tokenSigningPublicKeys :: Lens' UpdateAuthorizer (Maybe (HashMap Text Text)) Source #

The public keys used to verify the token signature.

updateAuthorizer_authorizerName :: Lens' UpdateAuthorizer Text Source #

The authorizer name.

updateAuthorizerResponse_authorizerArn :: Lens' UpdateAuthorizerResponse (Maybe Text) Source #

The authorizer ARN.

updateAuthorizerResponse_authorizerName :: Lens' UpdateAuthorizerResponse (Maybe Text) Source #

The authorizer name.

updateAuthorizerResponse_httpStatus :: Lens' UpdateAuthorizerResponse Int Source #

The response's http status code.

UpdateBillingGroup

updateBillingGroup_expectedVersion :: Lens' UpdateBillingGroup (Maybe Integer) Source #

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

updateBillingGroup_billingGroupName :: Lens' UpdateBillingGroup Text Source #

The name of the billing group.

updateBillingGroup_billingGroupProperties :: Lens' UpdateBillingGroup BillingGroupProperties Source #

The properties of the billing group.

updateBillingGroupResponse_version :: Lens' UpdateBillingGroupResponse (Maybe Integer) Source #

The latest version of the billing group.

updateBillingGroupResponse_httpStatus :: Lens' UpdateBillingGroupResponse Int Source #

The response's http status code.

UpdateCACertificate

updateCACertificate_newAutoRegistrationStatus :: Lens' UpdateCACertificate (Maybe AutoRegistrationStatus) Source #

The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".

updateCACertificate_newStatus :: Lens' UpdateCACertificate (Maybe CACertificateStatus) Source #

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

updateCACertificate_registrationConfig :: Lens' UpdateCACertificate (Maybe RegistrationConfig) Source #

Information about the registration configuration.

updateCACertificate_removeAutoRegistration :: Lens' UpdateCACertificate (Maybe Bool) Source #

If true, removes auto registration.

updateCACertificate_certificateId :: Lens' UpdateCACertificate Text Source #

The CA certificate identifier.

UpdateCertificate

updateCertificate_certificateId :: Lens' UpdateCertificate Text Source #

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

updateCertificate_newStatus :: Lens' UpdateCertificate CertificateStatus Source #

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.

UpdateCustomMetric

updateCustomMetric_metricName :: Lens' UpdateCustomMetric Text Source #

The name of the custom metric. Cannot be updated.

updateCustomMetric_displayName :: Lens' UpdateCustomMetric Text Source #

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.

updateCustomMetricResponse_creationDate :: Lens' UpdateCustomMetricResponse (Maybe UTCTime) Source #

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

updateCustomMetricResponse_displayName :: Lens' UpdateCustomMetricResponse (Maybe Text) Source #

A friendly name in the console for the custom metric

updateCustomMetricResponse_lastModifiedDate :: Lens' UpdateCustomMetricResponse (Maybe UTCTime) Source #

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

updateCustomMetricResponse_metricArn :: Lens' UpdateCustomMetricResponse (Maybe Text) Source #

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

updateCustomMetricResponse_metricName :: Lens' UpdateCustomMetricResponse (Maybe Text) Source #

The name of the custom metric.

updateCustomMetricResponse_metricType :: Lens' UpdateCustomMetricResponse (Maybe CustomMetricType) Source #

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.

updateCustomMetricResponse_httpStatus :: Lens' UpdateCustomMetricResponse Int Source #

The response's http status code.

UpdateDimension

updateDimension_name :: Lens' UpdateDimension Text Source #

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

updateDimension_stringValues :: Lens' UpdateDimension (NonEmpty Text) Source #

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/#").

updateDimensionResponse_arn :: Lens' UpdateDimensionResponse (Maybe Text) Source #

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

updateDimensionResponse_creationDate :: Lens' UpdateDimensionResponse (Maybe UTCTime) Source #

The date and time, in milliseconds since epoch, when the dimension was initially created.

updateDimensionResponse_lastModifiedDate :: Lens' UpdateDimensionResponse (Maybe UTCTime) Source #

The date and time, in milliseconds since epoch, when the dimension was most recently updated.

updateDimensionResponse_name :: Lens' UpdateDimensionResponse (Maybe Text) Source #

A unique identifier for the dimension.

updateDimensionResponse_stringValues :: Lens' UpdateDimensionResponse (Maybe (NonEmpty Text)) Source #

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.

updateDimensionResponse_type :: Lens' UpdateDimensionResponse (Maybe DimensionType) Source #

The type of the dimension.

updateDimensionResponse_httpStatus :: Lens' UpdateDimensionResponse Int Source #

The response's http status code.

UpdateDomainConfiguration

updateDomainConfiguration_authorizerConfig :: Lens' UpdateDomainConfiguration (Maybe AuthorizerConfig) Source #

An object that specifies the authorization service for a domain.

updateDomainConfiguration_domainConfigurationStatus :: Lens' UpdateDomainConfiguration (Maybe DomainConfigurationStatus) Source #

The status to which the domain configuration should be updated.

updateDomainConfiguration_removeAuthorizerConfig :: Lens' UpdateDomainConfiguration (Maybe Bool) Source #

Removes the authorization configuration from a domain.

updateDomainConfiguration_domainConfigurationName :: Lens' UpdateDomainConfiguration Text Source #

The name of the domain configuration to be updated.

updateDomainConfigurationResponse_domainConfigurationArn :: Lens' UpdateDomainConfigurationResponse (Maybe Text) Source #

The ARN of the domain configuration that was updated.

updateDomainConfigurationResponse_domainConfigurationName :: Lens' UpdateDomainConfigurationResponse (Maybe Text) Source #

The name of the domain configuration that was updated.

updateDomainConfigurationResponse_httpStatus :: Lens' UpdateDomainConfigurationResponse Int Source #

The response's http status code.

UpdateDynamicThingGroup

updateDynamicThingGroup_expectedVersion :: Lens' UpdateDynamicThingGroup (Maybe Integer) Source #

The expected version of the dynamic thing group to update.

updateDynamicThingGroup_indexName :: Lens' UpdateDynamicThingGroup (Maybe Text) Source #

The dynamic thing group index to update.

Currently one index is supported: AWS_Things.

updateDynamicThingGroup_queryString :: Lens' UpdateDynamicThingGroup (Maybe Text) Source #

The dynamic thing group search query string to update.

updateDynamicThingGroup_queryVersion :: Lens' UpdateDynamicThingGroup (Maybe Text) Source #

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.

updateDynamicThingGroup_thingGroupName :: Lens' UpdateDynamicThingGroup Text Source #

The name of the dynamic thing group to update.

updateDynamicThingGroup_thingGroupProperties :: Lens' UpdateDynamicThingGroup ThingGroupProperties Source #

The dynamic thing group properties to update.

updateDynamicThingGroupResponse_version :: Lens' UpdateDynamicThingGroupResponse (Maybe Integer) Source #

The dynamic thing group version.

updateDynamicThingGroupResponse_httpStatus :: Lens' UpdateDynamicThingGroupResponse Int Source #

The response's http status code.

UpdateEventConfigurations

updateEventConfigurations_eventConfigurations :: Lens' UpdateEventConfigurations (Maybe (HashMap EventType Configuration)) Source #

The new event configuration values.

updateEventConfigurationsResponse_httpStatus :: Lens' UpdateEventConfigurationsResponse Int Source #

The response's http status code.

UpdateFleetMetric

updateFleetMetric_aggregationField :: Lens' UpdateFleetMetric (Maybe Text) Source #

The field to aggregate.

updateFleetMetric_aggregationType :: Lens' UpdateFleetMetric (Maybe AggregationType) Source #

The type of the aggregation query.

updateFleetMetric_description :: Lens' UpdateFleetMetric (Maybe Text) Source #

The description of the fleet metric.

updateFleetMetric_expectedVersion :: Lens' UpdateFleetMetric (Maybe Integer) Source #

The expected version of the fleet metric record in the registry.

updateFleetMetric_period :: Lens' UpdateFleetMetric (Maybe Natural) Source #

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

updateFleetMetric_queryString :: Lens' UpdateFleetMetric (Maybe Text) Source #

The search query string.

updateFleetMetric_queryVersion :: Lens' UpdateFleetMetric (Maybe Text) Source #

The version of the query.

updateFleetMetric_unit :: Lens' UpdateFleetMetric (Maybe FleetMetricUnit) Source #

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

updateFleetMetric_metricName :: Lens' UpdateFleetMetric Text Source #

The name of the fleet metric to update.

updateFleetMetric_indexName :: Lens' UpdateFleetMetric Text Source #

The name of the index to search.

UpdateIndexingConfiguration

updateIndexingConfiguration_thingGroupIndexingConfiguration :: Lens' UpdateIndexingConfiguration (Maybe ThingGroupIndexingConfiguration) Source #

Thing group indexing configuration.

updateIndexingConfiguration_thingIndexingConfiguration :: Lens' UpdateIndexingConfiguration (Maybe ThingIndexingConfiguration) Source #

Thing indexing configuration.

updateIndexingConfigurationResponse_httpStatus :: Lens' UpdateIndexingConfigurationResponse Int Source #

The response's http status code.

UpdateJob

updateJob_abortConfig :: Lens' UpdateJob (Maybe AbortConfig) Source #

Allows you to create criteria to abort a job.

updateJob_description :: Lens' UpdateJob (Maybe Text) Source #

A short text description of the job.

updateJob_jobExecutionsRetryConfig :: Lens' UpdateJob (Maybe JobExecutionsRetryConfig) Source #

Allows you to create the criteria to retry a job.

updateJob_jobExecutionsRolloutConfig :: Lens' UpdateJob (Maybe JobExecutionsRolloutConfig) Source #

Allows you to create a staged rollout of the job.

updateJob_namespaceId :: Lens' UpdateJob (Maybe Text) Source #

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.

updateJob_presignedUrlConfig :: Lens' UpdateJob (Maybe PresignedUrlConfig) Source #

Configuration information for pre-signed S3 URLs.

updateJob_timeoutConfig :: Lens' UpdateJob (Maybe TimeoutConfig) Source #

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

updateJob_jobId :: Lens' UpdateJob Text Source #

The ID of the job to be updated.

UpdateMitigationAction

updateMitigationAction_actionParams :: Lens' UpdateMitigationAction (Maybe MitigationActionParams) Source #

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

updateMitigationAction_roleArn :: Lens' UpdateMitigationAction (Maybe Text) Source #

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

updateMitigationAction_actionName :: Lens' UpdateMitigationAction Text Source #

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.

updateMitigationActionResponse_actionArn :: Lens' UpdateMitigationActionResponse (Maybe Text) Source #

The ARN for the new mitigation action.

updateMitigationActionResponse_actionId :: Lens' UpdateMitigationActionResponse (Maybe Text) Source #

A unique identifier for the mitigation action.

updateMitigationActionResponse_httpStatus :: Lens' UpdateMitigationActionResponse Int Source #

The response's http status code.

UpdateProvisioningTemplate

updateProvisioningTemplate_defaultVersionId :: Lens' UpdateProvisioningTemplate (Maybe Int) Source #

The ID of the default provisioning template version.

updateProvisioningTemplate_description :: Lens' UpdateProvisioningTemplate (Maybe Text) Source #

The description of the provisioning template.

updateProvisioningTemplate_enabled :: Lens' UpdateProvisioningTemplate (Maybe Bool) Source #

True to enable the provisioning template, otherwise false.

updateProvisioningTemplate_preProvisioningHook :: Lens' UpdateProvisioningTemplate (Maybe ProvisioningHook) Source #

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

updateProvisioningTemplate_provisioningRoleArn :: Lens' UpdateProvisioningTemplate (Maybe Text) Source #

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

updateProvisioningTemplate_removePreProvisioningHook :: Lens' UpdateProvisioningTemplate (Maybe Bool) Source #

Removes pre-provisioning hook template.

updateProvisioningTemplate_templateName :: Lens' UpdateProvisioningTemplate Text Source #

The name of the provisioning template.

updateProvisioningTemplateResponse_httpStatus :: Lens' UpdateProvisioningTemplateResponse Int Source #

The response's http status code.

UpdateRoleAlias

updateRoleAlias_credentialDurationSeconds :: Lens' UpdateRoleAlias (Maybe Natural) Source #

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.

updateRoleAlias_roleArn :: Lens' UpdateRoleAlias (Maybe Text) Source #

The role ARN.

updateRoleAlias_roleAlias :: Lens' UpdateRoleAlias Text Source #

The role alias to update.

updateRoleAliasResponse_roleAlias :: Lens' UpdateRoleAliasResponse (Maybe Text) Source #

The role alias.

updateRoleAliasResponse_roleAliasArn :: Lens' UpdateRoleAliasResponse (Maybe Text) Source #

The role alias ARN.

updateRoleAliasResponse_httpStatus :: Lens' UpdateRoleAliasResponse Int Source #

The response's http status code.

UpdateScheduledAudit

updateScheduledAudit_dayOfMonth :: Lens' UpdateScheduledAudit (Maybe Text) Source #

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

updateScheduledAudit_dayOfWeek :: Lens' UpdateScheduledAudit (Maybe DayOfWeek) Source #

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

updateScheduledAudit_frequency :: Lens' UpdateScheduledAudit (Maybe AuditFrequency) Source #

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

updateScheduledAudit_targetCheckNames :: Lens' UpdateScheduledAudit (Maybe [Text]) Source #

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

updateScheduledAudit_scheduledAuditName :: Lens' UpdateScheduledAudit Text Source #

The name of the scheduled audit. (Max. 128 chars)

updateScheduledAuditResponse_scheduledAuditArn :: Lens' UpdateScheduledAuditResponse (Maybe Text) Source #

The ARN of the scheduled audit.

updateScheduledAuditResponse_httpStatus :: Lens' UpdateScheduledAuditResponse Int Source #

The response's http status code.

UpdateSecurityProfile

updateSecurityProfile_additionalMetricsToRetain :: Lens' UpdateSecurityProfile (Maybe [Text]) Source #

/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.

updateSecurityProfile_additionalMetricsToRetainV2 :: Lens' UpdateSecurityProfile (Maybe [MetricToRetain]) Source #

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.

updateSecurityProfile_alertTargets :: Lens' UpdateSecurityProfile (Maybe (HashMap AlertTargetType AlertTarget)) Source #

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

updateSecurityProfile_behaviors :: Lens' UpdateSecurityProfile (Maybe [Behavior]) Source #

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

updateSecurityProfile_deleteAdditionalMetricsToRetain :: Lens' UpdateSecurityProfile (Maybe Bool) Source #

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

updateSecurityProfile_deleteAlertTargets :: Lens' UpdateSecurityProfile (Maybe Bool) Source #

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

updateSecurityProfile_deleteBehaviors :: Lens' UpdateSecurityProfile (Maybe Bool) Source #

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

updateSecurityProfile_expectedVersion :: Lens' UpdateSecurityProfile (Maybe Integer) Source #

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.

updateSecurityProfile_securityProfileDescription :: Lens' UpdateSecurityProfile (Maybe Text) Source #

A description of the security profile.

updateSecurityProfile_securityProfileName :: Lens' UpdateSecurityProfile Text Source #

The name of the security profile you want to update.

updateSecurityProfileResponse_additionalMetricsToRetain :: Lens' UpdateSecurityProfileResponse (Maybe [Text]) Source #

/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.

updateSecurityProfileResponse_additionalMetricsToRetainV2 :: Lens' UpdateSecurityProfileResponse (Maybe [MetricToRetain]) Source #

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.

updateSecurityProfileResponse_alertTargets :: Lens' UpdateSecurityProfileResponse (Maybe (HashMap AlertTargetType AlertTarget)) Source #

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

updateSecurityProfileResponse_behaviors :: Lens' UpdateSecurityProfileResponse (Maybe [Behavior]) Source #

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

updateSecurityProfileResponse_creationDate :: Lens' UpdateSecurityProfileResponse (Maybe UTCTime) Source #

The time the security profile was created.

updateSecurityProfileResponse_lastModifiedDate :: Lens' UpdateSecurityProfileResponse (Maybe UTCTime) Source #

The time the security profile was last modified.

updateSecurityProfileResponse_securityProfileArn :: Lens' UpdateSecurityProfileResponse (Maybe Text) Source #

The ARN of the security profile that was updated.

updateSecurityProfileResponse_securityProfileDescription :: Lens' UpdateSecurityProfileResponse (Maybe Text) Source #

The description of the security profile.

updateSecurityProfileResponse_securityProfileName :: Lens' UpdateSecurityProfileResponse (Maybe Text) Source #

The name of the security profile that was updated.

updateSecurityProfileResponse_version :: Lens' UpdateSecurityProfileResponse (Maybe Integer) Source #

The updated version of the security profile.

updateSecurityProfileResponse_httpStatus :: Lens' UpdateSecurityProfileResponse Int Source #

The response's http status code.

UpdateStream

updateStream_description :: Lens' UpdateStream (Maybe Text) Source #

The description of the stream.

updateStream_files :: Lens' UpdateStream (Maybe (NonEmpty StreamFile)) Source #

The files associated with the stream.

updateStream_roleArn :: Lens' UpdateStream (Maybe Text) Source #

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

updateStream_streamId :: Lens' UpdateStream Text Source #

The stream ID.

updateStreamResponse_description :: Lens' UpdateStreamResponse (Maybe Text) Source #

A description of the stream.

updateStreamResponse_streamArn :: Lens' UpdateStreamResponse (Maybe Text) Source #

The stream ARN.

updateStreamResponse_streamId :: Lens' UpdateStreamResponse (Maybe Text) Source #

The stream ID.

updateStreamResponse_streamVersion :: Lens' UpdateStreamResponse (Maybe Natural) Source #

The stream version.

updateStreamResponse_httpStatus :: Lens' UpdateStreamResponse Int Source #

The response's http status code.

UpdateThing

updateThing_attributePayload :: Lens' UpdateThing (Maybe AttributePayload) Source #

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.

updateThing_expectedVersion :: Lens' UpdateThing (Maybe Integer) Source #

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

updateThing_removeThingType :: Lens' UpdateThing (Maybe Bool) Source #

Remove a thing type association. If true, the association is removed.

updateThing_thingTypeName :: Lens' UpdateThing (Maybe Text) Source #

The name of the thing type.

updateThing_thingName :: Lens' UpdateThing Text Source #

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.

updateThingResponse_httpStatus :: Lens' UpdateThingResponse Int Source #

The response's http status code.

UpdateThingGroup

updateThingGroup_expectedVersion :: Lens' UpdateThingGroup (Maybe Integer) Source #

The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.

updateThingGroup_thingGroupName :: Lens' UpdateThingGroup Text Source #

The thing group to update.

updateThingGroup_thingGroupProperties :: Lens' UpdateThingGroup ThingGroupProperties Source #

The thing group properties.

updateThingGroupResponse_version :: Lens' UpdateThingGroupResponse (Maybe Integer) Source #

The version of the updated thing group.

updateThingGroupResponse_httpStatus :: Lens' UpdateThingGroupResponse Int Source #

The response's http status code.

UpdateThingGroupsForThing

updateThingGroupsForThing_overrideDynamicGroups :: Lens' UpdateThingGroupsForThing (Maybe Bool) Source #

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.

updateThingGroupsForThing_thingGroupsToAdd :: Lens' UpdateThingGroupsForThing (Maybe [Text]) Source #

The groups to which the thing will be added.

updateThingGroupsForThing_thingGroupsToRemove :: Lens' UpdateThingGroupsForThing (Maybe [Text]) Source #

The groups from which the thing will be removed.

updateThingGroupsForThing_thingName :: Lens' UpdateThingGroupsForThing (Maybe Text) Source #

The thing whose group memberships will be updated.

updateThingGroupsForThingResponse_httpStatus :: Lens' UpdateThingGroupsForThingResponse Int Source #

The response's http status code.

UpdateTopicRuleDestination

updateTopicRuleDestination_arn :: Lens' UpdateTopicRuleDestination Text Source #

The ARN of the topic rule destination.

updateTopicRuleDestination_status :: Lens' UpdateTopicRuleDestination TopicRuleDestinationStatus Source #

The status of the topic rule destination. Valid values are:

IN_PROGRESS
A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
ENABLED
Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.
DISABLED
Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
ERROR
Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

updateTopicRuleDestinationResponse_httpStatus :: Lens' UpdateTopicRuleDestinationResponse Int Source #

The response's http status code.

ValidateSecurityProfileBehaviors

validateSecurityProfileBehaviors_behaviors :: Lens' ValidateSecurityProfileBehaviors [Behavior] Source #

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

validateSecurityProfileBehaviorsResponse_valid :: Lens' ValidateSecurityProfileBehaviorsResponse (Maybe Bool) Source #

True if the behaviors were valid.

validateSecurityProfileBehaviorsResponse_validationErrors :: Lens' ValidateSecurityProfileBehaviorsResponse (Maybe [ValidationError]) Source #

The list of any errors found in the behaviors.

validateSecurityProfileBehaviorsResponse_httpStatus :: Lens' ValidateSecurityProfileBehaviorsResponse Int Source #

The response's http status code.

Types

AbortConfig

abortConfig_criteriaList :: Lens' AbortConfig (NonEmpty AbortCriteria) Source #

The list of criteria that determine when and how to abort the job.

AbortCriteria

abortCriteria_failureType :: Lens' AbortCriteria JobExecutionFailureType Source #

The type of job execution failures that can initiate a job abort.

abortCriteria_action :: Lens' AbortCriteria AbortAction Source #

The type of job action to take to initiate the job abort.

abortCriteria_thresholdPercentage :: Lens' AbortCriteria Double Source #

The minimum percentage of job execution failures that must occur to initiate the job abort.

Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

abortCriteria_minNumberOfExecutedThings :: Lens' AbortCriteria Natural Source #

The minimum number of things which must receive job execution notifications before the job can be aborted.

Action

action_cloudwatchAlarm :: Lens' Action (Maybe CloudwatchAlarmAction) Source #

Change the state of a CloudWatch alarm.

action_cloudwatchLogs :: Lens' Action (Maybe CloudwatchLogsAction) Source #

Send data to CloudWatch Logs.

action_cloudwatchMetric :: Lens' Action (Maybe CloudwatchMetricAction) Source #

Capture a CloudWatch metric.

action_dynamoDB :: Lens' Action (Maybe DynamoDBAction) Source #

Write to a DynamoDB table.

action_dynamoDBv2 :: Lens' Action (Maybe DynamoDBv2Action) Source #

Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.

action_elasticsearch :: Lens' Action (Maybe ElasticsearchAction) Source #

Write data to an Amazon OpenSearch Service domain.

The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction.

action_firehose :: Lens' Action (Maybe FirehoseAction) Source #

Write to an Amazon Kinesis Firehose stream.

action_http :: Lens' Action (Maybe HttpAction) Source #

Send data to an HTTPS endpoint.

action_iotAnalytics :: Lens' Action (Maybe IotAnalyticsAction) Source #

Sends message data to an IoT Analytics channel.

action_iotEvents :: Lens' Action (Maybe IotEventsAction) Source #

Sends an input to an IoT Events detector.

action_iotSiteWise :: Lens' Action (Maybe IotSiteWiseAction) Source #

Sends data from the MQTT message that triggered the rule to IoT SiteWise asset properties.

action_kafka :: Lens' Action (Maybe KafkaAction) Source #

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

action_kinesis :: Lens' Action (Maybe KinesisAction) Source #

Write data to an Amazon Kinesis stream.

action_lambda :: Lens' Action (Maybe LambdaAction) Source #

Invoke a Lambda function.

action_location :: Lens' Action (Maybe LocationAction) Source #

The Amazon Location Service rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.

action_openSearch :: Lens' Action (Maybe OpenSearchAction) Source #

Write data to an Amazon OpenSearch Service domain.

action_republish :: Lens' Action (Maybe RepublishAction) Source #

Publish to another MQTT topic.

action_s3 :: Lens' Action (Maybe S3Action) Source #

Write to an Amazon S3 bucket.

action_salesforce :: Lens' Action (Maybe SalesforceAction) Source #

Send a message to a Salesforce IoT Cloud Input Stream.

action_sns :: Lens' Action (Maybe SnsAction) Source #

Publish to an Amazon SNS topic.

action_sqs :: Lens' Action (Maybe SqsAction) Source #

Publish to an Amazon SQS queue.

action_stepFunctions :: Lens' Action (Maybe StepFunctionsAction) Source #

Starts execution of a Step Functions state machine.

action_timestream :: Lens' Action (Maybe TimestreamAction) Source #

The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic rule action documentation.

ActiveViolation

activeViolation_behavior :: Lens' ActiveViolation (Maybe Behavior) Source #

The behavior that is being violated.

activeViolation_lastViolationTime :: Lens' ActiveViolation (Maybe UTCTime) Source #

The time the most recent violation occurred.

activeViolation_lastViolationValue :: Lens' ActiveViolation (Maybe MetricValue) Source #

The value of the metric (the measurement) that caused the most recent violation.

activeViolation_securityProfileName :: Lens' ActiveViolation (Maybe Text) Source #

The security profile with the behavior is in violation.

activeViolation_thingName :: Lens' ActiveViolation (Maybe Text) Source #

The name of the thing responsible for the active violation.

activeViolation_verificationState :: Lens' ActiveViolation (Maybe VerificationState) Source #

The verification state of the violation (detect alarm).

activeViolation_verificationStateDescription :: Lens' ActiveViolation (Maybe Text) Source #

The description of the verification state of the violation.

activeViolation_violationEventAdditionalInfo :: Lens' ActiveViolation (Maybe ViolationEventAdditionalInfo) Source #

The details of a violation event.

activeViolation_violationId :: Lens' ActiveViolation (Maybe Text) Source #

The ID of the active violation.

activeViolation_violationStartTime :: Lens' ActiveViolation (Maybe UTCTime) Source #

The time the violation started.

AddThingsToThingGroupParams

addThingsToThingGroupParams_overrideDynamicGroups :: Lens' AddThingsToThingGroupParams (Maybe Bool) Source #

Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic thing groups.

addThingsToThingGroupParams_thingGroupNames :: Lens' AddThingsToThingGroupParams (NonEmpty Text) Source #

The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you can't add a thing to more than one group in the same hierarchy.

AggregationType

aggregationType_values :: Lens' AggregationType (Maybe [Text]) Source #

A list of the values of aggregation types.

aggregationType_name :: Lens' AggregationType AggregationTypeName Source #

The name of the aggregation type.

AlertTarget

alertTarget_alertTargetArn :: Lens' AlertTarget Text Source #

The Amazon Resource Name (ARN) of the notification target to which alerts are sent.

alertTarget_roleArn :: Lens' AlertTarget Text Source #

The ARN of the role that grants permission to send alerts to the notification target.

Allowed

allowed_policies :: Lens' Allowed (Maybe [Policy]) Source #

A list of policies that allowed the authentication.

AssetPropertyTimestamp

assetPropertyTimestamp_offsetInNanos :: Lens' AssetPropertyTimestamp (Maybe Text) Source #

Optional. A string that contains the nanosecond time offset. Accepts substitution templates.

assetPropertyTimestamp_timeInSeconds :: Lens' AssetPropertyTimestamp Text Source #

A string that contains the time in seconds since epoch. Accepts substitution templates.

AssetPropertyValue

assetPropertyValue_quality :: Lens' AssetPropertyValue (Maybe Text) Source #

Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD, BAD, or UNCERTAIN.

assetPropertyValue_value :: Lens' AssetPropertyValue AssetPropertyVariant Source #

The value of the asset property.

assetPropertyValue_timestamp :: Lens' AssetPropertyValue AssetPropertyTimestamp Source #

The asset property value timestamp.

AssetPropertyVariant

assetPropertyVariant_booleanValue :: Lens' AssetPropertyVariant (Maybe Text) Source #

Optional. A string that contains the boolean value (true or false) of the value entry. Accepts substitution templates.

assetPropertyVariant_doubleValue :: Lens' AssetPropertyVariant (Maybe Text) Source #

Optional. A string that contains the double value of the value entry. Accepts substitution templates.

assetPropertyVariant_integerValue :: Lens' AssetPropertyVariant (Maybe Text) Source #

Optional. A string that contains the integer value of the value entry. Accepts substitution templates.

assetPropertyVariant_stringValue :: Lens' AssetPropertyVariant (Maybe Text) Source #

Optional. The string value of the value entry. Accepts substitution templates.

AttributePayload

attributePayload_attributes :: Lens' AttributePayload (Maybe (HashMap Text Text)) Source #

A JSON string containing up to three key-value pair in JSON format. For example:

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

attributePayload_merge :: Lens' AttributePayload (Maybe Bool) Source #

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

AuditCheckConfiguration

auditCheckConfiguration_enabled :: Lens' AuditCheckConfiguration (Maybe Bool) Source #

True if this audit check is enabled for this account.

AuditCheckDetails

auditCheckDetails_checkCompliant :: Lens' AuditCheckDetails (Maybe Bool) Source #

True if the check is complete and found all resources compliant.

auditCheckDetails_checkRunStatus :: Lens' AuditCheckDetails (Maybe AuditCheckRunStatus) Source #

The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".

auditCheckDetails_errorCode :: Lens' AuditCheckDetails (Maybe Text) Source #

The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".

auditCheckDetails_message :: Lens' AuditCheckDetails (Maybe Text) Source #

The message associated with any error encountered when this check is performed during this audit.

auditCheckDetails_nonCompliantResourcesCount :: Lens' AuditCheckDetails (Maybe Integer) Source #

The number of resources that were found noncompliant during the check.

auditCheckDetails_suppressedNonCompliantResourcesCount :: Lens' AuditCheckDetails (Maybe Integer) Source #

Describes how many of the non-compliant resources created during the evaluation of an audit check were marked as suppressed.

auditCheckDetails_totalResourcesCount :: Lens' AuditCheckDetails (Maybe Integer) Source #

The number of resources on which the check was performed.

AuditFinding

auditFinding_checkName :: Lens' AuditFinding (Maybe Text) Source #

The audit check that generated this result.

auditFinding_findingId :: Lens' AuditFinding (Maybe Text) Source #

A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

auditFinding_findingTime :: Lens' AuditFinding (Maybe UTCTime) Source #

The time the result (finding) was discovered.

auditFinding_isSuppressed :: Lens' AuditFinding (Maybe Bool) Source #

Indicates whether the audit finding was suppressed or not during reporting.

auditFinding_nonCompliantResource :: Lens' AuditFinding (Maybe NonCompliantResource) Source #

The resource that was found to be noncompliant with the audit check.

auditFinding_reasonForNonCompliance :: Lens' AuditFinding (Maybe Text) Source #

The reason the resource was noncompliant.

auditFinding_reasonForNonComplianceCode :: Lens' AuditFinding (Maybe Text) Source #

A code that indicates the reason that the resource was noncompliant.

auditFinding_relatedResources :: Lens' AuditFinding (Maybe [RelatedResource]) Source #

The list of related resources.

auditFinding_severity :: Lens' AuditFinding (Maybe AuditFindingSeverity) Source #

The severity of the result (finding).

auditFinding_taskId :: Lens' AuditFinding (Maybe Text) Source #

The ID of the audit that generated this result (finding).

auditFinding_taskStartTime :: Lens' AuditFinding (Maybe UTCTime) Source #

The time the audit started.

AuditMitigationActionExecutionMetadata

auditMitigationActionExecutionMetadata_actionId :: Lens' AuditMitigationActionExecutionMetadata (Maybe Text) Source #

The unique identifier for the mitigation action being applied by the task.

auditMitigationActionExecutionMetadata_actionName :: Lens' AuditMitigationActionExecutionMetadata (Maybe Text) Source #

The friendly name of the mitigation action being applied by the task.

auditMitigationActionExecutionMetadata_endTime :: Lens' AuditMitigationActionExecutionMetadata (Maybe UTCTime) Source #

The date and time when the task was completed or canceled. Blank if the task is still running.

auditMitigationActionExecutionMetadata_errorCode :: Lens' AuditMitigationActionExecutionMetadata (Maybe Text) Source #

If an error occurred, the code that indicates which type of error occurred.

auditMitigationActionExecutionMetadata_findingId :: Lens' AuditMitigationActionExecutionMetadata (Maybe Text) Source #

The unique identifier for the findings to which the task and associated mitigation action are applied.

auditMitigationActionExecutionMetadata_message :: Lens' AuditMitigationActionExecutionMetadata (Maybe Text) Source #

If an error occurred, a message that describes the error.

auditMitigationActionExecutionMetadata_startTime :: Lens' AuditMitigationActionExecutionMetadata (Maybe UTCTime) Source #

The date and time when the task was started.

auditMitigationActionExecutionMetadata_status :: Lens' AuditMitigationActionExecutionMetadata (Maybe AuditMitigationActionsExecutionStatus) Source #

The current status of the task being executed.

auditMitigationActionExecutionMetadata_taskId :: Lens' AuditMitigationActionExecutionMetadata (Maybe Text) Source #

The unique identifier for the task that applies the mitigation action.

AuditMitigationActionsTaskMetadata

auditMitigationActionsTaskMetadata_startTime :: Lens' AuditMitigationActionsTaskMetadata (Maybe UTCTime) Source #

The time at which the audit mitigation actions task was started.

auditMitigationActionsTaskMetadata_taskId :: Lens' AuditMitigationActionsTaskMetadata (Maybe Text) Source #

The unique identifier for the task.

auditMitigationActionsTaskMetadata_taskStatus :: Lens' AuditMitigationActionsTaskMetadata (Maybe AuditMitigationActionsTaskStatus) Source #

The current state of the audit mitigation actions task.

AuditMitigationActionsTaskTarget

auditMitigationActionsTaskTarget_auditCheckToReasonCodeFilter :: Lens' AuditMitigationActionsTaskTarget (Maybe (HashMap Text (NonEmpty Text))) Source #

Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.

auditMitigationActionsTaskTarget_auditTaskId :: Lens' AuditMitigationActionsTaskTarget (Maybe Text) Source #

If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.

auditMitigationActionsTaskTarget_findingIds :: Lens' AuditMitigationActionsTaskTarget (Maybe (NonEmpty Text)) Source #

If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.

AuditNotificationTarget

auditNotificationTarget_enabled :: Lens' AuditNotificationTarget (Maybe Bool) Source #

True if notifications to the target are enabled.

auditNotificationTarget_roleArn :: Lens' AuditNotificationTarget (Maybe Text) Source #

The ARN of the role that grants permission to send notifications to the target.

auditNotificationTarget_targetArn :: Lens' AuditNotificationTarget (Maybe Text) Source #

The ARN of the target (SNS topic) to which audit notifications are sent.

AuditSuppression

auditSuppression_description :: Lens' AuditSuppression (Maybe Text) Source #

The description of the audit suppression.

auditSuppression_expirationDate :: Lens' AuditSuppression (Maybe UTCTime) Source #

The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.

auditSuppression_suppressIndefinitely :: Lens' AuditSuppression (Maybe Bool) Source #

Indicates whether a suppression should exist indefinitely or not.

auditSuppression_checkName :: Lens' AuditSuppression Text Source #

Undocumented member.

auditSuppression_resourceIdentifier :: Lens' AuditSuppression ResourceIdentifier Source #

Undocumented member.

AuditTaskMetadata

auditTaskMetadata_taskId :: Lens' AuditTaskMetadata (Maybe Text) Source #

The ID of this audit.

auditTaskMetadata_taskStatus :: Lens' AuditTaskMetadata (Maybe AuditTaskStatus) Source #

The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

auditTaskMetadata_taskType :: Lens' AuditTaskMetadata (Maybe AuditTaskType) Source #

The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

AuthInfo

authInfo_actionType :: Lens' AuthInfo (Maybe ActionType) Source #

The type of action for which the principal is being authorized.

authInfo_resources :: Lens' AuthInfo [Text] Source #

The resources for which the principal is being authorized to perform the specified action.

AuthResult

authResult_allowed :: Lens' AuthResult (Maybe Allowed) Source #

The policies and statements that allowed the specified action.

authResult_authDecision :: Lens' AuthResult (Maybe AuthDecision) Source #

The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.

authResult_authInfo :: Lens' AuthResult (Maybe AuthInfo) Source #

Authorization information.

authResult_denied :: Lens' AuthResult (Maybe Denied) Source #

The policies and statements that denied the specified action.

authResult_missingContextValues :: Lens' AuthResult (Maybe [Text]) Source #

Contains any missing context values found while evaluating policy.

AuthorizerConfig

authorizerConfig_allowAuthorizerOverride :: Lens' AuthorizerConfig (Maybe Bool) Source #

A Boolean that specifies whether the domain configuration's authorization service can be overridden.

authorizerConfig_defaultAuthorizerName :: Lens' AuthorizerConfig (Maybe Text) Source #

The name of the authorization service for a domain configuration.

AuthorizerDescription

authorizerDescription_authorizerArn :: Lens' AuthorizerDescription (Maybe Text) Source #

The authorizer ARN.

authorizerDescription_authorizerFunctionArn :: Lens' AuthorizerDescription (Maybe Text) Source #

The authorizer's Lambda function ARN.

authorizerDescription_authorizerName :: Lens' AuthorizerDescription (Maybe Text) Source #

The authorizer name.

authorizerDescription_creationDate :: Lens' AuthorizerDescription (Maybe UTCTime) Source #

The UNIX timestamp of when the authorizer was created.

authorizerDescription_enableCachingForHttp :: Lens' AuthorizerDescription (Maybe Bool) Source #

When true, the result from the authorizer’s Lambda function is cached for the time specified in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection.

authorizerDescription_lastModifiedDate :: Lens' AuthorizerDescription (Maybe UTCTime) Source #

The UNIX timestamp of when the authorizer was last updated.

authorizerDescription_signingDisabled :: Lens' AuthorizerDescription (Maybe Bool) Source #

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

authorizerDescription_status :: Lens' AuthorizerDescription (Maybe AuthorizerStatus) Source #

The status of the authorizer.

authorizerDescription_tokenKeyName :: Lens' AuthorizerDescription (Maybe Text) Source #

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

authorizerDescription_tokenSigningPublicKeys :: Lens' AuthorizerDescription (Maybe (HashMap Text Text)) Source #

The public keys used to validate the token signature returned by your custom authentication service.

AuthorizerSummary

authorizerSummary_authorizerArn :: Lens' AuthorizerSummary (Maybe Text) Source #

The authorizer ARN.

authorizerSummary_authorizerName :: Lens' AuthorizerSummary (Maybe Text) Source #

The authorizer name.

AwsJobAbortConfig

awsJobAbortConfig_abortCriteriaList :: Lens' AwsJobAbortConfig (NonEmpty AwsJobAbortCriteria) Source #

The list of criteria that determine when and how to abort the job.

AwsJobAbortCriteria

awsJobAbortCriteria_failureType :: Lens' AwsJobAbortCriteria AwsJobAbortCriteriaFailureType Source #

The type of job execution failures that can initiate a job abort.

awsJobAbortCriteria_action :: Lens' AwsJobAbortCriteria AwsJobAbortCriteriaAbortAction Source #

The type of job action to take to initiate the job abort.

awsJobAbortCriteria_thresholdPercentage :: Lens' AwsJobAbortCriteria Double Source #

The minimum percentage of job execution failures that must occur to initiate the job abort.

Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

awsJobAbortCriteria_minNumberOfExecutedThings :: Lens' AwsJobAbortCriteria Natural Source #

The minimum number of things which must receive job execution notifications before the job can be aborted.

AwsJobExecutionsRolloutConfig

awsJobExecutionsRolloutConfig_exponentialRate :: Lens' AwsJobExecutionsRolloutConfig (Maybe AwsJobExponentialRolloutRate) Source #

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

awsJobExecutionsRolloutConfig_maximumPerMinute :: Lens' AwsJobExecutionsRolloutConfig (Maybe Natural) Source #

The maximum number of OTA update job executions started per minute.

AwsJobExponentialRolloutRate

awsJobExponentialRolloutRate_baseRatePerMinute :: Lens' AwsJobExponentialRolloutRate Natural Source #

The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout. This is the initial rate of the rollout.

awsJobExponentialRolloutRate_incrementFactor :: Lens' AwsJobExponentialRolloutRate Double Source #

The rate of increase for a job rollout. The number of things notified is multiplied by this factor.

awsJobExponentialRolloutRate_rateIncreaseCriteria :: Lens' AwsJobExponentialRolloutRate AwsJobRateIncreaseCriteria Source #

The criteria to initiate the increase in rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

AwsJobPresignedUrlConfig

awsJobPresignedUrlConfig_expiresInSec :: Lens' AwsJobPresignedUrlConfig (Maybe Integer) Source #

How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.

AwsJobRateIncreaseCriteria

awsJobRateIncreaseCriteria_numberOfNotifiedThings :: Lens' AwsJobRateIncreaseCriteria (Maybe Natural) Source #

When this number of things have been notified, it will initiate an increase in the rollout rate.

awsJobRateIncreaseCriteria_numberOfSucceededThings :: Lens' AwsJobRateIncreaseCriteria (Maybe Natural) Source #

When this number of things have succeeded in their job execution, it will initiate an increase in the rollout rate.

AwsJobTimeoutConfig

awsJobTimeoutConfig_inProgressTimeoutInMinutes :: Lens' AwsJobTimeoutConfig (Maybe Integer) Source #

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

Behavior

behavior_criteria :: Lens' Behavior (Maybe BehaviorCriteria) Source #

The criteria that determine if a device is behaving normally in regard to the metric.

behavior_metric :: Lens' Behavior (Maybe Text) Source #

What is measured by the behavior.

behavior_metricDimension :: Lens' Behavior (Maybe MetricDimension) Source #

The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.

behavior_suppressAlerts :: Lens' Behavior (Maybe Bool) Source #

Suppresses alerts.

behavior_name :: Lens' Behavior Text Source #

The name you've given to the behavior.

BehaviorCriteria

behaviorCriteria_comparisonOperator :: Lens' BehaviorCriteria (Maybe ComparisonOperator) Source #

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:

  • string-list: in-set and not-in-set
  • number-list: in-set and not-in-set
  • ip-address-list: in-cidr-set and not-in-cidr-set
  • number: less-than, less-than-equals, greater-than, and greater-than-equals

behaviorCriteria_consecutiveDatapointsToAlarm :: Lens' BehaviorCriteria (Maybe Natural) Source #

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

behaviorCriteria_consecutiveDatapointsToClear :: Lens' BehaviorCriteria (Maybe Natural) Source #

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

behaviorCriteria_durationSeconds :: Lens' BehaviorCriteria (Maybe Int) Source #

Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.

behaviorCriteria_mlDetectionConfig :: Lens' BehaviorCriteria (Maybe MachineLearningDetectionConfig) Source #

The configuration of an ML Detect

behaviorCriteria_statisticalThreshold :: Lens' BehaviorCriteria (Maybe StatisticalThreshold) Source #

A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

behaviorCriteria_value :: Lens' BehaviorCriteria (Maybe MetricValue) Source #

The value to be compared with the metric.

BehaviorModelTrainingSummary

behaviorModelTrainingSummary_behaviorName :: Lens' BehaviorModelTrainingSummary (Maybe Text) Source #

The name of the behavior.

behaviorModelTrainingSummary_datapointsCollectionPercentage :: Lens' BehaviorModelTrainingSummary (Maybe Double) Source #

The percentage of datapoints collected.

behaviorModelTrainingSummary_lastModelRefreshDate :: Lens' BehaviorModelTrainingSummary (Maybe UTCTime) Source #

The date the model was last refreshed.

behaviorModelTrainingSummary_modelStatus :: Lens' BehaviorModelTrainingSummary (Maybe ModelStatus) Source #

The status of the behavior model.

behaviorModelTrainingSummary_securityProfileName :: Lens' BehaviorModelTrainingSummary (Maybe Text) Source #

The name of the security profile.

behaviorModelTrainingSummary_trainingDataCollectionStartDate :: Lens' BehaviorModelTrainingSummary (Maybe UTCTime) Source #

The date a training model started collecting data.

BillingGroupMetadata

billingGroupMetadata_creationDate :: Lens' BillingGroupMetadata (Maybe UTCTime) Source #

The date the billing group was created.

BillingGroupProperties

billingGroupProperties_billingGroupDescription :: Lens' BillingGroupProperties (Maybe Text) Source #

The description of the billing group.

Bucket

bucket_count :: Lens' Bucket (Maybe Int) Source #

The number of documents that have the value counted for the particular bucket.

bucket_keyValue :: Lens' Bucket (Maybe Text) Source #

The value counted for the particular bucket.

BucketsAggregationType

bucketsAggregationType_termsAggregation :: Lens' BucketsAggregationType (Maybe TermsAggregation) Source #

Performs an aggregation that will return a list of buckets. The list of buckets is a ranked list of the number of occurrences of an aggregation field value.

CACertificate

cACertificate_certificateArn :: Lens' CACertificate (Maybe Text) Source #

The ARN of the CA certificate.

cACertificate_certificateId :: Lens' CACertificate (Maybe Text) Source #

The ID of the CA certificate.

cACertificate_creationDate :: Lens' CACertificate (Maybe UTCTime) Source #

The date the CA certificate was created.

cACertificate_status :: Lens' CACertificate (Maybe CACertificateStatus) Source #

The status of the CA certificate.

The status value REGISTER_INACTIVE is deprecated and should not be used.

CACertificateDescription

cACertificateDescription_autoRegistrationStatus :: Lens' CACertificateDescription (Maybe AutoRegistrationStatus) Source #

Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"

cACertificateDescription_certificateArn :: Lens' CACertificateDescription (Maybe Text) Source #

The CA certificate ARN.

cACertificateDescription_certificateId :: Lens' CACertificateDescription (Maybe Text) Source #

The CA certificate ID.

cACertificateDescription_certificateMode :: Lens' CACertificateDescription (Maybe CertificateMode) Source #

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

cACertificateDescription_certificatePem :: Lens' CACertificateDescription (Maybe Text) Source #

The CA certificate data, in PEM format.

cACertificateDescription_creationDate :: Lens' CACertificateDescription (Maybe UTCTime) Source #

The date the CA certificate was created.

cACertificateDescription_customerVersion :: Lens' CACertificateDescription (Maybe Natural) Source #

The customer version of the CA certificate.

cACertificateDescription_generationId :: Lens' CACertificateDescription (Maybe Text) Source #

The generation ID of the CA certificate.

cACertificateDescription_lastModifiedDate :: Lens' CACertificateDescription (Maybe UTCTime) Source #

The date the CA certificate was last modified.

cACertificateDescription_ownedBy :: Lens' CACertificateDescription (Maybe Text) Source #

The owner of the CA certificate.

cACertificateDescription_status :: Lens' CACertificateDescription (Maybe CACertificateStatus) Source #

The status of a CA certificate.

cACertificateDescription_validity :: Lens' CACertificateDescription (Maybe CertificateValidity) Source #

When the CA certificate is valid.

Certificate

certificate_certificateArn :: Lens' Certificate (Maybe Text) Source #

The ARN of the certificate.

certificate_certificateId :: Lens' Certificate (Maybe Text) Source #

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

certificate_certificateMode :: Lens' Certificate (Maybe CertificateMode) Source #

The mode of the certificate.

DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

certificate_creationDate :: Lens' Certificate (Maybe UTCTime) Source #

The date and time the certificate was created.

certificate_status :: Lens' Certificate (Maybe CertificateStatus) Source #

The status of the certificate.

The status value REGISTER_INACTIVE is deprecated and should not be used.

CertificateDescription

certificateDescription_caCertificateId :: Lens' CertificateDescription (Maybe Text) Source #

The certificate ID of the CA certificate used to sign this certificate.

certificateDescription_certificateArn :: Lens' CertificateDescription (Maybe Text) Source #

The ARN of the certificate.

certificateDescription_certificateId :: Lens' CertificateDescription (Maybe Text) Source #

The ID of the certificate.

certificateDescription_certificateMode :: Lens' CertificateDescription (Maybe CertificateMode) Source #

The mode of the certificate.

DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

For more information about the value for SNI extension, see Transport security in IoT.

certificateDescription_certificatePem :: Lens' CertificateDescription (Maybe Text) Source #

The certificate data, in PEM format.

certificateDescription_creationDate :: Lens' CertificateDescription (Maybe UTCTime) Source #

The date and time the certificate was created.

certificateDescription_customerVersion :: Lens' CertificateDescription (Maybe Natural) Source #

The customer version of the certificate.

certificateDescription_generationId :: Lens' CertificateDescription (Maybe Text) Source #

The generation ID of the certificate.

certificateDescription_lastModifiedDate :: Lens' CertificateDescription (Maybe UTCTime) Source #

The date and time the certificate was last modified.

certificateDescription_ownedBy :: Lens' CertificateDescription (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the certificate.

certificateDescription_previousOwnedBy :: Lens' CertificateDescription (Maybe Text) Source #

The ID of the Amazon Web Services account of the previous owner of the certificate.

certificateDescription_status :: Lens' CertificateDescription (Maybe CertificateStatus) Source #

The status of the certificate.

certificateDescription_transferData :: Lens' CertificateDescription (Maybe TransferData) Source #

The transfer data.

certificateDescription_validity :: Lens' CertificateDescription (Maybe CertificateValidity) Source #

When the certificate is valid.

CertificateValidity

certificateValidity_notAfter :: Lens' CertificateValidity (Maybe UTCTime) Source #

The certificate is not valid after this date.

certificateValidity_notBefore :: Lens' CertificateValidity (Maybe UTCTime) Source #

The certificate is not valid before this date.

CloudwatchAlarmAction

cloudwatchAlarmAction_roleArn :: Lens' CloudwatchAlarmAction Text Source #

The IAM role that allows access to the CloudWatch alarm.

cloudwatchAlarmAction_alarmName :: Lens' CloudwatchAlarmAction Text Source #

The CloudWatch alarm name.

cloudwatchAlarmAction_stateReason :: Lens' CloudwatchAlarmAction Text Source #

The reason for the alarm change.

cloudwatchAlarmAction_stateValue :: Lens' CloudwatchAlarmAction Text Source #

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

CloudwatchLogsAction

cloudwatchLogsAction_roleArn :: Lens' CloudwatchLogsAction Text Source #

The IAM role that allows access to the CloudWatch log.

cloudwatchLogsAction_logGroupName :: Lens' CloudwatchLogsAction Text Source #

The CloudWatch log group to which the action sends data.

CloudwatchMetricAction

cloudwatchMetricAction_metricTimestamp :: Lens' CloudwatchMetricAction (Maybe Text) Source #

An optional Unix timestamp.

cloudwatchMetricAction_roleArn :: Lens' CloudwatchMetricAction Text Source #

The IAM role that allows access to the CloudWatch metric.

cloudwatchMetricAction_metricNamespace :: Lens' CloudwatchMetricAction Text Source #

The CloudWatch metric namespace name.

cloudwatchMetricAction_metricName :: Lens' CloudwatchMetricAction Text Source #

The CloudWatch metric name.

cloudwatchMetricAction_metricValue :: Lens' CloudwatchMetricAction Text Source #

The CloudWatch metric value.

cloudwatchMetricAction_metricUnit :: Lens' CloudwatchMetricAction Text Source #

The metric unit supported by CloudWatch.

CodeSigning

codeSigning_awsSignerJobId :: Lens' CodeSigning (Maybe Text) Source #

The ID of the AWSSignerJob which was created to sign the file.

codeSigning_customCodeSigning :: Lens' CodeSigning (Maybe CustomCodeSigning) Source #

A custom method for code signing a file.

codeSigning_startSigningJobParameter :: Lens' CodeSigning (Maybe StartSigningJobParameter) Source #

Describes the code-signing job.

CodeSigningCertificateChain

codeSigningCertificateChain_certificateName :: Lens' CodeSigningCertificateChain (Maybe Text) Source #

The name of the certificate.

codeSigningCertificateChain_inlineDocument :: Lens' CodeSigningCertificateChain (Maybe Text) Source #

A base64 encoded binary representation of the code signing certificate chain.

CodeSigningSignature

codeSigningSignature_inlineDocument :: Lens' CodeSigningSignature (Maybe ByteString) Source #

A base64 encoded binary representation of the code signing signature.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

Configuration

configuration_enabled :: Lens' Configuration (Maybe Bool) Source #

True to enable the configuration.

CustomCodeSigning

customCodeSigning_certificateChain :: Lens' CustomCodeSigning (Maybe CodeSigningCertificateChain) Source #

The certificate chain.

customCodeSigning_hashAlgorithm :: Lens' CustomCodeSigning (Maybe Text) Source #

The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses SHA256 or SHA1, so you can pass either of them based on which was used for generating the signature.

customCodeSigning_signature :: Lens' CustomCodeSigning (Maybe CodeSigningSignature) Source #

The signature for the file.

customCodeSigning_signatureAlgorithm :: Lens' CustomCodeSigning (Maybe Text) Source #

The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses ECDSA or RSA, so you can pass either of them based on which was used for generating the signature.

Denied

denied_explicitDeny :: Lens' Denied (Maybe ExplicitDeny) Source #

Information that explicitly denies the authorization.

denied_implicitDeny :: Lens' Denied (Maybe ImplicitDeny) Source #

Information that implicitly denies the authorization. When a policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.

Destination

destination_s3Destination :: Lens' Destination (Maybe S3Destination) Source #

Describes the location in S3 of the updated firmware.

DetectMitigationActionExecution

detectMitigationActionExecution_actionName :: Lens' DetectMitigationActionExecution (Maybe Text) Source #

The friendly name that uniquely identifies the mitigation action.

detectMitigationActionExecution_errorCode :: Lens' DetectMitigationActionExecution (Maybe Text) Source #

The error code of a mitigation action.

detectMitigationActionExecution_executionEndDate :: Lens' DetectMitigationActionExecution (Maybe UTCTime) Source #

The date a mitigation action ended.

detectMitigationActionExecution_executionStartDate :: Lens' DetectMitigationActionExecution (Maybe UTCTime) Source #

The date a mitigation action was started.

detectMitigationActionExecution_message :: Lens' DetectMitigationActionExecution (Maybe Text) Source #

The message of a mitigation action.

detectMitigationActionExecution_status :: Lens' DetectMitigationActionExecution (Maybe DetectMitigationActionExecutionStatus) Source #

The status of a mitigation action.

detectMitigationActionExecution_taskId :: Lens' DetectMitigationActionExecution (Maybe Text) Source #

The unique identifier of the task.

detectMitigationActionExecution_thingName :: Lens' DetectMitigationActionExecution (Maybe Text) Source #

The name of the thing.

detectMitigationActionExecution_violationId :: Lens' DetectMitigationActionExecution (Maybe Text) Source #

The unique identifier of the violation.

DetectMitigationActionsTaskStatistics

detectMitigationActionsTaskStatistics_actionsExecuted :: Lens' DetectMitigationActionsTaskStatistics (Maybe Integer) Source #

The actions that were performed.

detectMitigationActionsTaskStatistics_actionsFailed :: Lens' DetectMitigationActionsTaskStatistics (Maybe Integer) Source #

The actions that failed.

detectMitigationActionsTaskStatistics_actionsSkipped :: Lens' DetectMitigationActionsTaskStatistics (Maybe Integer) Source #

The actions that were skipped.

DetectMitigationActionsTaskSummary

detectMitigationActionsTaskSummary_actionsDefinition :: Lens' DetectMitigationActionsTaskSummary (Maybe [MitigationAction]) Source #

The definition of the actions.

detectMitigationActionsTaskSummary_onlyActiveViolationsIncluded :: Lens' DetectMitigationActionsTaskSummary (Maybe Bool) Source #

Includes only active violations.

detectMitigationActionsTaskSummary_suppressedAlertsIncluded :: Lens' DetectMitigationActionsTaskSummary (Maybe Bool) Source #

Includes suppressed alerts.

detectMitigationActionsTaskSummary_target :: Lens' DetectMitigationActionsTaskSummary (Maybe DetectMitigationActionsTaskTarget) Source #

Specifies the ML Detect findings to which the mitigation actions are applied.

detectMitigationActionsTaskSummary_taskEndTime :: Lens' DetectMitigationActionsTaskSummary (Maybe UTCTime) Source #

The date the task ended.

detectMitigationActionsTaskSummary_taskId :: Lens' DetectMitigationActionsTaskSummary (Maybe Text) Source #

The unique identifier of the task.

detectMitigationActionsTaskSummary_taskStartTime :: Lens' DetectMitigationActionsTaskSummary (Maybe UTCTime) Source #

The date the task started.

detectMitigationActionsTaskSummary_taskStatistics :: Lens' DetectMitigationActionsTaskSummary (Maybe DetectMitigationActionsTaskStatistics) Source #

The statistics of a mitigation action task.

detectMitigationActionsTaskSummary_taskStatus :: Lens' DetectMitigationActionsTaskSummary (Maybe DetectMitigationActionsTaskStatus) Source #

The status of the task.

detectMitigationActionsTaskSummary_violationEventOccurrenceRange :: Lens' DetectMitigationActionsTaskSummary (Maybe ViolationEventOccurrenceRange) Source #

Specifies the time period of which violation events occurred between.

DetectMitigationActionsTaskTarget

detectMitigationActionsTaskTarget_behaviorName :: Lens' DetectMitigationActionsTaskTarget (Maybe Text) Source #

The name of the behavior.

detectMitigationActionsTaskTarget_securityProfileName :: Lens' DetectMitigationActionsTaskTarget (Maybe Text) Source #

The name of the security profile.

detectMitigationActionsTaskTarget_violationIds :: Lens' DetectMitigationActionsTaskTarget (Maybe (NonEmpty Text)) Source #

The unique identifiers of the violations.

DocumentParameter

documentParameter_description :: Lens' DocumentParameter (Maybe Text) Source #

Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

documentParameter_example :: Lens' DocumentParameter (Maybe Text) Source #

An example illustrating a pattern that need to be replaced in a managed template job document schema.

documentParameter_key :: Lens' DocumentParameter (Maybe Text) Source #

Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

documentParameter_optional :: Lens' DocumentParameter (Maybe Bool) Source #

Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

documentParameter_regex :: Lens' DocumentParameter (Maybe Text) Source #

A regular expression of the patterns that need to be replaced in a managed template job document schema.

DomainConfigurationSummary

domainConfigurationSummary_domainConfigurationArn :: Lens' DomainConfigurationSummary (Maybe Text) Source #

The ARN of the domain configuration.

domainConfigurationSummary_domainConfigurationName :: Lens' DomainConfigurationSummary (Maybe Text) Source #

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

domainConfigurationSummary_serviceType :: Lens' DomainConfigurationSummary (Maybe ServiceType) Source #

The type of service delivered by the endpoint.

DynamoDBAction

dynamoDBAction_hashKeyType :: Lens' DynamoDBAction (Maybe DynamoKeyType) Source #

The hash key type. Valid values are "STRING" or "NUMBER"

dynamoDBAction_operation :: Lens' DynamoDBAction (Maybe Text) Source #

The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.

dynamoDBAction_payloadField :: Lens' DynamoDBAction (Maybe Text) Source #

The action payload. This name can be customized.

dynamoDBAction_rangeKeyField :: Lens' DynamoDBAction (Maybe Text) Source #

The range key name.

dynamoDBAction_rangeKeyType :: Lens' DynamoDBAction (Maybe DynamoKeyType) Source #

The range key type. Valid values are "STRING" or "NUMBER"

dynamoDBAction_rangeKeyValue :: Lens' DynamoDBAction (Maybe Text) Source #

The range key value.

dynamoDBAction_tableName :: Lens' DynamoDBAction Text Source #

The name of the DynamoDB table.

dynamoDBAction_roleArn :: Lens' DynamoDBAction Text Source #

The ARN of the IAM role that grants access to the DynamoDB table.

dynamoDBAction_hashKeyField :: Lens' DynamoDBAction Text Source #

The hash key name.

dynamoDBAction_hashKeyValue :: Lens' DynamoDBAction Text Source #

The hash key value.

DynamoDBv2Action

dynamoDBv2Action_roleArn :: Lens' DynamoDBv2Action Text Source #

The ARN of the IAM role that grants access to the DynamoDB table.

dynamoDBv2Action_putItem :: Lens' DynamoDBv2Action PutItemInput Source #

Specifies the DynamoDB table to which the message data will be written. For example:

{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }

Each attribute in the message payload will be written to a separate column in the DynamoDB database.

EffectivePolicy

effectivePolicy_policyArn :: Lens' EffectivePolicy (Maybe Text) Source #

The policy ARN.

effectivePolicy_policyDocument :: Lens' EffectivePolicy (Maybe Text) Source #

The IAM policy document.

effectivePolicy_policyName :: Lens' EffectivePolicy (Maybe Text) Source #

The policy name.

ElasticsearchAction

elasticsearchAction_roleArn :: Lens' ElasticsearchAction Text Source #

The IAM role ARN that has access to OpenSearch.

elasticsearchAction_endpoint :: Lens' ElasticsearchAction Text Source #

The endpoint of your OpenSearch domain.

elasticsearchAction_index :: Lens' ElasticsearchAction Text Source #

The index where you want to store your data.

elasticsearchAction_type :: Lens' ElasticsearchAction Text Source #

The type of document you are storing.

elasticsearchAction_id :: Lens' ElasticsearchAction Text Source #

The unique identifier for the document you are storing.

EnableIoTLoggingParams

enableIoTLoggingParams_roleArnForLogging :: Lens' EnableIoTLoggingParams Text Source #

The Amazon Resource Name (ARN) of the IAM role used for logging.

enableIoTLoggingParams_logLevel :: Lens' EnableIoTLoggingParams LogLevel Source #

Specifies the type of information to be logged.

ErrorInfo

errorInfo_code :: Lens' ErrorInfo (Maybe Text) Source #

The error code.

errorInfo_message :: Lens' ErrorInfo (Maybe Text) Source #

The error message.

ExplicitDeny

explicitDeny_policies :: Lens' ExplicitDeny (Maybe [Policy]) Source #

The policies that denied the authorization.

ExponentialRolloutRate

exponentialRolloutRate_baseRatePerMinute :: Lens' ExponentialRolloutRate Natural Source #

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

exponentialRolloutRate_incrementFactor :: Lens' ExponentialRolloutRate Double Source #

The exponential factor to increase the rate of rollout for a job.

Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).

exponentialRolloutRate_rateIncreaseCriteria :: Lens' ExponentialRolloutRate RateIncreaseCriteria Source #

The criteria to initiate the increase in rate of rollout for a job.

Field

field_name :: Lens' Field (Maybe Text) Source #

The name of the field.

field_type :: Lens' Field (Maybe FieldType) Source #

The data type of the field.

FileLocation

fileLocation_s3Location :: Lens' FileLocation (Maybe S3Location) Source #

The location of the updated firmware in S3.

fileLocation_stream :: Lens' FileLocation (Maybe Stream) Source #

The stream that contains the OTA update.

FirehoseAction

firehoseAction_batchMode :: Lens' FirehoseAction (Maybe Bool) Source #

Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . The default value is false.

When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch request. The resulting array can't have more than 500 records.

firehoseAction_separator :: Lens' FirehoseAction (Maybe Text) Source #

A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

firehoseAction_roleArn :: Lens' FirehoseAction Text Source #

The IAM role that grants access to the Amazon Kinesis Firehose stream.

firehoseAction_deliveryStreamName :: Lens' FirehoseAction Text Source #

The delivery stream name.

FleetMetricNameAndArn

fleetMetricNameAndArn_metricArn :: Lens' FleetMetricNameAndArn (Maybe Text) Source #

The fleet metric ARN.

fleetMetricNameAndArn_metricName :: Lens' FleetMetricNameAndArn (Maybe Text) Source #

The fleet metric name.

GroupNameAndArn

groupNameAndArn_groupArn :: Lens' GroupNameAndArn (Maybe Text) Source #

The group ARN.

groupNameAndArn_groupName :: Lens' GroupNameAndArn (Maybe Text) Source #

The group name.

HttpAction

httpAction_auth :: Lens' HttpAction (Maybe HttpAuthorization) Source #

The authentication method to use when sending data to an HTTPS endpoint.

httpAction_confirmationUrl :: Lens' HttpAction (Maybe Text) Source #

The URL to which IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

httpAction_headers :: Lens' HttpAction (Maybe [HttpActionHeader]) Source #

The HTTP headers to send with the message data.

httpAction_url :: Lens' HttpAction Text Source #

The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.

HttpActionHeader

httpActionHeader_key :: Lens' HttpActionHeader Text Source #

The HTTP header key.

httpActionHeader_value :: Lens' HttpActionHeader Text Source #

The HTTP header value. Substitution templates are supported.

HttpAuthorization

httpAuthorization_sigv4 :: Lens' HttpAuthorization (Maybe SigV4Authorization) Source #

Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process.

HttpContext

httpContext_headers :: Lens' HttpContext (Maybe (HashMap Text Text)) Source #

The header keys and values in an HTTP authorization request.

httpContext_queryString :: Lens' HttpContext (Maybe Text) Source #

The query string keys and values in an HTTP authorization request.

HttpUrlDestinationConfiguration

httpUrlDestinationConfiguration_confirmationUrl :: Lens' HttpUrlDestinationConfiguration Text Source #

The URL IoT uses to confirm ownership of or access to the topic rule destination URL.

HttpUrlDestinationProperties

httpUrlDestinationProperties_confirmationUrl :: Lens' HttpUrlDestinationProperties (Maybe Text) Source #

The URL used to confirm the HTTP topic rule destination URL.

HttpUrlDestinationSummary

httpUrlDestinationSummary_confirmationUrl :: Lens' HttpUrlDestinationSummary (Maybe Text) Source #

The URL used to confirm ownership of or access to the HTTP topic rule destination URL.

ImplicitDeny

implicitDeny_policies :: Lens' ImplicitDeny (Maybe [Policy]) Source #

Policies that don't contain a matching allow or deny statement for the specified action on the specified resource.

IndexingFilter

indexingFilter_namedShadowNames :: Lens' IndexingFilter (Maybe [Text]) Source #

The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.

IotAnalyticsAction

iotAnalyticsAction_batchMode :: Lens' IotAnalyticsAction (Maybe Bool) Source #

Whether to process the action as a batch. The default value is false.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage to the IoT Analytics channel. The resulting array can't have more than 100 messages.

iotAnalyticsAction_channelArn :: Lens' IotAnalyticsAction (Maybe Text) Source #

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

iotAnalyticsAction_channelName :: Lens' IotAnalyticsAction (Maybe Text) Source #

The name of the IoT Analytics channel to which message data will be sent.

iotAnalyticsAction_roleArn :: Lens' IotAnalyticsAction (Maybe Text) Source #

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

IotEventsAction

iotEventsAction_batchMode :: Lens' IotEventsAction (Maybe Bool) Source #

Whether to process the event actions as a batch. The default value is false.

When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

iotEventsAction_messageId :: Lens' IotEventsAction (Maybe Text) Source #

The ID of the message. The default messageId is a new UUID value.

When batchMode is true, you can't specify a messageId--a new UUID value will be assigned.

Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.

iotEventsAction_inputName :: Lens' IotEventsAction Text Source #

The name of the IoT Events input.

iotEventsAction_roleArn :: Lens' IotEventsAction Text Source #

The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").

IotSiteWiseAction

iotSiteWiseAction_putAssetPropertyValueEntries :: Lens' IotSiteWiseAction (NonEmpty PutAssetPropertyValueEntry) Source #

A list of asset property value entries.

iotSiteWiseAction_roleArn :: Lens' IotSiteWiseAction Text Source #

The ARN of the role that grants IoT permission to send an asset property value to IoT SiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue"). The trust policy can restrict access to specific asset hierarchy paths.

IssuerCertificateIdentifier

issuerCertificateIdentifier_issuerCertificateSerialNumber :: Lens' IssuerCertificateIdentifier (Maybe Text) Source #

The issuer certificate serial number.

issuerCertificateIdentifier_issuerCertificateSubject :: Lens' IssuerCertificateIdentifier (Maybe Text) Source #

The subject of the issuer certificate.

issuerCertificateIdentifier_issuerId :: Lens' IssuerCertificateIdentifier (Maybe Text) Source #

The issuer ID.

Job

job_abortConfig :: Lens' Job (Maybe AbortConfig) Source #

Configuration for criteria to abort the job.

job_comment :: Lens' Job (Maybe Text) Source #

If the job was updated, describes the reason for the update.

job_completedAt :: Lens' Job (Maybe UTCTime) Source #

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

job_createdAt :: Lens' Job (Maybe UTCTime) Source #

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

job_description :: Lens' Job (Maybe Text) Source #

A short text description of the job.

job_documentParameters :: Lens' Job (Maybe (HashMap Text Text)) Source #

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

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.

job_forceCanceled :: Lens' Job (Maybe Bool) Source #

Will be true if the job was canceled with the optional force parameter set to true.

job_isConcurrent :: Lens' Job (Maybe Bool) Source #

Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

job_jobArn :: Lens' Job (Maybe Text) Source #

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

job_jobExecutionsRetryConfig :: Lens' Job (Maybe JobExecutionsRetryConfig) Source #

The configuration for the criteria to retry the job.

job_jobExecutionsRolloutConfig :: Lens' Job (Maybe JobExecutionsRolloutConfig) Source #

Allows you to create a staged rollout of a job.

job_jobId :: Lens' Job (Maybe Text) Source #

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

job_jobProcessDetails :: Lens' Job (Maybe JobProcessDetails) Source #

Details about the job process.

job_jobTemplateArn :: Lens' Job (Maybe Text) Source #

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

job_lastUpdatedAt :: Lens' Job (Maybe UTCTime) Source #

The time, in seconds since the epoch, when the job was last updated.

job_namespaceId :: Lens' Job (Maybe Text) Source #

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_presignedUrlConfig :: Lens' Job (Maybe PresignedUrlConfig) Source #

Configuration for pre-signed S3 URLs.

job_reasonCode :: Lens' Job (Maybe Text) Source #

If the job was updated, provides the reason code for the update.

job_schedulingConfig :: Lens' Job (Maybe SchedulingConfig) Source #

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

job_status :: Lens' Job (Maybe JobStatus) Source #

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

job_targetSelection :: Lens' Job (Maybe TargetSelection) Source #

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 device when the thing representing the device 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_targets :: Lens' Job (Maybe (NonEmpty Text)) Source #

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

job_timeoutConfig :: Lens' Job (Maybe TimeoutConfig) Source #

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

JobExecution

jobExecution_approximateSecondsBeforeTimedOut :: Lens' JobExecution (Maybe Integer) Source #

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

jobExecution_executionNumber :: Lens' JobExecution (Maybe Integer) Source #

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

jobExecution_forceCanceled :: Lens' JobExecution (Maybe Bool) Source #

Will be true if the job execution was canceled with the optional force parameter set to true.

jobExecution_jobId :: Lens' JobExecution (Maybe Text) Source #

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

jobExecution_lastUpdatedAt :: Lens' JobExecution (Maybe UTCTime) Source #

The time, in seconds since the epoch, when the job execution was last updated.

jobExecution_queuedAt :: Lens' JobExecution (Maybe UTCTime) Source #

The time, in seconds since the epoch, when the job execution was queued.

jobExecution_startedAt :: Lens' JobExecution (Maybe UTCTime) Source #

The time, in seconds since the epoch, when the job execution started.

jobExecution_status :: Lens' JobExecution (Maybe JobExecutionStatus) Source #

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

jobExecution_statusDetails :: Lens' JobExecution (Maybe JobExecutionStatusDetails) Source #

A collection of name/value pairs that describe the status of the job execution.

jobExecution_thingArn :: Lens' JobExecution (Maybe Text) Source #

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

jobExecution_versionNumber :: Lens' JobExecution (Maybe Integer) Source #

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

JobExecutionStatusDetails

jobExecutionStatusDetails_detailsMap :: Lens' JobExecutionStatusDetails (Maybe (HashMap Text Text)) Source #

The job execution status.

JobExecutionSummary

jobExecutionSummary_executionNumber :: Lens' JobExecutionSummary (Maybe Integer) Source #

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used later in commands which return or update job execution information.

jobExecutionSummary_lastUpdatedAt :: Lens' JobExecutionSummary (Maybe UTCTime) Source #

The time, in seconds since the epoch, when the job execution was last updated.

jobExecutionSummary_queuedAt :: Lens' JobExecutionSummary (Maybe UTCTime) Source #

The time, in seconds since the epoch, when the job execution was queued.

jobExecutionSummary_retryAttempt :: Lens' JobExecutionSummary (Maybe Int) Source #

The number that indicates how many retry attempts have been completed for this job on this device.

jobExecutionSummary_startedAt :: Lens' JobExecutionSummary (Maybe UTCTime) Source #

The time, in seconds since the epoch, when the job execution started.

jobExecutionSummary_status :: Lens' JobExecutionSummary (Maybe JobExecutionStatus) Source #

The status of the job execution.

JobExecutionSummaryForJob

jobExecutionSummaryForJob_jobExecutionSummary :: Lens' JobExecutionSummaryForJob (Maybe JobExecutionSummary) Source #

Contains a subset of information about a job execution.

jobExecutionSummaryForJob_thingArn :: Lens' JobExecutionSummaryForJob (Maybe Text) Source #

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

JobExecutionSummaryForThing

jobExecutionSummaryForThing_jobExecutionSummary :: Lens' JobExecutionSummaryForThing (Maybe JobExecutionSummary) Source #

Contains a subset of information about a job execution.

jobExecutionSummaryForThing_jobId :: Lens' JobExecutionSummaryForThing (Maybe Text) Source #

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

JobExecutionsRetryConfig

jobExecutionsRetryConfig_criteriaList :: Lens' JobExecutionsRetryConfig (NonEmpty RetryCriteria) Source #

The list of criteria that determines how many retries are allowed for each failure type for a job.

JobExecutionsRolloutConfig

jobExecutionsRolloutConfig_exponentialRate :: Lens' JobExecutionsRolloutConfig (Maybe ExponentialRolloutRate) Source #

The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.

jobExecutionsRolloutConfig_maximumPerMinute :: Lens' JobExecutionsRolloutConfig (Maybe Natural) Source #

The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

JobProcessDetails

jobProcessDetails_numberOfCanceledThings :: Lens' JobProcessDetails (Maybe Int) Source #

The number of things that cancelled the job.

jobProcessDetails_numberOfFailedThings :: Lens' JobProcessDetails (Maybe Int) Source #

The number of things that failed executing the job.

jobProcessDetails_numberOfInProgressThings :: Lens' JobProcessDetails (Maybe Int) Source #

The number of things currently executing the job.

jobProcessDetails_numberOfQueuedThings :: Lens' JobProcessDetails (Maybe Int) Source #

The number of things that are awaiting execution of the job.

jobProcessDetails_numberOfRejectedThings :: Lens' JobProcessDetails (Maybe Int) Source #

The number of things that rejected the job.

jobProcessDetails_numberOfRemovedThings :: Lens' JobProcessDetails (Maybe Int) Source #

The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.

jobProcessDetails_numberOfSucceededThings :: Lens' JobProcessDetails (Maybe Int) Source #

The number of things which successfully completed the job.

jobProcessDetails_numberOfTimedOutThings :: Lens' JobProcessDetails (Maybe Int) Source #

The number of things whose job execution status is TIMED_OUT.

jobProcessDetails_processingTargets :: Lens' JobProcessDetails (Maybe [Text]) Source #

The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.

JobSummary

jobSummary_completedAt :: Lens' JobSummary (Maybe UTCTime) Source #

The time, in seconds since the epoch, when the job completed.

jobSummary_createdAt :: Lens' JobSummary (Maybe UTCTime) Source #

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

jobSummary_isConcurrent :: Lens' JobSummary (Maybe Bool) Source #

Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

jobSummary_jobArn :: Lens' JobSummary (Maybe Text) Source #

The job ARN.

jobSummary_jobId :: Lens' JobSummary (Maybe Text) Source #

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

jobSummary_lastUpdatedAt :: Lens' JobSummary (Maybe UTCTime) Source #

The time, in seconds since the epoch, when the job was last updated.

jobSummary_status :: Lens' JobSummary (Maybe JobStatus) Source #

The job summary status.

jobSummary_targetSelection :: Lens' JobSummary (Maybe TargetSelection) Source #

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.

jobSummary_thingGroupId :: Lens' JobSummary (Maybe Text) Source #

The ID of the thing group.

JobTemplateSummary

jobTemplateSummary_createdAt :: Lens' JobTemplateSummary (Maybe UTCTime) Source #

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

jobTemplateSummary_description :: Lens' JobTemplateSummary (Maybe Text) Source #

A description of the job template.

jobTemplateSummary_jobTemplateArn :: Lens' JobTemplateSummary (Maybe Text) Source #

The ARN of the job template.

jobTemplateSummary_jobTemplateId :: Lens' JobTemplateSummary (Maybe Text) Source #

The unique identifier of the job template.

KafkaAction

kafkaAction_key :: Lens' KafkaAction (Maybe Text) Source #

The Kafka message key.

kafkaAction_partition :: Lens' KafkaAction (Maybe Text) Source #

The Kafka message partition.

kafkaAction_destinationArn :: Lens' KafkaAction Text Source #

The ARN of Kafka action's VPC TopicRuleDestination.

kafkaAction_topic :: Lens' KafkaAction Text Source #

The Kafka topic for messages to be sent to the Kafka broker.

kafkaAction_clientProperties :: Lens' KafkaAction (HashMap Text Text) Source #

Properties of the Apache Kafka producer client.

KeyPair

keyPair_privateKey :: Lens' KeyPair (Maybe Text) Source #

The private key.

keyPair_publicKey :: Lens' KeyPair (Maybe Text) Source #

The public key.

KinesisAction

kinesisAction_partitionKey :: Lens' KinesisAction (Maybe Text) Source #

The partition key.

kinesisAction_roleArn :: Lens' KinesisAction Text Source #

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

kinesisAction_streamName :: Lens' KinesisAction Text Source #

The name of the Amazon Kinesis stream.

LambdaAction

lambdaAction_functionArn :: Lens' LambdaAction Text Source #

The ARN of the Lambda function.

LocationAction

locationAction_timestamp :: Lens' LocationAction (Maybe LocationTimestamp) Source #

The time that the location data was sampled. The default value is the time the MQTT message was processed.

locationAction_roleArn :: Lens' LocationAction Text Source #

The IAM role that grants permission to write to the Amazon Location resource.

locationAction_trackerName :: Lens' LocationAction Text Source #

The name of the tracker resource in Amazon Location in which the location is updated.

locationAction_deviceId :: Lens' LocationAction Text Source #

The unique ID of the device providing the location data.

locationAction_latitude :: Lens' LocationAction Text Source #

A string that evaluates to a double value that represents the latitude of the device's location.

locationAction_longitude :: Lens' LocationAction Text Source #

A string that evaluates to a double value that represents the longitude of the device's location.

LocationTimestamp

locationTimestamp_unit :: Lens' LocationTimestamp (Maybe Text) Source #

The precision of the timestamp value that results from the expression described in value.

Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. The default is MILLISECONDS.

locationTimestamp_value :: Lens' LocationTimestamp Text Source #

An expression that returns a long epoch time value.

LogTarget

logTarget_targetName :: Lens' LogTarget (Maybe Text) Source #

The target name.

logTarget_targetType :: Lens' LogTarget LogTargetType Source #

The target type.

LogTargetConfiguration

logTargetConfiguration_logLevel :: Lens' LogTargetConfiguration (Maybe LogLevel) Source #

The logging level.

logTargetConfiguration_logTarget :: Lens' LogTargetConfiguration (Maybe LogTarget) Source #

A log target

LoggingOptionsPayload

loggingOptionsPayload_logLevel :: Lens' LoggingOptionsPayload (Maybe LogLevel) Source #

The log level.

loggingOptionsPayload_roleArn :: Lens' LoggingOptionsPayload Text Source #

The ARN of the IAM role that grants access.

MachineLearningDetectionConfig

machineLearningDetectionConfig_confidenceLevel :: Lens' MachineLearningDetectionConfig ConfidenceLevel Source #

The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.

ManagedJobTemplateSummary

managedJobTemplateSummary_description :: Lens' ManagedJobTemplateSummary (Maybe Text) Source #

The description for a managed template.

managedJobTemplateSummary_environments :: Lens' ManagedJobTemplateSummary (Maybe [Text]) Source #

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

managedJobTemplateSummary_templateArn :: Lens' ManagedJobTemplateSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) for a managed template.

managedJobTemplateSummary_templateName :: Lens' ManagedJobTemplateSummary (Maybe Text) Source #

The unique Name for a managed template.

managedJobTemplateSummary_templateVersion :: Lens' ManagedJobTemplateSummary (Maybe Text) Source #

The version for a managed template.

MetricDatum

metricDatum_timestamp :: Lens' MetricDatum (Maybe UTCTime) Source #

The time the metric value was reported.

metricDatum_value :: Lens' MetricDatum (Maybe MetricValue) Source #

The value reported for the metric.

MetricDimension

metricDimension_operator :: Lens' MetricDimension (Maybe DimensionValueOperator) Source #

Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn't match any of the topic filters. The operator is optional: if it's not provided (is null), it will be interpreted as IN.

metricDimension_dimensionName :: Lens' MetricDimension Text Source #

A unique identifier for the dimension.

MetricToRetain

metricToRetain_metricDimension :: Lens' MetricToRetain (Maybe MetricDimension) Source #

The dimension of a metric. This can't be used with custom metrics.

metricToRetain_metric :: Lens' MetricToRetain Text Source #

What is measured by the behavior.

MetricValue

metricValue_cidrs :: Lens' MetricValue (Maybe [Text]) Source #

If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.

metricValue_count :: Lens' MetricValue (Maybe Natural) Source #

If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.

metricValue_number :: Lens' MetricValue (Maybe Double) Source #

The numeral value of a metric.

metricValue_numbers :: Lens' MetricValue (Maybe [Double]) Source #

The numeral values of a metric.

metricValue_ports :: Lens' MetricValue (Maybe [Natural]) Source #

If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.

metricValue_strings :: Lens' MetricValue (Maybe [Text]) Source #

The string values of a metric.

MitigationAction

mitigationAction_actionParams :: Lens' MitigationAction (Maybe MitigationActionParams) Source #

The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.

mitigationAction_id :: Lens' MitigationAction (Maybe Text) Source #

A unique identifier for the mitigation action.

mitigationAction_name :: Lens' MitigationAction (Maybe Text) Source #

A user-friendly name for the mitigation action.

mitigationAction_roleArn :: Lens' MitigationAction (Maybe Text) Source #

The IAM role ARN used to apply this mitigation action.

MitigationActionIdentifier

mitigationActionIdentifier_actionArn :: Lens' MitigationActionIdentifier (Maybe Text) Source #

The IAM role ARN used to apply this mitigation action.

mitigationActionIdentifier_actionName :: Lens' MitigationActionIdentifier (Maybe Text) Source #

The friendly name of the mitigation action.

mitigationActionIdentifier_creationDate :: Lens' MitigationActionIdentifier (Maybe UTCTime) Source #

The date when this mitigation action was created.

MitigationActionParams

mitigationActionParams_addThingsToThingGroupParams :: Lens' MitigationActionParams (Maybe AddThingsToThingGroupParams) Source #

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

mitigationActionParams_enableIoTLoggingParams :: Lens' MitigationActionParams (Maybe EnableIoTLoggingParams) Source #

Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.

mitigationActionParams_publishFindingToSnsParams :: Lens' MitigationActionParams (Maybe PublishFindingToSnsParams) Source #

Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

mitigationActionParams_replaceDefaultPolicyVersionParams :: Lens' MitigationActionParams (Maybe ReplaceDefaultPolicyVersionParams) Source #

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

mitigationActionParams_updateCACertificateParams :: Lens' MitigationActionParams (Maybe UpdateCACertificateParams) Source #

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

mitigationActionParams_updateDeviceCertificateParams :: Lens' MitigationActionParams (Maybe UpdateDeviceCertificateParams) Source #

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

MqttContext

mqttContext_clientId :: Lens' MqttContext (Maybe Text) Source #

The value of the clientId key in an MQTT authorization request.

mqttContext_password :: Lens' MqttContext (Maybe ByteString) Source #

The value of the password key in an MQTT authorization request.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

mqttContext_username :: Lens' MqttContext (Maybe Text) Source #

The value of the username key in an MQTT authorization request.

MqttHeaders

mqttHeaders_contentType :: Lens' MqttHeaders (Maybe Text) Source #

A UTF-8 encoded string that describes the content of the publishing message.

For more information, see Content Type from the MQTT Version 5.0 specification.

Supports substitution templates.

mqttHeaders_correlationData :: Lens' MqttHeaders (Maybe Text) Source #

The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.

For more information, see Correlation Data from the MQTT Version 5.0 specification.

This binary data must be based64-encoded.

Supports substitution templates.

mqttHeaders_messageExpiry :: Lens' MqttHeaders (Maybe Text) Source #

A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer relevant to the subscriber. The value of messageExpiry represents the number of seconds before it expires. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.

Supports substitution templates.

mqttHeaders_payloadFormatIndicator :: Lens' MqttHeaders (Maybe Text) Source #

An Enum string value that indicates whether the payload is formatted as UTF-8.

Valid values are UNSPECIFIED_BYTES and UTF8_DATA.

For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.

Supports substitution templates.

mqttHeaders_responseTopic :: Lens' MqttHeaders (Maybe Text) Source #

A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

For more information, see Response Topic from the MQTT Version 5.0 specification.

Supports substitution templates.

mqttHeaders_userProperties :: Lens' MqttHeaders (Maybe (NonEmpty UserProperty)) Source #

An array of key-value pairs that you define in the MQTT5 header.

NonCompliantResource

nonCompliantResource_additionalInfo :: Lens' NonCompliantResource (Maybe (HashMap Text Text)) Source #

Other information about the noncompliant resource.

nonCompliantResource_resourceIdentifier :: Lens' NonCompliantResource (Maybe ResourceIdentifier) Source #

Information that identifies the noncompliant resource.

nonCompliantResource_resourceType :: Lens' NonCompliantResource (Maybe ResourceType) Source #

The type of the noncompliant resource.

OTAUpdateFile

oTAUpdateFile_attributes :: Lens' OTAUpdateFile (Maybe (HashMap Text Text)) Source #

A list of name/attribute pairs.

oTAUpdateFile_codeSigning :: Lens' OTAUpdateFile (Maybe CodeSigning) Source #

The code signing method of the file.

oTAUpdateFile_fileLocation :: Lens' OTAUpdateFile (Maybe FileLocation) Source #

The location of the updated firmware.

oTAUpdateFile_fileName :: Lens' OTAUpdateFile (Maybe Text) Source #

The name of the file.

oTAUpdateFile_fileType :: Lens' OTAUpdateFile (Maybe Natural) Source #

An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.

oTAUpdateFile_fileVersion :: Lens' OTAUpdateFile (Maybe Text) Source #

The file version.

OTAUpdateInfo

oTAUpdateInfo_additionalParameters :: Lens' OTAUpdateInfo (Maybe (HashMap Text Text)) Source #

A collection of name/value pairs

oTAUpdateInfo_awsIotJobArn :: Lens' OTAUpdateInfo (Maybe Text) Source #

The IoT job ARN associated with the OTA update.

oTAUpdateInfo_awsIotJobId :: Lens' OTAUpdateInfo (Maybe Text) Source #

The IoT job ID associated with the OTA update.

oTAUpdateInfo_awsJobExecutionsRolloutConfig :: Lens' OTAUpdateInfo (Maybe AwsJobExecutionsRolloutConfig) Source #

Configuration for the rollout of OTA updates.

oTAUpdateInfo_awsJobPresignedUrlConfig :: Lens' OTAUpdateInfo (Maybe AwsJobPresignedUrlConfig) Source #

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

oTAUpdateInfo_creationDate :: Lens' OTAUpdateInfo (Maybe UTCTime) Source #

The date when the OTA update was created.

oTAUpdateInfo_description :: Lens' OTAUpdateInfo (Maybe Text) Source #

A description of the OTA update.

oTAUpdateInfo_errorInfo :: Lens' OTAUpdateInfo (Maybe ErrorInfo) Source #

Error information associated with the OTA update.

oTAUpdateInfo_lastModifiedDate :: Lens' OTAUpdateInfo (Maybe UTCTime) Source #

The date when the OTA update was last updated.

oTAUpdateInfo_otaUpdateArn :: Lens' OTAUpdateInfo (Maybe Text) Source #

The OTA update ARN.

oTAUpdateInfo_otaUpdateFiles :: Lens' OTAUpdateInfo (Maybe (NonEmpty OTAUpdateFile)) Source #

A list of files associated with the OTA update.

oTAUpdateInfo_otaUpdateId :: Lens' OTAUpdateInfo (Maybe Text) Source #

The OTA update ID.

oTAUpdateInfo_otaUpdateStatus :: Lens' OTAUpdateInfo (Maybe OTAUpdateStatus) Source #

The status of the OTA update.

oTAUpdateInfo_protocols :: Lens' OTAUpdateInfo (Maybe (NonEmpty Protocol)) Source #

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.

oTAUpdateInfo_targetSelection :: Lens' OTAUpdateInfo (Maybe TargetSelection) Source #

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

oTAUpdateInfo_targets :: Lens' OTAUpdateInfo (Maybe (NonEmpty Text)) Source #

The targets of the OTA update.

OTAUpdateSummary

oTAUpdateSummary_creationDate :: Lens' OTAUpdateSummary (Maybe UTCTime) Source #

The date when the OTA update was created.

oTAUpdateSummary_otaUpdateArn :: Lens' OTAUpdateSummary (Maybe Text) Source #

The OTA update ARN.

oTAUpdateSummary_otaUpdateId :: Lens' OTAUpdateSummary (Maybe Text) Source #

The OTA update ID.

OpenSearchAction

openSearchAction_roleArn :: Lens' OpenSearchAction Text Source #

The IAM role ARN that has access to OpenSearch.

openSearchAction_endpoint :: Lens' OpenSearchAction Text Source #

The endpoint of your OpenSearch domain.

openSearchAction_index :: Lens' OpenSearchAction Text Source #

The OpenSearch index where you want to store your data.

openSearchAction_type :: Lens' OpenSearchAction Text Source #

The type of document you are storing.

openSearchAction_id :: Lens' OpenSearchAction Text Source #

The unique identifier for the document you are storing.

OutgoingCertificate

outgoingCertificate_certificateArn :: Lens' OutgoingCertificate (Maybe Text) Source #

The certificate ARN.

outgoingCertificate_certificateId :: Lens' OutgoingCertificate (Maybe Text) Source #

The certificate ID.

outgoingCertificate_creationDate :: Lens' OutgoingCertificate (Maybe UTCTime) Source #

The certificate creation date.

outgoingCertificate_transferDate :: Lens' OutgoingCertificate (Maybe UTCTime) Source #

The date the transfer was initiated.

outgoingCertificate_transferMessage :: Lens' OutgoingCertificate (Maybe Text) Source #

The transfer message.

outgoingCertificate_transferredTo :: Lens' OutgoingCertificate (Maybe Text) Source #

The Amazon Web Services account to which the transfer was made.

PercentPair

percentPair_percent :: Lens' PercentPair (Maybe Double) Source #

The percentile.

percentPair_value :: Lens' PercentPair (Maybe Double) Source #

The value of the percentile.

Policy

policy_policyArn :: Lens' Policy (Maybe Text) Source #

The policy ARN.

policy_policyName :: Lens' Policy (Maybe Text) Source #

The policy name.

PolicyVersion

policyVersion_createDate :: Lens' PolicyVersion (Maybe UTCTime) Source #

The date and time the policy was created.

policyVersion_isDefaultVersion :: Lens' PolicyVersion (Maybe Bool) Source #

Specifies whether the policy version is the default.

policyVersion_versionId :: Lens' PolicyVersion (Maybe Text) Source #

The policy version ID.

PolicyVersionIdentifier

policyVersionIdentifier_policyName :: Lens' PolicyVersionIdentifier (Maybe Text) Source #

The name of the policy.

policyVersionIdentifier_policyVersionId :: Lens' PolicyVersionIdentifier (Maybe Text) Source #

The ID of the version of the policy associated with the resource.

PresignedUrlConfig

presignedUrlConfig_expiresInSec :: Lens' PresignedUrlConfig (Maybe Natural) Source #

How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.

presignedUrlConfig_roleArn :: Lens' PresignedUrlConfig (Maybe Text) Source #

The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.

For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.

ProvisioningHook

provisioningHook_payloadVersion :: Lens' ProvisioningHook (Maybe Text) Source #

The payload that was sent to the target function.

Note: Only Lambda functions are currently supported.

provisioningHook_targetArn :: Lens' ProvisioningHook Text Source #

The ARN of the target function.

Note: Only Lambda functions are currently supported.

ProvisioningTemplateSummary

provisioningTemplateSummary_creationDate :: Lens' ProvisioningTemplateSummary (Maybe UTCTime) Source #

The date when the provisioning template summary was created.

provisioningTemplateSummary_description :: Lens' ProvisioningTemplateSummary (Maybe Text) Source #

The description of the provisioning template.

provisioningTemplateSummary_enabled :: Lens' ProvisioningTemplateSummary (Maybe Bool) Source #

True if the fleet provision template is enabled, otherwise false.

provisioningTemplateSummary_lastModifiedDate :: Lens' ProvisioningTemplateSummary (Maybe UTCTime) Source #

The date when the provisioning template summary was last modified.

provisioningTemplateSummary_templateArn :: Lens' ProvisioningTemplateSummary (Maybe Text) Source #

The ARN of the provisioning template.

provisioningTemplateSummary_templateName :: Lens' ProvisioningTemplateSummary (Maybe Text) Source #

The name of the provisioning template.

provisioningTemplateSummary_type :: Lens' ProvisioningTemplateSummary (Maybe TemplateType) Source #

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

ProvisioningTemplateVersionSummary

provisioningTemplateVersionSummary_creationDate :: Lens' ProvisioningTemplateVersionSummary (Maybe UTCTime) Source #

The date when the provisioning template version was created

provisioningTemplateVersionSummary_isDefaultVersion :: Lens' ProvisioningTemplateVersionSummary (Maybe Bool) Source #

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

provisioningTemplateVersionSummary_versionId :: Lens' ProvisioningTemplateVersionSummary (Maybe Int) Source #

The ID of the fleet provisioning template version.

PublishFindingToSnsParams

publishFindingToSnsParams_topicArn :: Lens' PublishFindingToSnsParams Text Source #

The ARN of the topic to which you want to publish the findings.

PutAssetPropertyValueEntry

putAssetPropertyValueEntry_assetId :: Lens' PutAssetPropertyValueEntry (Maybe Text) Source #

The ID of the IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.

putAssetPropertyValueEntry_entryId :: Lens' PutAssetPropertyValueEntry (Maybe Text) Source #

Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.

putAssetPropertyValueEntry_propertyAlias :: Lens' PutAssetPropertyValueEntry (Maybe Text) Source #

The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.

putAssetPropertyValueEntry_propertyId :: Lens' PutAssetPropertyValueEntry (Maybe Text) Source #

The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId. Accepts substitution templates.

putAssetPropertyValueEntry_propertyValues :: Lens' PutAssetPropertyValueEntry (NonEmpty AssetPropertyValue) Source #

A list of property values to insert that each contain timestamp, quality, and value (TQV) information.

PutItemInput

putItemInput_tableName :: Lens' PutItemInput Text Source #

The table where the message data will be written.

RateIncreaseCriteria

rateIncreaseCriteria_numberOfNotifiedThings :: Lens' RateIncreaseCriteria (Maybe Natural) Source #

The threshold for number of notified things that will initiate the increase in rate of rollout.

rateIncreaseCriteria_numberOfSucceededThings :: Lens' RateIncreaseCriteria (Maybe Natural) Source #

The threshold for number of succeeded things that will initiate the increase in rate of rollout.

RegistrationConfig

registrationConfig_roleArn :: Lens' RegistrationConfig (Maybe Text) Source #

The ARN of the role.

registrationConfig_templateBody :: Lens' RegistrationConfig (Maybe Text) Source #

The template body.

registrationConfig_templateName :: Lens' RegistrationConfig (Maybe Text) Source #

The name of the provisioning template.

RelatedResource

relatedResource_additionalInfo :: Lens' RelatedResource (Maybe (HashMap Text Text)) Source #

Other information about the resource.

relatedResource_resourceIdentifier :: Lens' RelatedResource (Maybe ResourceIdentifier) Source #

Information that identifies the resource.

relatedResource_resourceType :: Lens' RelatedResource (Maybe ResourceType) Source #

The type of resource.

ReplaceDefaultPolicyVersionParams

replaceDefaultPolicyVersionParams_templateName :: Lens' ReplaceDefaultPolicyVersionParams PolicyTemplateName Source #

The name of the template to be applied. The only supported value is BLANK_POLICY.

RepublishAction

republishAction_headers :: Lens' RepublishAction (Maybe MqttHeaders) Source #

MQTT Version 5.0 headers information. For more information, see MQTT from the Amazon Web Services IoT Core Developer Guide.

republishAction_qos :: Lens' RepublishAction (Maybe Natural) Source #

The Quality of Service (QoS) level to use when republishing messages. The default value is 0.

republishAction_roleArn :: Lens' RepublishAction Text Source #

The ARN of the IAM role that grants access.

republishAction_topic :: Lens' RepublishAction Text Source #

The name of the MQTT topic.

ResourceIdentifier

resourceIdentifier_account :: Lens' ResourceIdentifier (Maybe Text) Source #

The account with which the resource is associated.

resourceIdentifier_caCertificateId :: Lens' ResourceIdentifier (Maybe Text) Source #

The ID of the CA certificate used to authorize the certificate.

resourceIdentifier_clientId :: Lens' ResourceIdentifier (Maybe Text) Source #

The client ID.

resourceIdentifier_cognitoIdentityPoolId :: Lens' ResourceIdentifier (Maybe Text) Source #

The ID of the Amazon Cognito identity pool.

resourceIdentifier_deviceCertificateArn :: Lens' ResourceIdentifier (Maybe Text) Source #

The ARN of the identified device certificate.

resourceIdentifier_deviceCertificateId :: Lens' ResourceIdentifier (Maybe Text) Source #

The ID of the certificate attached to the resource.

resourceIdentifier_iamRoleArn :: Lens' ResourceIdentifier (Maybe Text) Source #

The ARN of the IAM role that has overly permissive actions.

resourceIdentifier_issuerCertificateIdentifier :: Lens' ResourceIdentifier (Maybe IssuerCertificateIdentifier) Source #

The issuer certificate identifier.

resourceIdentifier_policyVersionIdentifier :: Lens' ResourceIdentifier (Maybe PolicyVersionIdentifier) Source #

The version of the policy associated with the resource.

resourceIdentifier_roleAliasArn :: Lens' ResourceIdentifier (Maybe Text) Source #

The ARN of the role alias that has overly permissive actions.

RetryCriteria

retryCriteria_failureType :: Lens' RetryCriteria RetryableFailureType Source #

The type of job execution failures that can initiate a job retry.

retryCriteria_numberOfRetries :: Lens' RetryCriteria Natural Source #

The number of retries allowed for a failure type for the job.

RoleAliasDescription

roleAliasDescription_creationDate :: Lens' RoleAliasDescription (Maybe UTCTime) Source #

The UNIX timestamp of when the role alias was created.

roleAliasDescription_credentialDurationSeconds :: Lens' RoleAliasDescription (Maybe Natural) Source #

The number of seconds for which the credential is valid.

roleAliasDescription_lastModifiedDate :: Lens' RoleAliasDescription (Maybe UTCTime) Source #

The UNIX timestamp of when the role alias was last modified.

roleAliasDescription_owner :: Lens' RoleAliasDescription (Maybe Text) Source #

The role alias owner.

roleAliasDescription_roleAlias :: Lens' RoleAliasDescription (Maybe Text) Source #

The role alias.

roleAliasDescription_roleAliasArn :: Lens' RoleAliasDescription (Maybe Text) Source #

The ARN of the role alias.

roleAliasDescription_roleArn :: Lens' RoleAliasDescription (Maybe Text) Source #

The role ARN.

S3Action

s3Action_cannedAcl :: Lens' S3Action (Maybe CannedAccessControlList) Source #

The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.

s3Action_roleArn :: Lens' S3Action Text Source #

The ARN of the IAM role that grants access.

s3Action_bucketName :: Lens' S3Action Text Source #

The Amazon S3 bucket.

s3Action_key :: Lens' S3Action Text Source #

The object key. For more information, see Actions, resources, and condition keys for Amazon S3.

S3Destination

s3Destination_bucket :: Lens' S3Destination (Maybe Text) Source #

The S3 bucket that contains the updated firmware.

s3Destination_prefix :: Lens' S3Destination (Maybe Text) Source #

The S3 prefix.

S3Location

s3Location_bucket :: Lens' S3Location (Maybe Text) Source #

The S3 bucket.

s3Location_key :: Lens' S3Location (Maybe Text) Source #

The S3 key.

s3Location_version :: Lens' S3Location (Maybe Text) Source #

The S3 bucket version.

SalesforceAction

salesforceAction_token :: Lens' SalesforceAction Text Source #

The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream.

salesforceAction_url :: Lens' SalesforceAction Text Source #

The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream.

ScheduledAuditMetadata

scheduledAuditMetadata_dayOfMonth :: Lens' ScheduledAuditMetadata (Maybe Text) Source #

The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

scheduledAuditMetadata_dayOfWeek :: Lens' ScheduledAuditMetadata (Maybe DayOfWeek) Source #

The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").

scheduledAuditMetadata_frequency :: Lens' ScheduledAuditMetadata (Maybe AuditFrequency) Source #

How often the scheduled audit occurs.

scheduledAuditMetadata_scheduledAuditArn :: Lens' ScheduledAuditMetadata (Maybe Text) Source #

The ARN of the scheduled audit.

scheduledAuditMetadata_scheduledAuditName :: Lens' ScheduledAuditMetadata (Maybe Text) Source #

The name of the scheduled audit.

SchedulingConfig

schedulingConfig_endBehavior :: Lens' SchedulingConfig (Maybe JobEndBehavior) Source #

Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.

schedulingConfig_endTime :: Lens' SchedulingConfig (Maybe Text) Source #

The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years.

schedulingConfig_startTime :: Lens' SchedulingConfig (Maybe Text) Source #

The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time.

SecurityProfileIdentifier

securityProfileIdentifier_name :: Lens' SecurityProfileIdentifier Text Source #

The name you've given to the security profile.

securityProfileIdentifier_arn :: Lens' SecurityProfileIdentifier Text Source #

The ARN of the security profile.

SecurityProfileTarget

securityProfileTarget_arn :: Lens' SecurityProfileTarget Text Source #

The ARN of the security profile.

SecurityProfileTargetMapping

securityProfileTargetMapping_securityProfileIdentifier :: Lens' SecurityProfileTargetMapping (Maybe SecurityProfileIdentifier) Source #

Information that identifies the security profile.

securityProfileTargetMapping_target :: Lens' SecurityProfileTargetMapping (Maybe SecurityProfileTarget) Source #

Information about the target (thing group) associated with the security profile.

ServerCertificateSummary

serverCertificateSummary_serverCertificateArn :: Lens' ServerCertificateSummary (Maybe Text) Source #

The ARN of the server certificate.

serverCertificateSummary_serverCertificateStatus :: Lens' ServerCertificateSummary (Maybe ServerCertificateStatus) Source #

The status of the server certificate.

serverCertificateSummary_serverCertificateStatusDetail :: Lens' ServerCertificateSummary (Maybe Text) Source #

Details that explain the status of the server certificate.

SigV4Authorization

sigV4Authorization_signingRegion :: Lens' SigV4Authorization Text Source #

The signing region.

sigV4Authorization_serviceName :: Lens' SigV4Authorization Text Source #

The service name to use while signing with Sig V4.

sigV4Authorization_roleArn :: Lens' SigV4Authorization Text Source #

The ARN of the signing role.

SigningProfileParameter

signingProfileParameter_certificateArn :: Lens' SigningProfileParameter (Maybe Text) Source #

Certificate ARN.

signingProfileParameter_certificatePathOnDevice :: Lens' SigningProfileParameter (Maybe Text) Source #

The location of the code-signing certificate on your device.

signingProfileParameter_platform :: Lens' SigningProfileParameter (Maybe Text) Source #

The hardware platform of your device.

SnsAction

snsAction_messageFormat :: Lens' SnsAction (Maybe MessageFormat) Source #

(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

snsAction_targetArn :: Lens' SnsAction Text Source #

The ARN of the SNS topic.

snsAction_roleArn :: Lens' SnsAction Text Source #

The ARN of the IAM role that grants access.

SqsAction

sqsAction_useBase64 :: Lens' SqsAction (Maybe Bool) Source #

Specifies whether to use Base64 encoding.

sqsAction_roleArn :: Lens' SqsAction Text Source #

The ARN of the IAM role that grants access.

sqsAction_queueUrl :: Lens' SqsAction Text Source #

The URL of the Amazon SQS queue.

StartSigningJobParameter

startSigningJobParameter_destination :: Lens' StartSigningJobParameter (Maybe Destination) Source #

The location to write the code-signed file.

startSigningJobParameter_signingProfileName :: Lens' StartSigningJobParameter (Maybe Text) Source #

The code-signing profile name.

startSigningJobParameter_signingProfileParameter :: Lens' StartSigningJobParameter (Maybe SigningProfileParameter) Source #

Describes the code-signing profile.

StatisticalThreshold

statisticalThreshold_statistic :: Lens' StatisticalThreshold (Maybe Text) Source #

The percentile that resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

Statistics

statistics_average :: Lens' Statistics (Maybe Double) Source #

The average of the aggregated field values.

statistics_count :: Lens' Statistics (Maybe Int) Source #

The count of things that match the query string criteria and contain a valid aggregation field value.

statistics_maximum :: Lens' Statistics (Maybe Double) Source #

The maximum aggregated field value.

statistics_minimum :: Lens' Statistics (Maybe Double) Source #

The minimum aggregated field value.

statistics_stdDeviation :: Lens' Statistics (Maybe Double) Source #

The standard deviation of the aggregated field values.

statistics_sum :: Lens' Statistics (Maybe Double) Source #

The sum of the aggregated field values.

statistics_sumOfSquares :: Lens' Statistics (Maybe Double) Source #

The sum of the squares of the aggregated field values.

statistics_variance :: Lens' Statistics (Maybe Double) Source #

The variance of the aggregated field values.

StepFunctionsAction

stepFunctionsAction_executionNamePrefix :: Lens' StepFunctionsAction (Maybe Text) Source #

(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

stepFunctionsAction_stateMachineName :: Lens' StepFunctionsAction Text Source #

The name of the Step Functions state machine whose execution will be started.

stepFunctionsAction_roleArn :: Lens' StepFunctionsAction Text Source #

The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

Stream

stream_fileId :: Lens' Stream (Maybe Natural) Source #

The ID of a file associated with a stream.

stream_streamId :: Lens' Stream (Maybe Text) Source #

The stream ID.

StreamFile

streamFile_fileId :: Lens' StreamFile (Maybe Natural) Source #

The file ID.

streamFile_s3Location :: Lens' StreamFile (Maybe S3Location) Source #

The location of the file in S3.

StreamInfo

streamInfo_createdAt :: Lens' StreamInfo (Maybe UTCTime) Source #

The date when the stream was created.

streamInfo_description :: Lens' StreamInfo (Maybe Text) Source #

The description of the stream.

streamInfo_files :: Lens' StreamInfo (Maybe (NonEmpty StreamFile)) Source #

The files to stream.

streamInfo_lastUpdatedAt :: Lens' StreamInfo (Maybe UTCTime) Source #

The date when the stream was last updated.

streamInfo_roleArn :: Lens' StreamInfo (Maybe Text) Source #

An IAM role IoT assumes to access your S3 files.

streamInfo_streamArn :: Lens' StreamInfo (Maybe Text) Source #

The stream ARN.

streamInfo_streamId :: Lens' StreamInfo (Maybe Text) Source #

The stream ID.

streamInfo_streamVersion :: Lens' StreamInfo (Maybe Natural) Source #

The stream version.

StreamSummary

streamSummary_description :: Lens' StreamSummary (Maybe Text) Source #

A description of the stream.

streamSummary_streamArn :: Lens' StreamSummary (Maybe Text) Source #

The stream ARN.

streamSummary_streamId :: Lens' StreamSummary (Maybe Text) Source #

The stream ID.

streamSummary_streamVersion :: Lens' StreamSummary (Maybe Natural) Source #

The stream version.

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

The tag's value.

tag_key :: Lens' Tag Text Source #

The tag's key.

TaskStatistics

taskStatistics_canceledChecks :: Lens' TaskStatistics (Maybe Int) Source #

The number of checks that did not run because the audit was canceled.

taskStatistics_compliantChecks :: Lens' TaskStatistics (Maybe Int) Source #

The number of checks that found compliant resources.

taskStatistics_failedChecks :: Lens' TaskStatistics (Maybe Int) Source #

The number of checks.

taskStatistics_inProgressChecks :: Lens' TaskStatistics (Maybe Int) Source #

The number of checks in progress.

taskStatistics_nonCompliantChecks :: Lens' TaskStatistics (Maybe Int) Source #

The number of checks that found noncompliant resources.

taskStatistics_totalChecks :: Lens' TaskStatistics (Maybe Int) Source #

The number of checks in this audit.

taskStatistics_waitingForDataCollectionChecks :: Lens' TaskStatistics (Maybe Int) Source #

The number of checks waiting for data collection.

TaskStatisticsForAuditCheck

taskStatisticsForAuditCheck_canceledFindingsCount :: Lens' TaskStatisticsForAuditCheck (Maybe Integer) Source #

The number of findings to which the mitigation action task was canceled when applied.

taskStatisticsForAuditCheck_failedFindingsCount :: Lens' TaskStatisticsForAuditCheck (Maybe Integer) Source #

The number of findings for which at least one of the actions failed when applied.

taskStatisticsForAuditCheck_skippedFindingsCount :: Lens' TaskStatisticsForAuditCheck (Maybe Integer) Source #

The number of findings skipped because of filter conditions provided in the parameters to the command.

taskStatisticsForAuditCheck_succeededFindingsCount :: Lens' TaskStatisticsForAuditCheck (Maybe Integer) Source #

The number of findings for which all mitigation actions succeeded when applied.

taskStatisticsForAuditCheck_totalFindingsCount :: Lens' TaskStatisticsForAuditCheck (Maybe Integer) Source #

The total number of findings to which a task is being applied.

TermsAggregation

termsAggregation_maxBuckets :: Lens' TermsAggregation (Maybe Natural) Source #

The number of buckets to return in the response. Default to 10.

ThingAttribute

thingAttribute_attributes :: Lens' ThingAttribute (Maybe (HashMap Text Text)) Source #

A list of thing attributes which are name-value pairs.

thingAttribute_thingArn :: Lens' ThingAttribute (Maybe Text) Source #

The thing ARN.

thingAttribute_thingName :: Lens' ThingAttribute (Maybe Text) Source #

The name of the thing.

thingAttribute_thingTypeName :: Lens' ThingAttribute (Maybe Text) Source #

The name of the thing type, if the thing has been associated with a type.

thingAttribute_version :: Lens' ThingAttribute (Maybe Integer) Source #

The version of the thing record in the registry.

ThingConnectivity

thingConnectivity_connected :: Lens' ThingConnectivity (Maybe Bool) Source #

True if the thing is connected to the Amazon Web Services IoT Core service; false if it is not connected.

thingConnectivity_disconnectReason :: Lens' ThingConnectivity (Maybe Text) Source #

The reason why the client is disconnected. If the thing has been disconnected for approximately an hour, the disconnectReason value might be missing.

thingConnectivity_timestamp :: Lens' ThingConnectivity (Maybe Integer) Source #

The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for approximately an hour, the time value might be missing.

ThingDocument

thingDocument_attributes :: Lens' ThingDocument (Maybe (HashMap Text Text)) Source #

The attributes.

thingDocument_connectivity :: Lens' ThingDocument (Maybe ThingConnectivity) Source #

Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

thingDocument_deviceDefender :: Lens' ThingDocument (Maybe Text) Source #

Contains Device Defender data.

For more information about Device Defender, see Device Defender.

thingDocument_shadow :: Lens' ThingDocument (Maybe Text) Source #

The unnamed shadow and named shadow.

For more information about shadows, see IoT Device Shadow service.

thingDocument_thingGroupNames :: Lens' ThingDocument (Maybe [Text]) Source #

Thing group names.

thingDocument_thingId :: Lens' ThingDocument (Maybe Text) Source #

The thing ID.

thingDocument_thingName :: Lens' ThingDocument (Maybe Text) Source #

The thing name.

thingDocument_thingTypeName :: Lens' ThingDocument (Maybe Text) Source #

The thing type name.

ThingGroupDocument

thingGroupDocument_attributes :: Lens' ThingGroupDocument (Maybe (HashMap Text Text)) Source #

The thing group attributes.

thingGroupDocument_parentGroupNames :: Lens' ThingGroupDocument (Maybe [Text]) Source #

Parent group names.

thingGroupDocument_thingGroupDescription :: Lens' ThingGroupDocument (Maybe Text) Source #

The thing group description.

thingGroupDocument_thingGroupId :: Lens' ThingGroupDocument (Maybe Text) Source #

The thing group ID.

thingGroupDocument_thingGroupName :: Lens' ThingGroupDocument (Maybe Text) Source #

The thing group name.

ThingGroupIndexingConfiguration

thingGroupIndexingConfiguration_customFields :: Lens' ThingGroupIndexingConfiguration (Maybe [Field]) Source #

A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

Contains custom field names and their data type.

thingGroupIndexingConfiguration_managedFields :: Lens' ThingGroupIndexingConfiguration (Maybe [Field]) Source #

Contains fields that are indexed and whose types are already known by the Fleet Indexing service. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide.

thingGroupIndexingConfiguration_thingGroupIndexingMode :: Lens' ThingGroupIndexingConfiguration ThingGroupIndexingMode Source #

Thing group indexing mode.

ThingGroupMetadata

thingGroupMetadata_creationDate :: Lens' ThingGroupMetadata (Maybe UTCTime) Source #

The UNIX timestamp of when the thing group was created.

thingGroupMetadata_parentGroupName :: Lens' ThingGroupMetadata (Maybe Text) Source #

The parent thing group name.

thingGroupMetadata_rootToParentThingGroups :: Lens' ThingGroupMetadata (Maybe [GroupNameAndArn]) Source #

The root parent thing group.

ThingGroupProperties

thingGroupProperties_attributePayload :: Lens' ThingGroupProperties (Maybe AttributePayload) Source #

The thing group attributes in JSON format.

thingGroupProperties_thingGroupDescription :: Lens' ThingGroupProperties (Maybe Text) Source #

The thing group description.

ThingIndexingConfiguration

thingIndexingConfiguration_customFields :: Lens' ThingIndexingConfiguration (Maybe [Field]) Source #

Contains custom field names and their data type.

thingIndexingConfiguration_deviceDefenderIndexingMode :: Lens' ThingIndexingConfiguration (Maybe DeviceDefenderIndexingMode) Source #

Device Defender indexing mode. Valid values are:

  • VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.
  • OFF - Device Defender indexing is disabled.

For more information about Device Defender violations, see Device Defender Detect.

thingIndexingConfiguration_filter :: Lens' ThingIndexingConfiguration (Maybe IndexingFilter) Source #

Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.

thingIndexingConfiguration_managedFields :: Lens' ThingIndexingConfiguration (Maybe [Field]) Source #

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

thingIndexingConfiguration_namedShadowIndexingMode :: Lens' ThingIndexingConfiguration (Maybe NamedShadowIndexingMode) Source #

Named shadow indexing mode. Valid values are:

  • ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.
  • OFF - Named shadow indexing is disabled.

For more information about Shadows, see IoT Device Shadow service.

thingIndexingConfiguration_thingConnectivityIndexingMode :: Lens' ThingIndexingConfiguration (Maybe ThingConnectivityIndexingMode) Source #

Thing connectivity indexing mode. Valid values are:

  • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.
  • OFF - Thing connectivity status indexing is disabled.

thingIndexingConfiguration_thingIndexingMode :: Lens' ThingIndexingConfiguration ThingIndexingMode Source #

Thing indexing mode. Valid values are:

  • REGISTRY – Your thing index contains registry data only.
  • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
  • OFF - Thing indexing is disabled.

ThingTypeDefinition

thingTypeDefinition_thingTypeArn :: Lens' ThingTypeDefinition (Maybe Text) Source #

The thing type ARN.

thingTypeDefinition_thingTypeMetadata :: Lens' ThingTypeDefinition (Maybe ThingTypeMetadata) Source #

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.

thingTypeDefinition_thingTypeName :: Lens' ThingTypeDefinition (Maybe Text) Source #

The name of the thing type.

thingTypeDefinition_thingTypeProperties :: Lens' ThingTypeDefinition (Maybe ThingTypeProperties) Source #

The ThingTypeProperties for the thing type.

ThingTypeMetadata

thingTypeMetadata_creationDate :: Lens' ThingTypeMetadata (Maybe UTCTime) Source #

The date and time when the thing type was created.

thingTypeMetadata_deprecated :: Lens' ThingTypeMetadata (Maybe Bool) Source #

Whether the thing type is deprecated. If true, no new things could be associated with this type.

thingTypeMetadata_deprecationDate :: Lens' ThingTypeMetadata (Maybe UTCTime) Source #

The date and time when the thing type was deprecated.

ThingTypeProperties

thingTypeProperties_searchableAttributes :: Lens' ThingTypeProperties (Maybe [Text]) Source #

A list of searchable thing attribute names.

thingTypeProperties_thingTypeDescription :: Lens' ThingTypeProperties (Maybe Text) Source #

The description of the thing type.

TimeoutConfig

timeoutConfig_inProgressTimeoutInMinutes :: Lens' TimeoutConfig (Maybe Integer) Source #

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

TimestreamAction

timestreamAction_timestamp :: Lens' TimestreamAction (Maybe TimestreamTimestamp) Source #

Specifies an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column.

You can use this property to specify the value and the precision of the Timestream record's timestamp. You can specify a value from the message payload or a value computed by a substitution template.

If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it processed the rule.

timestreamAction_roleArn :: Lens' TimestreamAction Text Source #

The ARN of the role that grants permission to write to the Amazon Timestream database table.

timestreamAction_databaseName :: Lens' TimestreamAction Text Source #

The name of an Amazon Timestream database.

timestreamAction_tableName :: Lens' TimestreamAction Text Source #

The name of the database table into which to write the measure records.

timestreamAction_dimensions :: Lens' TimestreamAction (NonEmpty TimestreamDimension) Source #

Metadata attributes of the time series that are written in each measure record.

TimestreamDimension

timestreamDimension_name :: Lens' TimestreamDimension Text Source #

The metadata dimension name. This is the name of the column in the Amazon Timestream database table record.

Dimensions cannot be named: measure_name, measure_value, or time. These names are reserved. Dimension names cannot start with ts_ or measure_value and they cannot contain the colon (:) character.

timestreamDimension_value :: Lens' TimestreamDimension Text Source #

The value to write in this column of the database record.

TimestreamTimestamp

timestreamTimestamp_value :: Lens' TimestreamTimestamp Text Source #

An expression that returns a long epoch time value.

timestreamTimestamp_unit :: Lens' TimestreamTimestamp Text Source #

The precision of the timestamp value that results from the expression described in value.

Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. The default is MILLISECONDS.

TlsContext

tlsContext_serverName :: Lens' TlsContext (Maybe Text) Source #

The value of the serverName key in a TLS authorization request.

TopicRule

topicRule_actions :: Lens' TopicRule (Maybe [Action]) Source #

The actions associated with the rule.

topicRule_awsIotSqlVersion :: Lens' TopicRule (Maybe Text) Source #

The version of the SQL rules engine to use when evaluating the rule.

topicRule_createdAt :: Lens' TopicRule (Maybe UTCTime) Source #

The date and time the rule was created.

topicRule_description :: Lens' TopicRule (Maybe Text) Source #

The description of the rule.

topicRule_errorAction :: Lens' TopicRule (Maybe Action) Source #

The action to perform when an error occurs.

topicRule_ruleDisabled :: Lens' TopicRule (Maybe Bool) Source #

Specifies whether the rule is disabled.

topicRule_ruleName :: Lens' TopicRule (Maybe Text) Source #

The name of the rule.

topicRule_sql :: Lens' TopicRule (Maybe Text) Source #

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

TopicRuleDestination

topicRuleDestination_arn :: Lens' TopicRuleDestination (Maybe Text) Source #

The topic rule destination URL.

topicRuleDestination_createdAt :: Lens' TopicRuleDestination (Maybe UTCTime) Source #

The date and time when the topic rule destination was created.

topicRuleDestination_httpUrlProperties :: Lens' TopicRuleDestination (Maybe HttpUrlDestinationProperties) Source #

Properties of the HTTP URL.

topicRuleDestination_lastUpdatedAt :: Lens' TopicRuleDestination (Maybe UTCTime) Source #

The date and time when the topic rule destination was last updated.

topicRuleDestination_status :: Lens' TopicRuleDestination (Maybe TopicRuleDestinationStatus) Source #

The status of the topic rule destination. Valid values are:

IN_PROGRESS
A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
ENABLED
Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.
DISABLED
Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
ERROR
Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

topicRuleDestination_statusReason :: Lens' TopicRuleDestination (Maybe Text) Source #

Additional details or reason why the topic rule destination is in the current status.

topicRuleDestination_vpcProperties :: Lens' TopicRuleDestination (Maybe VpcDestinationProperties) Source #

Properties of the virtual private cloud (VPC) connection.

TopicRuleDestinationConfiguration

topicRuleDestinationConfiguration_httpUrlConfiguration :: Lens' TopicRuleDestinationConfiguration (Maybe HttpUrlDestinationConfiguration) Source #

Configuration of the HTTP URL.

topicRuleDestinationConfiguration_vpcConfiguration :: Lens' TopicRuleDestinationConfiguration (Maybe VpcDestinationConfiguration) Source #

Configuration of the virtual private cloud (VPC) connection.

TopicRuleDestinationSummary

topicRuleDestinationSummary_arn :: Lens' TopicRuleDestinationSummary (Maybe Text) Source #

The topic rule destination ARN.

topicRuleDestinationSummary_createdAt :: Lens' TopicRuleDestinationSummary (Maybe UTCTime) Source #

The date and time when the topic rule destination was created.

topicRuleDestinationSummary_httpUrlSummary :: Lens' TopicRuleDestinationSummary (Maybe HttpUrlDestinationSummary) Source #

Information about the HTTP URL.

topicRuleDestinationSummary_lastUpdatedAt :: Lens' TopicRuleDestinationSummary (Maybe UTCTime) Source #

The date and time when the topic rule destination was last updated.

topicRuleDestinationSummary_status :: Lens' TopicRuleDestinationSummary (Maybe TopicRuleDestinationStatus) Source #

The status of the topic rule destination. Valid values are:

IN_PROGRESS
A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.
ENABLED
Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.
DISABLED
Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.
ERROR
Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

topicRuleDestinationSummary_statusReason :: Lens' TopicRuleDestinationSummary (Maybe Text) Source #

The reason the topic rule destination is in the current status.

topicRuleDestinationSummary_vpcDestinationSummary :: Lens' TopicRuleDestinationSummary (Maybe VpcDestinationSummary) Source #

Information about the virtual private cloud (VPC) connection.

TopicRuleListItem

topicRuleListItem_createdAt :: Lens' TopicRuleListItem (Maybe UTCTime) Source #

The date and time the rule was created.

topicRuleListItem_ruleArn :: Lens' TopicRuleListItem (Maybe Text) Source #

The rule ARN.

topicRuleListItem_ruleDisabled :: Lens' TopicRuleListItem (Maybe Bool) Source #

Specifies whether the rule is disabled.

topicRuleListItem_ruleName :: Lens' TopicRuleListItem (Maybe Text) Source #

The name of the rule.

topicRuleListItem_topicPattern :: Lens' TopicRuleListItem (Maybe Text) Source #

The pattern for the topic names that apply.

TopicRulePayload

topicRulePayload_awsIotSqlVersion :: Lens' TopicRulePayload (Maybe Text) Source #

The version of the SQL rules engine to use when evaluating the rule.

topicRulePayload_description :: Lens' TopicRulePayload (Maybe Text) Source #

The description of the rule.

topicRulePayload_errorAction :: Lens' TopicRulePayload (Maybe Action) Source #

The action to take when an error occurs.

topicRulePayload_ruleDisabled :: Lens' TopicRulePayload (Maybe Bool) Source #

Specifies whether the rule is disabled.

topicRulePayload_sql :: Lens' TopicRulePayload Text Source #

The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.

topicRulePayload_actions :: Lens' TopicRulePayload [Action] Source #

The actions associated with the rule.

TransferData

transferData_acceptDate :: Lens' TransferData (Maybe UTCTime) Source #

The date the transfer was accepted.

transferData_rejectDate :: Lens' TransferData (Maybe UTCTime) Source #

The date the transfer was rejected.

transferData_rejectReason :: Lens' TransferData (Maybe Text) Source #

The reason why the transfer was rejected.

transferData_transferDate :: Lens' TransferData (Maybe UTCTime) Source #

The date the transfer took place.

transferData_transferMessage :: Lens' TransferData (Maybe Text) Source #

The transfer message.

UpdateCACertificateParams

updateCACertificateParams_action :: Lens' UpdateCACertificateParams CACertificateUpdateAction Source #

The action that you want to apply to the CA certificate. The only supported value is DEACTIVATE.

UpdateDeviceCertificateParams

updateDeviceCertificateParams_action :: Lens' UpdateDeviceCertificateParams DeviceCertificateUpdateAction Source #

The action that you want to apply to the device certificate. The only supported value is DEACTIVATE.

UserProperty

userProperty_key :: Lens' UserProperty Text Source #

A key to be specified in UserProperty.

userProperty_value :: Lens' UserProperty Text Source #

A value to be specified in UserProperty.

ValidationError

validationError_errorMessage :: Lens' ValidationError (Maybe Text) Source #

The description of an error found in the behaviors.

ViolationEvent

violationEvent_behavior :: Lens' ViolationEvent (Maybe Behavior) Source #

The behavior that was violated.

violationEvent_metricValue :: Lens' ViolationEvent (Maybe MetricValue) Source #

The value of the metric (the measurement).

violationEvent_securityProfileName :: Lens' ViolationEvent (Maybe Text) Source #

The name of the security profile whose behavior was violated.

violationEvent_thingName :: Lens' ViolationEvent (Maybe Text) Source #

The name of the thing responsible for the violation event.

violationEvent_verificationState :: Lens' ViolationEvent (Maybe VerificationState) Source #

The verification state of the violation (detect alarm).

violationEvent_verificationStateDescription :: Lens' ViolationEvent (Maybe Text) Source #

The description of the verification state of the violation.

violationEvent_violationEventAdditionalInfo :: Lens' ViolationEvent (Maybe ViolationEventAdditionalInfo) Source #

The details of a violation event.

violationEvent_violationEventTime :: Lens' ViolationEvent (Maybe UTCTime) Source #

The time the violation event occurred.

violationEvent_violationEventType :: Lens' ViolationEvent (Maybe ViolationEventType) Source #

The type of violation event.

violationEvent_violationId :: Lens' ViolationEvent (Maybe Text) Source #

The ID of the violation event.

ViolationEventAdditionalInfo

violationEventAdditionalInfo_confidenceLevel :: Lens' ViolationEventAdditionalInfo (Maybe ConfidenceLevel) Source #

The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.

ViolationEventOccurrenceRange

violationEventOccurrenceRange_startTime :: Lens' ViolationEventOccurrenceRange UTCTime Source #

The start date and time of a time period in which violation events occurred.

violationEventOccurrenceRange_endTime :: Lens' ViolationEventOccurrenceRange UTCTime Source #

The end date and time of a time period in which violation events occurred.

VpcDestinationConfiguration

vpcDestinationConfiguration_securityGroups :: Lens' VpcDestinationConfiguration (Maybe [Text]) Source #

The security groups of the VPC destination.

vpcDestinationConfiguration_subnetIds :: Lens' VpcDestinationConfiguration [Text] Source #

The subnet IDs of the VPC destination.

vpcDestinationConfiguration_vpcId :: Lens' VpcDestinationConfiguration Text Source #

The ID of the VPC.

vpcDestinationConfiguration_roleArn :: Lens' VpcDestinationConfiguration Text Source #

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

VpcDestinationProperties

vpcDestinationProperties_roleArn :: Lens' VpcDestinationProperties (Maybe Text) Source #

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

vpcDestinationProperties_securityGroups :: Lens' VpcDestinationProperties (Maybe [Text]) Source #

The security groups of the VPC destination.

vpcDestinationProperties_subnetIds :: Lens' VpcDestinationProperties (Maybe [Text]) Source #

The subnet IDs of the VPC destination.

vpcDestinationProperties_vpcId :: Lens' VpcDestinationProperties (Maybe Text) Source #

The ID of the VPC.

VpcDestinationSummary

vpcDestinationSummary_roleArn :: Lens' VpcDestinationSummary (Maybe Text) Source #

The ARN of a role that has permission to create and attach to elastic network interfaces (ENIs).

vpcDestinationSummary_securityGroups :: Lens' VpcDestinationSummary (Maybe [Text]) Source #

The security groups of the VPC destination.

vpcDestinationSummary_subnetIds :: Lens' VpcDestinationSummary (Maybe [Text]) Source #

The subnet IDs of the VPC destination.

vpcDestinationSummary_vpcId :: Lens' VpcDestinationSummary (Maybe Text) Source #

The ID of the VPC.