IoT class

IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.

Constructors

IoT({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

acceptCertificateTransfer({required String certificateId, bool? setAsActive}) → Future<void>

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

addThingToBillingGroup({String? billingGroupArn, String? billingGroupName, String? thingArn, String? thingName}) → Future<void>

Adds a thing to a billing group.

addThingToThingGroup({bool? overrideDynamicGroups, String? thingArn, String? thingGroupArn, String? thingGroupName, String? thingName}) → Future<void>

Adds a thing to a thing group.

associateSbomWithPackageVersion({required String packageName, required Sbom sbom, required String versionName, String? clientToken}) → Future<AssociateSbomWithPackageVersionResponse>

Associates the selected software bill of materials (SBOM) with a specific software package version.

associateTargetsWithJob({required String jobId, required List<String> targets, String? comment, String? namespaceId}) → Future<AssociateTargetsWithJobResponse>

Associates a group with a continuous job. The following criteria must be met:

attachPolicy({required String policyName, required String target}) → Future<void>

Attaches the specified policy to the specified principal (certificate or other credential).

attachPrincipalPolicy({required String policyName, required String principal}) → Future<void>

Attaches the specified policy to the specified principal (certificate or other credential).

attachSecurityProfile({required String securityProfileName, required String securityProfileTargetArn}) → Future<void>

Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.

attachThingPrincipal({required String principal, required String thingName, ThingPrincipalType? thingPrincipalType}) → Future<void>

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, Amazon Cognito identities or federated identities.

cancelAuditMitigationActionsTask({required String taskId}) → Future<void>

Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

cancelAuditTask({required String taskId}) → Future<void>

Cancels an audit that is in progress. The audit can be either scheduled or on demand. If the audit isn't in progress, an "InvalidRequestException" occurs.

cancelCertificateTransfer({required String certificateId}) → Future<void>

Cancels a pending transfer for the specified certificate.

cancelDetectMitigationActionsTask({required String taskId}) → Future<void>

Cancels a Device Defender ML Detect mitigation action.

cancelJob({required String jobId, String? comment, bool? force, String? reasonCode}) → Future<CancelJobResponse>

Cancels a job.

cancelJobExecution({required String jobId, required String thingName, int? expectedVersion, bool? force, Map<String, String>? statusDetails}) → Future<void>

Cancels the execution of a job for a given thing.

clearDefaultAuthorizer() → Future<void>

Clears the default authorizer.

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

confirmTopicRuleDestination({required String confirmationToken}) → Future<void>

Confirms a topic rule destination. When you create a rule requiring a destination, IoT sends a confirmation message to the endpoint or base address you specify. The message includes a token which you pass back when calling ConfirmTopicRuleDestination to confirm that you own or have access to the endpoint.

createAuditSuppression({required String checkName, required ResourceIdentifier resourceIdentifier, String? clientRequestToken, String? description, DateTime? expirationDate, bool? suppressIndefinitely}) → Future<void>

Creates a Device Defender audit suppression.

createAuthorizer({required String authorizerFunctionArn, required String authorizerName, bool? enableCachingForHttp, bool? signingDisabled, AuthorizerStatus? status, List<Tag>? tags, String? tokenKeyName, Map<String, String>? tokenSigningPublicKeys}) → Future<CreateAuthorizerResponse>

Creates an authorizer.

createBillingGroup({required String billingGroupName, BillingGroupProperties? billingGroupProperties, List<Tag>? tags}) → Future<CreateBillingGroupResponse>

Creates a billing group. If this call is made multiple times using the same billing group name and configuration, the call will succeed. If this call is made with the same billing group name but different configuration a ResourceAlreadyExistsException is thrown.

createCertificateFromCsr({required String certificateSigningRequest, bool? setAsActive}) → Future<CreateCertificateFromCsrResponse>

Creates an X.509 certificate using the specified certificate signing request.

createCertificateProvider({required List<CertificateProviderOperation> accountDefaultForOperations, required String certificateProviderName, required String lambdaFunctionArn, String? clientToken, List<Tag>? tags}) → Future<CreateCertificateProviderResponse>

Creates an Amazon Web Services IoT Core certificate provider. You can use Amazon Web Services IoT Core certificate provider to customize how to sign a certificate signing request (CSR) in IoT fleet provisioning. For more information, see Customizing certificate signing using Amazon Web Services IoT Core certificate provider from Amazon Web Services IoT Core Developer Guide.

createCommand({required String commandId, String? description, String? displayName, List<CommandParameter>? mandatoryParameters, CommandNamespace? namespace, CommandPayload? payload, String? payloadTemplate, CommandPreprocessor? preprocessor, String? roleArn, List<Tag>? tags}) → Future<CreateCommandResponse>

Creates a command. A command contains reusable configurations that can be applied before they are sent to the devices.

createCustomMetric({required String metricName, required CustomMetricType metricType, String? clientRequestToken, String? displayName, List<Tag>? tags}) → Future<CreateCustomMetricResponse>

Use this API to define a Custom Metric published by your devices to Device Defender.

createDimension({required String name, required List<String> stringValues, required DimensionType type, String? clientRequestToken, List<Tag>? tags}) → Future<CreateDimensionResponse>

Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric only to MQTT topics whose name match the pattern specified in the dimension.

createDomainConfiguration({required String domainConfigurationName, ApplicationProtocol? applicationProtocol, AuthenticationType? authenticationType, AuthorizerConfig? authorizerConfig, ClientCertificateConfig? clientCertificateConfig, String? domainName, List<String>? serverCertificateArns, ServerCertificateConfig? serverCertificateConfig, ServiceType? serviceType, List<Tag>? tags, TlsConfig? tlsConfig, String? validationCertificateArn}) → Future<CreateDomainConfigurationResponse>

Creates a domain configuration.

createDynamicThingGroup({required String queryString, required String thingGroupName, String? indexName, String? queryVersion, List<Tag>? tags, ThingGroupProperties? thingGroupProperties}) → Future<CreateDynamicThingGroupResponse>

Creates a dynamic thing group.

createFleetMetric({required String aggregationField, required AggregationType aggregationType, required String metricName, required int period, required String queryString, String? description, String? indexName, String? queryVersion, List<Tag>? tags, FleetMetricUnit? unit}) → Future<CreateFleetMetricResponse>

Creates a fleet metric.

createJob({required String jobId, required List<String> targets, AbortConfig? abortConfig, String? description, List<String>? destinationPackageVersions, String? document, Map<String, String>? documentParameters, String? documentSource, JobExecutionsRetryConfig? jobExecutionsRetryConfig, JobExecutionsRolloutConfig? jobExecutionsRolloutConfig, String? jobTemplateArn, String? namespaceId, PresignedUrlConfig? presignedUrlConfig, SchedulingConfig? schedulingConfig, List<Tag>? tags, TargetSelection? targetSelection, TimeoutConfig? timeoutConfig}) → Future<CreateJobResponse>

Creates a job.

createJobTemplate({required String description, required String jobTemplateId, AbortConfig? abortConfig, List<String>? destinationPackageVersions, String? document, String? documentSource, String? jobArn, JobExecutionsRetryConfig? jobExecutionsRetryConfig, JobExecutionsRolloutConfig? jobExecutionsRolloutConfig, List<MaintenanceWindow>? maintenanceWindows, PresignedUrlConfig? presignedUrlConfig, List<Tag>? tags, TimeoutConfig? timeoutConfig}) → Future<CreateJobTemplateResponse>

Creates a job template.

createKeysAndCertificate({bool? setAsActive}) → Future<CreateKeysAndCertificateResponse>

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. You can also call CreateKeysAndCertificate over MQTT from a device, for more information, see Provisioning MQTT API.

createMitigationAction({required String actionName, required MitigationActionParams actionParams, required String roleArn, List<Tag>? tags}) → Future<CreateMitigationActionResponse>

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

createOTAUpdate({required List<OTAUpdateFile> files, required String otaUpdateId, required String roleArn, required List<String> targets, Map<String, String>? additionalParameters, AwsJobAbortConfig? awsJobAbortConfig, AwsJobExecutionsRolloutConfig? awsJobExecutionsRolloutConfig, AwsJobPresignedUrlConfig? awsJobPresignedUrlConfig, AwsJobTimeoutConfig? awsJobTimeoutConfig, String? description, List<Protocol>? protocols, List<Tag>? tags, TargetSelection? targetSelection}) → Future<CreateOTAUpdateResponse>

Creates an IoT OTA update on a target group of things or groups.

createPackage({required String packageName, String? clientToken, String? description, Map<String, String>? tags}) → Future<CreatePackageResponse>

Creates an IoT software package that can be deployed to your fleet.

createPackageVersion({required String packageName, required String versionName, PackageVersionArtifact? artifact, Map<String, String>? attributes, String? clientToken, String? description, String? recipe, Map<String, String>? tags}) → Future<CreatePackageVersionResponse>

Creates a new version for an existing IoT software package.

createPolicy({required String policyDocument, required String policyName, List<Tag>? tags}) → Future<CreatePolicyResponse>

Creates an IoT policy.

createPolicyVersion({required String policyDocument, required String policyName, bool? setAsDefault}) → Future<CreatePolicyVersionResponse>

Creates a new version of the specified IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

createProvisioningClaim({required String templateName}) → Future<CreateProvisioningClaimResponse>

Creates a provisioning claim.

createProvisioningTemplate({required String provisioningRoleArn, required String templateBody, required String templateName, String? description, bool? enabled, ProvisioningHook? preProvisioningHook, List<Tag>? tags, TemplateType? type}) → Future<CreateProvisioningTemplateResponse>

Creates a provisioning template.

createProvisioningTemplateVersion({required String templateBody, required String templateName, bool? setAsDefault}) → Future<CreateProvisioningTemplateVersionResponse>

Creates a new version of a provisioning template.

createRoleAlias({required String roleAlias, required String roleArn, int? credentialDurationSeconds, List<Tag>? tags}) → Future<CreateRoleAliasResponse>

Creates a role alias.

createScheduledAudit({required AuditFrequency frequency, required String scheduledAuditName, required List<String> targetCheckNames, String? dayOfMonth, DayOfWeek? dayOfWeek, List<Tag>? tags}) → Future<CreateScheduledAuditResponse>

Creates a scheduled audit that is run at a specified time interval.

createSecurityProfile({required String securityProfileName, List<String>? additionalMetricsToRetain, List<MetricToRetain>? additionalMetricsToRetainV2, Map<AlertTargetType, AlertTarget>? alertTargets, List<Behavior>? behaviors, MetricsExportConfig? metricsExportConfig, String? securityProfileDescription, List<Tag>? tags}) → Future<CreateSecurityProfileResponse>

Creates a Device Defender security profile.

createStream({required List<StreamFile> files, required String roleArn, required String streamId, String? description, List<Tag>? tags}) → Future<CreateStreamResponse>

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.

createThing({required String thingName, AttributePayload? attributePayload, String? billingGroupName, String? thingTypeName}) → Future<CreateThingResponse>

Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown. Requires permission to access the CreateThing action.

createThingGroup({required String thingGroupName, String? parentGroupName, List<Tag>? tags, ThingGroupProperties? thingGroupProperties}) → Future<CreateThingGroupResponse>

Create a thing group.

createThingType({required String thingTypeName, List<Tag>? tags, ThingTypeProperties? thingTypeProperties}) → Future<CreateThingTypeResponse>

Creates a new thing type. If this call is made multiple times using the same thing type name and configuration, the call will succeed. If this call is made with the same thing type name but different configuration a ResourceAlreadyExistsException is thrown.

createTopicRule({required String ruleName, required TopicRulePayload topicRulePayload, String? tags}) → Future<void>

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

createTopicRuleDestination({required TopicRuleDestinationConfiguration destinationConfiguration}) → Future<CreateTopicRuleDestinationResponse>

Creates a topic rule destination. The destination must be confirmed prior to use.

deleteAccountAuditConfiguration({bool? deleteScheduledAudits}) → Future<void>

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.

deleteAuditSuppression({required String checkName, required ResourceIdentifier resourceIdentifier}) → Future<void>

Deletes a Device Defender audit suppression.

deleteAuthorizer({required String authorizerName}) → Future<void>

Deletes an authorizer.

deleteBillingGroup({required String billingGroupName, int? expectedVersion}) → Future<void>

Deletes the billing group.

deleteCACertificate({required String certificateId}) → Future<void>

Deletes a registered CA certificate.

deleteCertificate({required String certificateId, bool? forceDelete}) → Future<void>

Deletes the specified certificate.

deleteCertificateProvider({required String certificateProviderName}) → Future<void>

Deletes a certificate provider.

deleteCommand({required String commandId}) → Future<DeleteCommandResponse>

Delete a command resource.

deleteCommandExecution({required String executionId, required String targetArn}) → Future<void>

Delete a command execution.

deleteCustomMetric({required String metricName}) → Future<void>

Deletes a Device Defender detect custom metric.

deleteDimension({required String name}) → Future<void>

Removes the specified dimension from your Amazon Web Services accounts.

deleteDomainConfiguration({required String domainConfigurationName}) → Future<void>

Deletes the specified domain configuration.

deleteDynamicThingGroup({required String thingGroupName, int? expectedVersion}) → Future<void>

Deletes a dynamic thing group.

deleteFleetMetric({required String metricName, int? expectedVersion}) → Future<void>

Deletes the specified fleet metric. Returns successfully with no error if the deletion is successful or you specify a fleet metric that doesn't exist.

deleteJob({required String jobId, bool? force, String? namespaceId}) → Future<void>

Deletes a job and its related job executions.

deleteJobExecution({required int executionNumber, required String jobId, required String thingName, bool? force, String? namespaceId}) → Future<void>

Deletes a job execution.

deleteJobTemplate({required String jobTemplateId}) → Future<void>

Deletes the specified job template.

deleteMitigationAction({required String actionName}) → Future<void>

Deletes a defined mitigation action from your Amazon Web Services accounts.

deleteOTAUpdate({required String otaUpdateId, bool? deleteStream, bool? forceDeleteAWSJob}) → Future<void>

Delete an OTA update.

deletePackage({required String packageName, String? clientToken}) → Future<void>

Deletes a specific version from a software package.

deletePackageVersion({required String packageName, required String versionName, String? clientToken}) → Future<void>

Deletes a specific version from a software package.

deletePolicy({required String policyName}) → Future<void>

Deletes the specified policy.

deletePolicyVersion({required String policyName, required String policyVersionId}) → Future<void>

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this action. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

deleteProvisioningTemplate({required String templateName}) → Future<void>

Deletes a provisioning template.

deleteProvisioningTemplateVersion({required String templateName, required int versionId}) → Future<void>

Deletes a provisioning template version.

deleteRegistrationCode() → Future<void>

Deletes a CA certificate registration code.

deleteRoleAlias({required String roleAlias}) → Future<void>

Deletes a role alias

deleteScheduledAudit({required String scheduledAuditName}) → Future<void>

Deletes a scheduled audit.

deleteSecurityProfile({required String securityProfileName, int? expectedVersion}) → Future<void>

Deletes a Device Defender security profile.

deleteStream({required String streamId}) → Future<void>

Deletes a stream.

deleteThing({required String thingName, int? expectedVersion}) → Future<void>

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

deleteThingGroup({required String thingGroupName, int? expectedVersion}) → Future<void>

Deletes a thing group.

deleteThingType({required String thingTypeName}) → Future<void>

Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.

deleteTopicRule({required String ruleName}) → Future<void>

Deletes the rule.

deleteTopicRuleDestination({required String arn}) → Future<void>

Deletes a topic rule destination.

deleteV2LoggingLevel({required String targetName, required LogTargetType targetType}) → Future<void>

Deletes a logging level.

deprecateThingType({required String thingTypeName, bool? undoDeprecate}) → Future<void>

Deprecates a thing type. You can not associate new things with deprecated thing type.

describeAccountAuditConfiguration() → Future<DescribeAccountAuditConfigurationResponse>

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

describeAuditFinding({required String findingId}) → Future<DescribeAuditFindingResponse>

Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.

describeAuditMitigationActionsTask({required String taskId}) → Future<DescribeAuditMitigationActionsTaskResponse>

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

describeAuditSuppression({required String checkName, required ResourceIdentifier resourceIdentifier}) → Future<DescribeAuditSuppressionResponse>

Gets information about a Device Defender audit suppression.

describeAuditTask({required String taskId}) → Future<DescribeAuditTaskResponse>

Gets information about a Device Defender audit.

describeAuthorizer({required String authorizerName}) → Future<DescribeAuthorizerResponse>

Describes an authorizer.

describeBillingGroup({required String billingGroupName}) → Future<DescribeBillingGroupResponse>

Returns information about a billing group.

describeCACertificate({required String certificateId}) → Future<DescribeCACertificateResponse>

Describes a registered CA certificate.

describeCertificate({required String certificateId}) → Future<DescribeCertificateResponse>

Gets information about the specified certificate.

describeCertificateProvider({required String certificateProviderName}) → Future<DescribeCertificateProviderResponse>

Describes a certificate provider.

describeCustomMetric({required String metricName}) → Future<DescribeCustomMetricResponse>

Gets information about a Device Defender detect custom metric.

describeDefaultAuthorizer() → Future<DescribeDefaultAuthorizerResponse>

Describes the default authorizer.

describeDetectMitigationActionsTask({required String taskId}) → Future<DescribeDetectMitigationActionsTaskResponse>

Gets information about a Device Defender ML Detect mitigation action.

describeDimension({required String name}) → Future<DescribeDimensionResponse>

Provides details about a dimension that is defined in your Amazon Web Services accounts.

describeDomainConfiguration({required String domainConfigurationName}) → Future<DescribeDomainConfigurationResponse>

Gets summary information about a domain configuration.

describeEncryptionConfiguration() → Future<DescribeEncryptionConfigurationResponse>

Retrieves the encryption configuration for resources and data of your Amazon Web Services account in Amazon Web Services IoT Core. For more information, see Data encryption at rest in the Amazon Web Services IoT Core Developer Guide.

describeEndpoint({String? endpointType}) → Future<DescribeEndpointResponse>

Returns or creates a unique endpoint specific to the Amazon Web Services account making the call. Requires permission to access the DescribeEndpoint action.

describeEventConfigurations() → Future<DescribeEventConfigurationsResponse>

Describes event configurations.

describeFleetMetric({required String metricName}) → Future<DescribeFleetMetricResponse>

Gets information about the specified fleet metric.

describeIndex({required String indexName}) → Future<DescribeIndexResponse>

Describes a search index.

describeJob({required String jobId, bool? beforeSubstitution}) → Future<DescribeJobResponse>

Describes a job.

describeJobExecution({required String jobId, required String thingName, int? executionNumber}) → Future<DescribeJobExecutionResponse>

Describes a job execution.

describeJobTemplate({required String jobTemplateId}) → Future<DescribeJobTemplateResponse>

Returns information about a job template.

describeManagedJobTemplate({required String templateName, String? templateVersion}) → Future<DescribeManagedJobTemplateResponse>

View details of a managed job template.

describeMitigationAction({required String actionName}) → Future<DescribeMitigationActionResponse>

Gets information about a mitigation action.

describeProvisioningTemplate({required String templateName}) → Future<DescribeProvisioningTemplateResponse>

Returns information about a provisioning template.

describeProvisioningTemplateVersion({required String templateName, required int versionId}) → Future<DescribeProvisioningTemplateVersionResponse>

Returns information about a provisioning template version.

describeRoleAlias({required String roleAlias}) → Future<DescribeRoleAliasResponse>

Describes a role alias.

describeScheduledAudit({required String scheduledAuditName}) → Future<DescribeScheduledAuditResponse>

Gets information about a scheduled audit.

describeSecurityProfile({required String securityProfileName}) → Future<DescribeSecurityProfileResponse>

Gets information about a Device Defender security profile.

describeStream({required String streamId}) → Future<DescribeStreamResponse>

Gets information about a stream.

describeThing({required String thingName}) → Future<DescribeThingResponse>

Gets information about the specified thing.

describeThingGroup({required String thingGroupName}) → Future<DescribeThingGroupResponse>

Describe a thing group.

describeThingRegistrationTask({required String taskId}) → Future<DescribeThingRegistrationTaskResponse>

Describes a bulk thing provisioning task.

describeThingType({required String thingTypeName}) → Future<DescribeThingTypeResponse>

Gets information about the specified thing type.

detachPolicy({required String policyName, required String target}) → Future<void>

Detaches a policy from the specified target. Requires permission to access the DetachPolicy action.

detachPrincipalPolicy({required String policyName, required String principal}) → Future<void>

Removes the specified policy from the specified certificate.

detachSecurityProfile({required String securityProfileName, required String securityProfileTargetArn}) → Future<void>

Disassociates a Device Defender security profile from a thing group or from this account.

detachThingPrincipal({required String principal, required String thingName}) → Future<void>

Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. Requires permission to access the DetachThingPrincipal action.

disableTopicRule({required String ruleName}) → Future<void>

Disables the rule.

disassociateSbomFromPackageVersion({required String packageName, required String versionName, String? clientToken}) → Future<void>

Disassociates the selected software bill of materials (SBOM) from a specific software package version.

enableTopicRule({required String ruleName}) → Future<void>

Enables the rule.

getBehaviorModelTrainingSummaries({int? maxResults, String? nextToken, String? securityProfileName}) → Future<GetBehaviorModelTrainingSummariesResponse>

Returns a Device Defender's ML Detect Security Profile training model's status.

getBucketsAggregation({required String aggregationField, required BucketsAggregationType bucketsAggregationType, required String queryString, String? indexName, String? queryVersion}) → Future<GetBucketsAggregationResponse>

Aggregates on indexed data with search queries pertaining to particular fields.

getCardinality({required String queryString, String? aggregationField, String? indexName, String? queryVersion}) → Future<GetCardinalityResponse>

Returns the approximate count of unique values that match the query.

getCommand({required String commandId}) → Future<GetCommandResponse>

Gets information about the specified command.

getCommandExecution({required String executionId, required String targetArn, bool? includeResult}) → Future<GetCommandExecutionResponse>

Gets information about the specific command execution on a single device.

getEffectivePolicies({String? cognitoIdentityPoolId, String? principal, String? thingName}) → Future<GetEffectivePoliciesResponse>

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway.

getIndexingConfiguration() → Future<GetIndexingConfigurationResponse>

Gets the indexing configuration.

getJobDocument({required String jobId, bool? beforeSubstitution}) → Future<GetJobDocumentResponse>

Gets a job document.

getLoggingOptions() → Future<GetLoggingOptionsResponse>

Gets the logging options.

getOTAUpdate({required String otaUpdateId}) → Future<GetOTAUpdateResponse>

Gets an OTA update.

getPackage({required String packageName}) → Future<GetPackageResponse>

Gets information about the specified software package.

getPackageConfiguration() → Future<GetPackageConfigurationResponse>

Gets information about the specified software package's configuration.

getPackageVersion({required String packageName, required String versionName}) → Future<GetPackageVersionResponse>

Gets information about the specified package version.

getPercentiles({required String queryString, String? aggregationField, String? indexName, List<double>? percents, String? queryVersion}) → Future<GetPercentilesResponse>

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group "1" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group "5" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

getPolicy({required String policyName}) → Future<GetPolicyResponse>

Gets information about the specified policy with the policy document of the default version.

getPolicyVersion({required String policyName, required String policyVersionId}) → Future<GetPolicyVersionResponse>

Gets information about the specified policy version.

getRegistrationCode() → Future<GetRegistrationCodeResponse>

Gets a registration code used to register a CA certificate with IoT.

getStatistics({required String queryString, String? aggregationField, String? indexName, String? queryVersion}) → Future<GetStatisticsResponse>

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

getThingConnectivityData({required String thingName, bool? includeSocketInformation}) → Future<GetThingConnectivityDataResponse>

Retrieves the live connectivity status per device. If a device has never connected to IoT Core or was disconnected for more than 1 hour before fleet indexing's thingConnectivityIndexingMode was enabled, the response will have the connected field set to false with no additional session details.

getTopicRule({required String ruleName}) → Future<GetTopicRuleResponse>

Gets information about the rule.

getTopicRuleDestination({required String arn}) → Future<GetTopicRuleDestinationResponse>

Gets information about a topic rule destination.

getV2LoggingOptions({bool? verbose}) → Future<GetV2LoggingOptionsResponse>

Gets the fine grained logging options.

listActiveViolations({BehaviorCriteriaType? behaviorCriteriaType, bool? listSuppressedAlerts, int? maxResults, String? nextToken, String? securityProfileName, String? thingName, VerificationState? verificationState}) → Future<ListActiveViolationsResponse>

Lists the active violations for a given Device Defender security profile.

listAttachedPolicies({required String target, String? marker, int? pageSize, bool? recursive}) → Future<ListAttachedPoliciesResponse>

Lists the policies attached to the specified thing group.

listAuditFindings({String? checkName, DateTime? endTime, bool? listSuppressedFindings, int? maxResults, String? nextToken, ResourceIdentifier? resourceIdentifier, DateTime? startTime, String? taskId}) → Future<ListAuditFindingsResponse>

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)

listAuditMitigationActionsExecutions({required String findingId, required String taskId, AuditMitigationActionsExecutionStatus? actionStatus, int? maxResults, String? nextToken}) → Future<ListAuditMitigationActionsExecutionsResponse>

Gets the status of audit mitigation action tasks that were executed.

listAuditMitigationActionsTasks({required DateTime endTime, required DateTime startTime, String? auditTaskId, String? findingId, int? maxResults, String? nextToken, AuditMitigationActionsTaskStatus? taskStatus}) → Future<ListAuditMitigationActionsTasksResponse>

Gets a list of audit mitigation action tasks that match the specified filters.

listAuditSuppressions({bool? ascendingOrder, String? checkName, int? maxResults, String? nextToken, ResourceIdentifier? resourceIdentifier}) → Future<ListAuditSuppressionsResponse>

Lists your Device Defender audit listings.

listAuditTasks({required DateTime endTime, required DateTime startTime, int? maxResults, String? nextToken, AuditTaskStatus? taskStatus, AuditTaskType? taskType}) → Future<ListAuditTasksResponse>

Lists the Device Defender audits that have been performed during a given time period.

listAuthorizers({bool? ascendingOrder, String? marker, int? pageSize, AuthorizerStatus? status}) → Future<ListAuthorizersResponse>

Lists the authorizers registered in your account.

listBillingGroups({int? maxResults, String? namePrefixFilter, String? nextToken}) → Future<ListBillingGroupsResponse>

Lists the billing groups you have created.

listCACertificates({bool? ascendingOrder, String? marker, int? pageSize, String? templateName}) → Future<ListCACertificatesResponse>

Lists the CA certificates registered for your Amazon Web Services account.

listCertificateProviders({bool? ascendingOrder, String? nextToken}) → Future<ListCertificateProvidersResponse>

Lists all your certificate providers in your Amazon Web Services account.

listCertificates({bool? ascendingOrder, String? marker, int? pageSize}) → Future<ListCertificatesResponse>

Lists the certificates registered in your Amazon Web Services account.

listCertificatesByCA({required String caCertificateId, bool? ascendingOrder, String? marker, int? pageSize}) → Future<ListCertificatesByCAResponse>

List the device certificates signed by the specified CA certificate.

listCommandExecutions({String? commandArn, TimeFilter? completedTimeFilter, int? maxResults, CommandNamespace? namespace, String? nextToken, SortOrder? sortOrder, TimeFilter? startedTimeFilter, CommandExecutionStatus? status, String? targetArn}) → Future<ListCommandExecutionsResponse>

List all command executions.

listCommands({String? commandParameterName, int? maxResults, CommandNamespace? namespace, String? nextToken, SortOrder? sortOrder}) → Future<ListCommandsResponse>

List all commands in your account.

listCustomMetrics({int? maxResults, String? nextToken}) → Future<ListCustomMetricsResponse>

Lists your Device Defender detect custom metrics.

listDetectMitigationActionsExecutions({DateTime? endTime, int? maxResults, String? nextToken, DateTime? startTime, String? taskId, String? thingName, String? violationId}) → Future<ListDetectMitigationActionsExecutionsResponse>

Lists mitigation actions executions for a Device Defender ML Detect Security Profile.

listDetectMitigationActionsTasks({required DateTime endTime, required DateTime startTime, int? maxResults, String? nextToken}) → Future<ListDetectMitigationActionsTasksResponse>

List of Device Defender ML Detect mitigation actions tasks.

listDimensions({int? maxResults, String? nextToken}) → Future<ListDimensionsResponse>

List the set of dimensions that are defined for your Amazon Web Services accounts.

listDomainConfigurations({String? marker, int? pageSize, ServiceType? serviceType}) → Future<ListDomainConfigurationsResponse>

Gets a list of domain configurations for the user. This list is sorted alphabetically by domain configuration name.

listFleetMetrics({int? maxResults, String? nextToken}) → Future<ListFleetMetricsResponse>

Lists all your fleet metrics.

listIndices({int? maxResults, String? nextToken}) → Future<ListIndicesResponse>

Lists the search indices.

listJobExecutionsForJob({required String jobId, int? maxResults, String? nextToken, JobExecutionStatus? status}) → Future<ListJobExecutionsForJobResponse>

Lists the job executions for a job.

listJobExecutionsForThing({required String thingName, String? jobId, int? maxResults, String? namespaceId, String? nextToken, JobExecutionStatus? status}) → Future<ListJobExecutionsForThingResponse>

Lists the job executions for the specified thing.

listJobs({int? maxResults, String? namespaceId, String? nextToken, JobStatus? status, TargetSelection? targetSelection, String? thingGroupId, String? thingGroupName}) → Future<ListJobsResponse>

Lists jobs.

listJobTemplates({int? maxResults, String? nextToken}) → Future<ListJobTemplatesResponse>

Returns a list of job templates.

listManagedJobTemplates({int? maxResults, String? nextToken, String? templateName}) → Future<ListManagedJobTemplatesResponse>

Returns a list of managed job templates.

listMetricValues({required DateTime endTime, required String metricName, required DateTime startTime, required String thingName, String? dimensionName, DimensionValueOperator? dimensionValueOperator, int? maxResults, String? nextToken}) → Future<ListMetricValuesResponse>

Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

listMitigationActions({MitigationActionType? actionType, int? maxResults, String? nextToken}) → Future<ListMitigationActionsResponse>

Gets a list of all mitigation actions that match the specified filter criteria.

listOTAUpdates({int? maxResults, String? nextToken, OTAUpdateStatus? otaUpdateStatus}) → Future<ListOTAUpdatesResponse>

Lists OTA updates.

listOutgoingCertificates({bool? ascendingOrder, String? marker, int? pageSize}) → Future<ListOutgoingCertificatesResponse>

Lists certificates that are being transferred but not yet accepted.

listPackages({int? maxResults, String? nextToken}) → Future<ListPackagesResponse>

Lists the software packages associated to the account.

listPackageVersions({required String packageName, int? maxResults, String? nextToken, PackageVersionStatus? status}) → Future<ListPackageVersionsResponse>

Lists the software package versions associated to the account.

listPolicies({bool? ascendingOrder, String? marker, int? pageSize}) → Future<ListPoliciesResponse>

Lists your policies.

listPolicyPrincipals({required String policyName, bool? ascendingOrder, String? marker, int? pageSize}) → Future<ListPolicyPrincipalsResponse>

Lists the principals associated with the specified policy.

listPolicyVersions({required String policyName}) → Future<ListPolicyVersionsResponse>

Lists the versions of the specified policy and identifies the default version.

listPrincipalPolicies({required String principal, bool? ascendingOrder, String? marker, int? pageSize}) → Future<ListPrincipalPoliciesResponse>

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.

listPrincipalThings({required String principal, int? maxResults, String? nextToken}) → Future<ListPrincipalThingsResponse>

Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

listPrincipalThingsV2({required String principal, int? maxResults, String? nextToken, ThingPrincipalType? thingPrincipalType}) → Future<ListPrincipalThingsV2Response>

Lists the things associated with the specified principal. A principal can be an X.509 certificate or an Amazon Cognito ID.

listProvisioningTemplates({int? maxResults, String? nextToken}) → Future<ListProvisioningTemplatesResponse>

Lists the provisioning templates in your Amazon Web Services account.

listProvisioningTemplateVersions({required String templateName, int? maxResults, String? nextToken}) → Future<ListProvisioningTemplateVersionsResponse>

A list of provisioning template versions.

listRelatedResourcesForAuditFinding({required String findingId, int? maxResults, String? nextToken}) → Future<ListRelatedResourcesForAuditFindingResponse>

The related resources of an Audit finding. The following resources can be returned from calling this API:

listRoleAliases({bool? ascendingOrder, String? marker, int? pageSize}) → Future<ListRoleAliasesResponse>

Lists the role aliases registered in your account.

listSbomValidationResults({required String packageName, required String versionName, int? maxResults, String? nextToken, SbomValidationResult? validationResult}) → Future<ListSbomValidationResultsResponse>

The validation results for all software bill of materials (SBOM) attached to a specific software package version.

listScheduledAudits({int? maxResults, String? nextToken}) → Future<ListScheduledAuditsResponse>

Lists all of your scheduled audits.

listSecurityProfiles({String? dimensionName, int? maxResults, String? metricName, String? nextToken}) → Future<ListSecurityProfilesResponse>

Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.

listSecurityProfilesForTarget({required String securityProfileTargetArn, int? maxResults, String? nextToken, bool? recursive}) → Future<ListSecurityProfilesForTargetResponse>

Lists the Device Defender security profiles attached to a target (thing group).

listStreams({bool? ascendingOrder, int? maxResults, String? nextToken}) → Future<ListStreamsResponse>

Lists all of the streams in your Amazon Web Services account.

listTagsForResource({required String resourceArn, String? nextToken}) → Future<ListTagsForResourceResponse>

Lists the tags (metadata) you have assigned to the resource.

listTargetsForPolicy({required String policyName, String? marker, int? pageSize}) → Future<ListTargetsForPolicyResponse>

List targets for the specified policy.

listTargetsForSecurityProfile({required String securityProfileName, int? maxResults, String? nextToken}) → Future<ListTargetsForSecurityProfileResponse>

Lists the targets (thing groups) associated with a given Device Defender security profile.

listThingGroups({int? maxResults, String? namePrefixFilter, String? nextToken, String? parentGroup, bool? recursive}) → Future<ListThingGroupsResponse>

List the thing groups in your account.

listThingGroupsForThing({required String thingName, int? maxResults, String? nextToken}) → Future<ListThingGroupsForThingResponse>

List the thing groups to which the specified thing belongs.

listThingPrincipals({required String thingName, int? maxResults, String? nextToken}) → Future<ListThingPrincipalsResponse>

Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

listThingPrincipalsV2({required String thingName, int? maxResults, String? nextToken, ThingPrincipalType? thingPrincipalType}) → Future<ListThingPrincipalsV2Response>

Lists the principals associated with the specified thing. A principal can be an X.509 certificate or an Amazon Cognito ID.

listThingRegistrationTaskReports({required ReportType reportType, required String taskId, int? maxResults, String? nextToken}) → Future<ListThingRegistrationTaskReportsResponse>

Information about the thing registration tasks.

listThingRegistrationTasks({int? maxResults, String? nextToken, Status? status}) → Future<ListThingRegistrationTasksResponse>

List bulk thing provisioning tasks.

listThings({String? attributeName, String? attributeValue, int? maxResults, String? nextToken, String? thingTypeName, bool? usePrefixAttributeValue}) → Future<ListThingsResponse>

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. For more information, see List Things from the Amazon Web Services IoT Core Developer Guide.

listThingsInBillingGroup({required String billingGroupName, int? maxResults, String? nextToken}) → Future<ListThingsInBillingGroupResponse>

Lists the things you have added to the given billing group.

listThingsInThingGroup({required String thingGroupName, int? maxResults, String? nextToken, bool? recursive}) → Future<ListThingsInThingGroupResponse>

Lists the things in the specified group.

listThingTypes({int? maxResults, String? nextToken, String? thingTypeName}) → Future<ListThingTypesResponse>

Lists the existing thing types.

listTopicRuleDestinations({int? maxResults, String? nextToken}) → Future<ListTopicRuleDestinationsResponse>

Lists all the topic rule destinations in your Amazon Web Services account.

listTopicRules({int? maxResults, String? nextToken, bool? ruleDisabled, String? topic}) → Future<ListTopicRulesResponse>

Lists the rules for the specific topic.

listV2LoggingLevels({int? maxResults, String? nextToken, LogTargetType? targetType}) → Future<ListV2LoggingLevelsResponse>

Lists logging levels.

listViolationEvents({required DateTime endTime, required DateTime startTime, BehaviorCriteriaType? behaviorCriteriaType, bool? listSuppressedAlerts, int? maxResults, String? nextToken, String? securityProfileName, String? thingName, VerificationState? verificationState}) → Future<ListViolationEventsResponse>

Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

putVerificationStateOnViolation({required VerificationState verificationState, required String violationId, String? verificationStateDescription}) → Future<void>

Set a verification state and provide a description of that verification state on a violation (detect alarm).

registerCACertificate({required String caCertificate, bool? allowAutoRegistration, CertificateMode? certificateMode, RegistrationConfig? registrationConfig, bool? setAsActive, List<Tag>? tags, String? verificationCertificate}) → Future<RegisterCACertificateResponse>

Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.

registerCertificate({required String certificatePem, String? caCertificatePem, bool? setAsActive, CertificateStatus? status}) → Future<RegisterCertificateResponse>

Registers a device certificate with IoT in the same certificate mode as the signing CA. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

registerCertificateWithoutCA({required String certificatePem, CertificateStatus? status}) → Future<RegisterCertificateWithoutCAResponse>

Register a certificate that does not have a certificate authority (CA). For supported certificates, consult Certificate signing algorithms supported by IoT.

registerThing({required String templateBody, Map<String, String>? parameters}) → Future<RegisterThingResponse>

Provisions a thing in the device registry. RegisterThing calls other IoT control plane APIs. These calls might exceed your account level IoT Throttling Limits and cause throttle errors. Please contact Amazon Web Services Customer Support to raise your throttling limits if necessary.

rejectCertificateTransfer({required String certificateId, String? rejectReason}) → Future<void>

Rejects a pending certificate transfer. After IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.

removeThingFromBillingGroup({String? billingGroupArn, String? billingGroupName, String? thingArn, String? thingName}) → Future<void>

Removes the given thing from the billing group.

removeThingFromThingGroup({String? thingArn, String? thingGroupArn, String? thingGroupName, String? thingName}) → Future<void>

Remove the specified thing from the specified group.

replaceTopicRule({required String ruleName, required TopicRulePayload topicRulePayload}) → Future<void>

Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

searchIndex({required String queryString, String? indexName, int? maxResults, String? nextToken, String? queryVersion}) → Future<SearchIndexResponse>

Searches the specified index.

setDefaultAuthorizer({required String authorizerName}) → Future<SetDefaultAuthorizerResponse>

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

setDefaultPolicyVersion({required String policyName, required String policyVersionId}) → Future<void>

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicies action.

setLoggingOptions({required LoggingOptionsPayload loggingOptionsPayload}) → Future<void>

Sets the logging options.

setV2LoggingLevel({required LogLevel logLevel, required LogTarget logTarget}) → Future<void>

Sets the logging level.

setV2LoggingOptions({LogLevel? defaultLogLevel, bool? disableAllLogs, List<LogEventConfiguration>? eventConfigurations, String? roleArn}) → Future<void>

Sets the logging options for the V2 logging service.

startAuditMitigationActionsTask({required Map<String, List<String>> auditCheckToActionsMapping, required AuditMitigationActionsTaskTarget target, required String taskId, String? clientRequestToken}) → Future<StartAuditMitigationActionsTaskResponse>

Starts a task that applies a set of mitigation actions to the specified target.

startDetectMitigationActionsTask({required List<String> actions, required DetectMitigationActionsTaskTarget target, required String taskId, String? clientRequestToken, bool? includeOnlyActiveViolations, bool? includeSuppressedAlerts, ViolationEventOccurrenceRange? violationEventOccurrenceRange}) → Future<StartDetectMitigationActionsTaskResponse>

Starts a Device Defender ML Detect mitigation actions task.

startOnDemandAuditTask({required List<String> targetCheckNames}) → Future<StartOnDemandAuditTaskResponse>

Starts an on-demand Device Defender audit.

startThingRegistrationTask({required String inputFileBucket, required String inputFileKey, required String roleArn, required String templateBody}) → Future<StartThingRegistrationTaskResponse>

Creates a bulk thing provisioning task.

stopThingRegistrationTask({required String taskId}) → Future<void>

Cancels a bulk thing provisioning task.

tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

testAuthorization({required List<AuthInfo> authInfos, String? clientId, String? cognitoIdentityPoolId, List<String>? policyNamesToAdd, List<String>? policyNamesToSkip, String? principal}) → Future<TestAuthorizationResponse>

Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.

testInvokeAuthorizer({required String authorizerName, HttpContext? httpContext, MqttContext? mqttContext, TlsContext? tlsContext, String? token, String? tokenSignature}) → Future<TestInvokeAuthorizerResponse>

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the IoT device gateway.

toString() → String

A string representation of this object.

inherited

transferCertificate({required String certificateId, required String targetAwsAccount, String? transferMessage}) → Future<TransferCertificateResponse>

Transfers the specified certificate to the specified Amazon Web Services account.

untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>

Removes the given tags (metadata) from the resource.

updateAccountAuditConfiguration({Map<String, AuditCheckConfiguration>? auditCheckConfigurations, Map<AuditNotificationType, AuditNotificationTarget>? auditNotificationTargetConfigurations, String? roleArn}) → Future<void>

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

updateAuditSuppression({required String checkName, required ResourceIdentifier resourceIdentifier, String? description, DateTime? expirationDate, bool? suppressIndefinitely}) → Future<void>

Updates a Device Defender audit suppression.

updateAuthorizer({required String authorizerName, String? authorizerFunctionArn, bool? enableCachingForHttp, AuthorizerStatus? status, String? tokenKeyName, Map<String, String>? tokenSigningPublicKeys}) → Future<UpdateAuthorizerResponse>

Updates an authorizer.

updateBillingGroup({required String billingGroupName, required BillingGroupProperties billingGroupProperties, int? expectedVersion}) → Future<UpdateBillingGroupResponse>

Updates information about the billing group.

updateCACertificate({required String certificateId, AutoRegistrationStatus? newAutoRegistrationStatus, CACertificateStatus? newStatus, RegistrationConfig? registrationConfig, bool? removeAutoRegistration}) → Future<void>

Updates a registered CA certificate.

updateCertificate({required String certificateId, required CertificateStatus newStatus}) → Future<void>

Updates the status of the specified certificate. This operation is idempotent.

updateCertificateProvider({required String certificateProviderName, List<CertificateProviderOperation>? accountDefaultForOperations, String? lambdaFunctionArn}) → Future<UpdateCertificateProviderResponse>

Updates a certificate provider.

updateCommand({required String commandId, bool? deprecated, String? description, String? displayName}) → Future<UpdateCommandResponse>

Update information about a command or mark a command for deprecation.

updateCustomMetric({required String displayName, required String metricName}) → Future<UpdateCustomMetricResponse>

Updates a Device Defender detect custom metric.

updateDimension({required String name, required List<String> stringValues}) → Future<UpdateDimensionResponse>

Updates the definition for a dimension. You cannot change the type of a dimension after it is created (you can delete it and recreate it).

updateDomainConfiguration({required String domainConfigurationName, ApplicationProtocol? applicationProtocol, AuthenticationType? authenticationType, AuthorizerConfig? authorizerConfig, ClientCertificateConfig? clientCertificateConfig, DomainConfigurationStatus? domainConfigurationStatus, bool? removeAuthorizerConfig, ServerCertificateConfig? serverCertificateConfig, TlsConfig? tlsConfig}) → Future<UpdateDomainConfigurationResponse>

Updates values stored in the domain configuration. Domain configurations for default endpoints can't be updated.

updateDynamicThingGroup({required String thingGroupName, required ThingGroupProperties thingGroupProperties, int? expectedVersion, String? indexName, String? queryString, String? queryVersion}) → Future<UpdateDynamicThingGroupResponse>

Updates a dynamic thing group.

updateEncryptionConfiguration({required EncryptionType encryptionType, String? kmsAccessRoleArn, String? kmsKeyArn}) → Future<void>

Updates the encryption configuration. By default, Amazon Web Services IoT Core encrypts your data at rest using Amazon Web Services owned keys. Amazon Web Services IoT Core also supports symmetric customer managed keys from Key Management Service (KMS). With customer managed keys, you create, own, and manage the KMS keys in your Amazon Web Services account.

updateEventConfigurations({Map<EventType, Configuration>? eventConfigurations}) → Future<void>

Updates the event configurations.

updateFleetMetric({required String indexName, required String metricName, String? aggregationField, AggregationType? aggregationType, String? description, int? expectedVersion, int? period, String? queryString, String? queryVersion, FleetMetricUnit? unit}) → Future<void>

Updates the data for a fleet metric.

updateIndexingConfiguration({ThingGroupIndexingConfiguration? thingGroupIndexingConfiguration, ThingIndexingConfiguration? thingIndexingConfiguration}) → Future<void>

Updates the search configuration.

updateJob({required String jobId, AbortConfig? abortConfig, String? description, JobExecutionsRetryConfig? jobExecutionsRetryConfig, JobExecutionsRolloutConfig? jobExecutionsRolloutConfig, String? namespaceId, PresignedUrlConfig? presignedUrlConfig, TimeoutConfig? timeoutConfig}) → Future<void>

Updates supported fields of the specified job.

updateMitigationAction({required String actionName, MitigationActionParams? actionParams, String? roleArn}) → Future<UpdateMitigationActionResponse>

Updates the definition for the specified mitigation action.

updatePackage({required String packageName, String? clientToken, String? defaultVersionName, String? description, bool? unsetDefaultVersion}) → Future<void>

Updates the supported fields for a specific software package.

updatePackageConfiguration({String? clientToken, VersionUpdateByJobsConfig? versionUpdateByJobsConfig}) → Future<void>

Updates the software package configuration.

updatePackageVersion({required String packageName, required String versionName, PackageVersionAction? action, PackageVersionArtifact? artifact, Map<String, String>? attributes, String? clientToken, String? description, String? recipe}) → Future<void>

Updates the supported fields for a specific package version.

updateProvisioningTemplate({required String templateName, int? defaultVersionId, String? description, bool? enabled, ProvisioningHook? preProvisioningHook, String? provisioningRoleArn, bool? removePreProvisioningHook}) → Future<void>

Updates a provisioning template.

updateRoleAlias({required String roleAlias, int? credentialDurationSeconds, String? roleArn}) → Future<UpdateRoleAliasResponse>

Updates a role alias.

updateScheduledAudit({required String scheduledAuditName, String? dayOfMonth, DayOfWeek? dayOfWeek, AuditFrequency? frequency, List<String>? targetCheckNames}) → Future<UpdateScheduledAuditResponse>

Updates a scheduled audit, including which checks are performed and how often the audit takes place.

updateSecurityProfile({required String securityProfileName, List<String>? additionalMetricsToRetain, List<MetricToRetain>? additionalMetricsToRetainV2, Map<AlertTargetType, AlertTarget>? alertTargets, List<Behavior>? behaviors, bool? deleteAdditionalMetricsToRetain, bool? deleteAlertTargets, bool? deleteBehaviors, bool? deleteMetricsExportConfig, int? expectedVersion, MetricsExportConfig? metricsExportConfig, String? securityProfileDescription}) → Future<UpdateSecurityProfileResponse>

Updates a Device Defender security profile.

updateStream({required String streamId, String? description, List<StreamFile>? files, String? roleArn}) → Future<UpdateStreamResponse>

Updates an existing stream. The stream version will be incremented by one.

updateThing({required String thingName, AttributePayload? attributePayload, int? expectedVersion, bool? removeThingType, String? thingTypeName}) → Future<void>

Updates the data for a thing.

updateThingGroup({required String thingGroupName, required ThingGroupProperties thingGroupProperties, int? expectedVersion}) → Future<UpdateThingGroupResponse>

Update a thing group.

updateThingGroupsForThing({bool? overrideDynamicGroups, List<String>? thingGroupsToAdd, List<String>? thingGroupsToRemove, String? thingName}) → Future<void>

Updates the groups to which the thing belongs.

updateThingType({required String thingTypeName, ThingTypeProperties? thingTypeProperties}) → Future<void>

Updates a thing type.

updateTopicRuleDestination({required String arn, required TopicRuleDestinationStatus status}) → Future<void>

Updates a topic rule destination. You use this to change the status, endpoint URL, or confirmation URL of the destination.

validateSecurityProfileBehaviors({required List<Behavior> behaviors}) → Future<ValidateSecurityProfileBehaviorsResponse>

Validates a Device Defender security profile behaviors specification.

Operators

operator ==(Object other) → bool

The equality operator.

inherited