IoTClient#
Auto-generated documentation for IoT type annotations stubs module types-boto3-iot.
IoTClient#
Type annotations and code completion for boto3.client("iot").
boto3 documentation
# IoTClient usage example
from boto3.session import Session
from types_boto3_iot.client import IoTClient
def get_iot_client() -> IoTClient:
return Session().client("iot")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("iot").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("iot")
try:
do_something(client)
except (
client.exceptions.CertificateConflictException,
client.exceptions.CertificateStateException,
client.exceptions.CertificateValidationException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ConflictingResourceUpdateException,
client.exceptions.DeleteConflictException,
client.exceptions.IndexNotReadyException,
client.exceptions.InternalException,
client.exceptions.InternalFailureException,
client.exceptions.InternalServerException,
client.exceptions.InvalidAggregationException,
client.exceptions.InvalidQueryException,
client.exceptions.InvalidRequestException,
client.exceptions.InvalidResponseException,
client.exceptions.InvalidStateTransitionException,
client.exceptions.LimitExceededException,
client.exceptions.MalformedPolicyException,
client.exceptions.NotConfiguredException,
client.exceptions.RegistrationCodeValidationException,
client.exceptions.ResourceAlreadyExistsException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ResourceRegistrationFailureException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ServiceUnavailableException,
client.exceptions.SqlParseException,
client.exceptions.TaskAlreadyExistsException,
client.exceptions.ThrottlingException,
client.exceptions.TransferAlreadyCompletedException,
client.exceptions.TransferConflictException,
client.exceptions.UnauthorizedException,
client.exceptions.ValidationException,
client.exceptions.VersionConflictException,
client.exceptions.VersionsLimitExceededException,
) as e:
print(e)# Exceptions.exceptions type checking example
from types_boto3_iot.client import Exceptions
def handle_error(exc: Exceptions.CertificateConflictException) -> None:
...Methods#
can_paginate#
Type annotations and code completion for boto3.client("iot").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...generate_presigned_url#
Type annotations and code completion for boto3.client("iot").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...accept_certificate_transfer#
Accepts a pending certificate transfer.
Type annotations and code completion for boto3.client("iot").accept_certificate_transfer method.
boto3 documentation
# accept_certificate_transfer method definition
def accept_certificate_transfer(
self,
*,
certificateId: str,
setAsActive: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# accept_certificate_transfer method usage example with argument unpacking
kwargs: AcceptCertificateTransferRequestRequestTypeDef = { # (1)
"certificateId": ...,
}
parent.accept_certificate_transfer(**kwargs)add_thing_to_billing_group#
Adds a thing to a billing group.
Type annotations and code completion for boto3.client("iot").add_thing_to_billing_group method.
boto3 documentation
# add_thing_to_billing_group method definition
def add_thing_to_billing_group(
self,
*,
billingGroupName: str = ...,
billingGroupArn: str = ...,
thingName: str = ...,
thingArn: str = ...,
) -> dict[str, Any]:
...# add_thing_to_billing_group method usage example with argument unpacking
kwargs: AddThingToBillingGroupRequestRequestTypeDef = { # (1)
"billingGroupName": ...,
}
parent.add_thing_to_billing_group(**kwargs)add_thing_to_thing_group#
Adds a thing to a thing group.
Type annotations and code completion for boto3.client("iot").add_thing_to_thing_group method.
boto3 documentation
# add_thing_to_thing_group method definition
def add_thing_to_thing_group(
self,
*,
thingGroupName: str = ...,
thingGroupArn: str = ...,
thingName: str = ...,
thingArn: str = ...,
overrideDynamicGroups: bool = ...,
) -> dict[str, Any]:
...# add_thing_to_thing_group method usage example with argument unpacking
kwargs: AddThingToThingGroupRequestRequestTypeDef = { # (1)
"thingGroupName": ...,
}
parent.add_thing_to_thing_group(**kwargs)associate_sbom_with_package_version#
Associates the selected software bill of materials (SBOM) with a specific software package version.
Type annotations and code completion for boto3.client("iot").associate_sbom_with_package_version method.
boto3 documentation
# associate_sbom_with_package_version method definition
def associate_sbom_with_package_version(
self,
*,
packageName: str,
versionName: str,
sbom: SbomTypeDef, # (1)
clientToken: str = ...,
) -> AssociateSbomWithPackageVersionResponseTypeDef: # (2)
...# associate_sbom_with_package_version method usage example with argument unpacking
kwargs: AssociateSbomWithPackageVersionRequestRequestTypeDef = { # (1)
"packageName": ...,
"versionName": ...,
"sbom": ...,
}
parent.associate_sbom_with_package_version(**kwargs)associate_targets_with_job#
Associates a group with a continuous job.
Type annotations and code completion for boto3.client("iot").associate_targets_with_job method.
boto3 documentation
# associate_targets_with_job method definition
def associate_targets_with_job(
self,
*,
targets: Sequence[str],
jobId: str,
comment: str = ...,
namespaceId: str = ...,
) -> AssociateTargetsWithJobResponseTypeDef: # (1)
...# associate_targets_with_job method usage example with argument unpacking
kwargs: AssociateTargetsWithJobRequestRequestTypeDef = { # (1)
"targets": ...,
"jobId": ...,
}
parent.associate_targets_with_job(**kwargs)attach_policy#
Attaches the specified policy to the specified principal (certificate or other credential).
Type annotations and code completion for boto3.client("iot").attach_policy method.
boto3 documentation
# attach_policy method definition
def attach_policy(
self,
*,
policyName: str,
target: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# attach_policy method usage example with argument unpacking
kwargs: AttachPolicyRequestRequestTypeDef = { # (1)
"policyName": ...,
"target": ...,
}
parent.attach_policy(**kwargs)attach_principal_policy#
Attaches the specified policy to the specified principal (certificate or other credential).
Type annotations and code completion for boto3.client("iot").attach_principal_policy method.
boto3 documentation
# attach_principal_policy method definition
def attach_principal_policy(
self,
*,
policyName: str,
principal: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# attach_principal_policy method usage example with argument unpacking
kwargs: AttachPrincipalPolicyRequestRequestTypeDef = { # (1)
"policyName": ...,
"principal": ...,
}
parent.attach_principal_policy(**kwargs)attach_security_profile#
Associates a Device Defender security profile with a thing group or this account.
Type annotations and code completion for boto3.client("iot").attach_security_profile method.
boto3 documentation
# attach_security_profile method definition
def attach_security_profile(
self,
*,
securityProfileName: str,
securityProfileTargetArn: str,
) -> dict[str, Any]:
...# attach_security_profile method usage example with argument unpacking
kwargs: AttachSecurityProfileRequestRequestTypeDef = { # (1)
"securityProfileName": ...,
"securityProfileTargetArn": ...,
}
parent.attach_security_profile(**kwargs)attach_thing_principal#
Attaches the specified principal to the specified thing.
Type annotations and code completion for boto3.client("iot").attach_thing_principal method.
boto3 documentation
# attach_thing_principal method definition
def attach_thing_principal(
self,
*,
thingName: str,
principal: str,
thingPrincipalType: ThingPrincipalTypeType = ..., # (1)
) -> dict[str, Any]:
...# attach_thing_principal method usage example with argument unpacking
kwargs: AttachThingPrincipalRequestRequestTypeDef = { # (1)
"thingName": ...,
"principal": ...,
}
parent.attach_thing_principal(**kwargs)cancel_audit_mitigation_actions_task#
Cancels a mitigation action task that is in progress.
Type annotations and code completion for boto3.client("iot").cancel_audit_mitigation_actions_task method.
boto3 documentation
# cancel_audit_mitigation_actions_task method definition
def cancel_audit_mitigation_actions_task(
self,
*,
taskId: str,
) -> dict[str, Any]:
...# cancel_audit_mitigation_actions_task method usage example with argument unpacking
kwargs: CancelAuditMitigationActionsTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.cancel_audit_mitigation_actions_task(**kwargs)cancel_audit_task#
Cancels an audit that is in progress.
Type annotations and code completion for boto3.client("iot").cancel_audit_task method.
boto3 documentation
# cancel_audit_task method definition
def cancel_audit_task(
self,
*,
taskId: str,
) -> dict[str, Any]:
...# cancel_audit_task method usage example with argument unpacking
kwargs: CancelAuditTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.cancel_audit_task(**kwargs)cancel_certificate_transfer#
Cancels a pending transfer for the specified certificate.
Type annotations and code completion for boto3.client("iot").cancel_certificate_transfer method.
boto3 documentation
# cancel_certificate_transfer method definition
def cancel_certificate_transfer(
self,
*,
certificateId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# cancel_certificate_transfer method usage example with argument unpacking
kwargs: CancelCertificateTransferRequestRequestTypeDef = { # (1)
"certificateId": ...,
}
parent.cancel_certificate_transfer(**kwargs)cancel_detect_mitigation_actions_task#
Cancels a Device Defender ML Detect mitigation action.
Type annotations and code completion for boto3.client("iot").cancel_detect_mitigation_actions_task method.
boto3 documentation
# cancel_detect_mitigation_actions_task method definition
def cancel_detect_mitigation_actions_task(
self,
*,
taskId: str,
) -> dict[str, Any]:
...# cancel_detect_mitigation_actions_task method usage example with argument unpacking
kwargs: CancelDetectMitigationActionsTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.cancel_detect_mitigation_actions_task(**kwargs)cancel_job#
Cancels a job.
Type annotations and code completion for boto3.client("iot").cancel_job method.
boto3 documentation
# cancel_job method definition
def cancel_job(
self,
*,
jobId: str,
reasonCode: str = ...,
comment: str = ...,
force: bool = ...,
) -> CancelJobResponseTypeDef: # (1)
...# cancel_job method usage example with argument unpacking
kwargs: CancelJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.cancel_job(**kwargs)cancel_job_execution#
Cancels the execution of a job for a given thing.
Type annotations and code completion for boto3.client("iot").cancel_job_execution method.
boto3 documentation
# cancel_job_execution method definition
def cancel_job_execution(
self,
*,
jobId: str,
thingName: str,
force: bool = ...,
expectedVersion: int = ...,
statusDetails: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# cancel_job_execution method usage example with argument unpacking
kwargs: CancelJobExecutionRequestRequestTypeDef = { # (1)
"jobId": ...,
"thingName": ...,
}
parent.cancel_job_execution(**kwargs)clear_default_authorizer#
Clears the default authorizer.
Type annotations and code completion for boto3.client("iot").clear_default_authorizer method.
boto3 documentation
# clear_default_authorizer method definition
def clear_default_authorizer(
self,
) -> dict[str, Any]:
...confirm_topic_rule_destination#
Confirms a topic rule destination.
Type annotations and code completion for boto3.client("iot").confirm_topic_rule_destination method.
boto3 documentation
# confirm_topic_rule_destination method definition
def confirm_topic_rule_destination(
self,
*,
confirmationToken: str,
) -> dict[str, Any]:
...# confirm_topic_rule_destination method usage example with argument unpacking
kwargs: ConfirmTopicRuleDestinationRequestRequestTypeDef = { # (1)
"confirmationToken": ...,
}
parent.confirm_topic_rule_destination(**kwargs)create_audit_suppression#
Creates a Device Defender audit suppression.
Type annotations and code completion for boto3.client("iot").create_audit_suppression method.
boto3 documentation
# create_audit_suppression method definition
def create_audit_suppression(
self,
*,
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
clientRequestToken: str,
expirationDate: TimestampTypeDef = ...,
suppressIndefinitely: bool = ...,
description: str = ...,
) -> dict[str, Any]:
...# create_audit_suppression method usage example with argument unpacking
kwargs: CreateAuditSuppressionRequestRequestTypeDef = { # (1)
"checkName": ...,
"resourceIdentifier": ...,
"clientRequestToken": ...,
}
parent.create_audit_suppression(**kwargs)create_authorizer#
Creates an authorizer.
Type annotations and code completion for boto3.client("iot").create_authorizer method.
boto3 documentation
# create_authorizer method definition
def create_authorizer(
self,
*,
authorizerName: str,
authorizerFunctionArn: str,
tokenKeyName: str = ...,
tokenSigningPublicKeys: Mapping[str, str] = ...,
status: AuthorizerStatusType = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
signingDisabled: bool = ...,
enableCachingForHttp: bool = ...,
) -> CreateAuthorizerResponseTypeDef: # (3)
...# create_authorizer method usage example with argument unpacking
kwargs: CreateAuthorizerRequestRequestTypeDef = { # (1)
"authorizerName": ...,
"authorizerFunctionArn": ...,
}
parent.create_authorizer(**kwargs)create_billing_group#
Creates a billing group.
Type annotations and code completion for boto3.client("iot").create_billing_group method.
boto3 documentation
# create_billing_group method definition
def create_billing_group(
self,
*,
billingGroupName: str,
billingGroupProperties: BillingGroupPropertiesTypeDef = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateBillingGroupResponseTypeDef: # (3)
...# create_billing_group method usage example with argument unpacking
kwargs: CreateBillingGroupRequestRequestTypeDef = { # (1)
"billingGroupName": ...,
}
parent.create_billing_group(**kwargs)create_certificate_from_csr#
Creates an X.509 certificate using the specified certificate signing request.
Type annotations and code completion for boto3.client("iot").create_certificate_from_csr method.
boto3 documentation
# create_certificate_from_csr method definition
def create_certificate_from_csr(
self,
*,
certificateSigningRequest: str,
setAsActive: bool = ...,
) -> CreateCertificateFromCsrResponseTypeDef: # (1)
...# create_certificate_from_csr method usage example with argument unpacking
kwargs: CreateCertificateFromCsrRequestRequestTypeDef = { # (1)
"certificateSigningRequest": ...,
}
parent.create_certificate_from_csr(**kwargs)create_certificate_provider#
Creates an Amazon Web Services IoT Core certificate provider.
Type annotations and code completion for boto3.client("iot").create_certificate_provider method.
boto3 documentation
# create_certificate_provider method definition
def create_certificate_provider(
self,
*,
certificateProviderName: str,
lambdaFunctionArn: str,
accountDefaultForOperations: Sequence[CertificateProviderOperationType], # (1)
clientToken: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateCertificateProviderResponseTypeDef: # (3)
...# create_certificate_provider method usage example with argument unpacking
kwargs: CreateCertificateProviderRequestRequestTypeDef = { # (1)
"certificateProviderName": ...,
"lambdaFunctionArn": ...,
"accountDefaultForOperations": ...,
}
parent.create_certificate_provider(**kwargs)create_command#
Creates a command.
Type annotations and code completion for boto3.client("iot").create_command method.
boto3 documentation
# create_command method definition
def create_command(
self,
*,
commandId: str,
namespace: CommandNamespaceType = ..., # (1)
displayName: str = ...,
description: str = ...,
payload: CommandPayloadTypeDef = ..., # (2)
mandatoryParameters: Sequence[CommandParameterUnionTypeDef] = ..., # (3)
roleArn: str = ...,
tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateCommandResponseTypeDef: # (5)
...- See CommandNamespaceType
- See CommandPayloadTypeDef
- See CommandParameterTypeDef CommandParameterOutputTypeDef
- See TagTypeDef
- See CreateCommandResponseTypeDef
# create_command method usage example with argument unpacking
kwargs: CreateCommandRequestRequestTypeDef = { # (1)
"commandId": ...,
}
parent.create_command(**kwargs)create_custom_metric#
Use this API to define a Custom Metric published by your devices to Device Defender.
Type annotations and code completion for boto3.client("iot").create_custom_metric method.
boto3 documentation
# create_custom_metric method definition
def create_custom_metric(
self,
*,
metricName: str,
metricType: CustomMetricTypeType, # (1)
clientRequestToken: str,
displayName: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateCustomMetricResponseTypeDef: # (3)
...# create_custom_metric method usage example with argument unpacking
kwargs: CreateCustomMetricRequestRequestTypeDef = { # (1)
"metricName": ...,
"metricType": ...,
"clientRequestToken": ...,
}
parent.create_custom_metric(**kwargs)create_dimension#
Create a dimension that you can use to limit the scope of a metric used in a security profile for IoT Device Defender.
Type annotations and code completion for boto3.client("iot").create_dimension method.
boto3 documentation
# create_dimension method definition
def create_dimension(
self,
*,
name: str,
type: DimensionTypeType, # (1)
stringValues: Sequence[str],
clientRequestToken: str,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateDimensionResponseTypeDef: # (3)
...# create_dimension method usage example with argument unpacking
kwargs: CreateDimensionRequestRequestTypeDef = { # (1)
"name": ...,
"type": ...,
"stringValues": ...,
"clientRequestToken": ...,
}
parent.create_dimension(**kwargs)create_domain_configuration#
Creates a domain configuration.
Type annotations and code completion for boto3.client("iot").create_domain_configuration method.
boto3 documentation
# create_domain_configuration method definition
def create_domain_configuration(
self,
*,
domainConfigurationName: str,
domainName: str = ...,
serverCertificateArns: Sequence[str] = ...,
validationCertificateArn: str = ...,
authorizerConfig: AuthorizerConfigTypeDef = ..., # (1)
serviceType: ServiceTypeType = ..., # (2)
tags: Sequence[TagTypeDef] = ..., # (3)
tlsConfig: TlsConfigTypeDef = ..., # (4)
serverCertificateConfig: ServerCertificateConfigTypeDef = ..., # (5)
authenticationType: AuthenticationTypeType = ..., # (6)
applicationProtocol: ApplicationProtocolType = ..., # (7)
clientCertificateConfig: ClientCertificateConfigTypeDef = ..., # (8)
) -> CreateDomainConfigurationResponseTypeDef: # (9)
...- See AuthorizerConfigTypeDef
- See ServiceTypeType
- See TagTypeDef
- See TlsConfigTypeDef
- See ServerCertificateConfigTypeDef
- See AuthenticationTypeType
- See ApplicationProtocolType
- See ClientCertificateConfigTypeDef
- See CreateDomainConfigurationResponseTypeDef
# create_domain_configuration method usage example with argument unpacking
kwargs: CreateDomainConfigurationRequestRequestTypeDef = { # (1)
"domainConfigurationName": ...,
}
parent.create_domain_configuration(**kwargs)create_dynamic_thing_group#
Creates a dynamic thing group.
Type annotations and code completion for boto3.client("iot").create_dynamic_thing_group method.
boto3 documentation
# create_dynamic_thing_group method definition
def create_dynamic_thing_group(
self,
*,
thingGroupName: str,
queryString: str,
thingGroupProperties: ThingGroupPropertiesTypeDef = ..., # (1)
indexName: str = ...,
queryVersion: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateDynamicThingGroupResponseTypeDef: # (3)
...# create_dynamic_thing_group method usage example with argument unpacking
kwargs: CreateDynamicThingGroupRequestRequestTypeDef = { # (1)
"thingGroupName": ...,
"queryString": ...,
}
parent.create_dynamic_thing_group(**kwargs)create_fleet_metric#
Creates a fleet metric.
Type annotations and code completion for boto3.client("iot").create_fleet_metric method.
boto3 documentation
# create_fleet_metric method definition
def create_fleet_metric(
self,
*,
metricName: str,
queryString: str,
aggregationType: AggregationTypeTypeDef, # (1)
period: int,
aggregationField: str,
description: str = ...,
queryVersion: str = ...,
indexName: str = ...,
unit: FleetMetricUnitType = ..., # (2)
tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateFleetMetricResponseTypeDef: # (4)
...- See AggregationTypeTypeDef
- See FleetMetricUnitType
- See TagTypeDef
- See CreateFleetMetricResponseTypeDef
# create_fleet_metric method usage example with argument unpacking
kwargs: CreateFleetMetricRequestRequestTypeDef = { # (1)
"metricName": ...,
"queryString": ...,
"aggregationType": ...,
"period": ...,
"aggregationField": ...,
}
parent.create_fleet_metric(**kwargs)create_job#
Creates a job.
Type annotations and code completion for boto3.client("iot").create_job method.
boto3 documentation
# create_job method definition
def create_job(
self,
*,
jobId: str,
targets: Sequence[str],
documentSource: str = ...,
document: str = ...,
description: str = ...,
presignedUrlConfig: PresignedUrlConfigTypeDef = ..., # (1)
targetSelection: TargetSelectionType = ..., # (2)
jobExecutionsRolloutConfig: JobExecutionsRolloutConfigTypeDef = ..., # (3)
abortConfig: AbortConfigTypeDef = ..., # (4)
timeoutConfig: TimeoutConfigTypeDef = ..., # (5)
tags: Sequence[TagTypeDef] = ..., # (6)
namespaceId: str = ...,
jobTemplateArn: str = ...,
jobExecutionsRetryConfig: JobExecutionsRetryConfigTypeDef = ..., # (7)
documentParameters: Mapping[str, str] = ...,
schedulingConfig: SchedulingConfigTypeDef = ..., # (8)
destinationPackageVersions: Sequence[str] = ...,
) -> CreateJobResponseTypeDef: # (9)
...- See PresignedUrlConfigTypeDef
- See TargetSelectionType
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef
- See TimeoutConfigTypeDef
- See TagTypeDef
- See JobExecutionsRetryConfigTypeDef
- See SchedulingConfigTypeDef
- See CreateJobResponseTypeDef
# create_job method usage example with argument unpacking
kwargs: CreateJobRequestRequestTypeDef = { # (1)
"jobId": ...,
"targets": ...,
}
parent.create_job(**kwargs)create_job_template#
Creates a job template.
Type annotations and code completion for boto3.client("iot").create_job_template method.
boto3 documentation
# create_job_template method definition
def create_job_template(
self,
*,
jobTemplateId: str,
description: str,
jobArn: str = ...,
documentSource: str = ...,
document: str = ...,
presignedUrlConfig: PresignedUrlConfigTypeDef = ..., # (1)
jobExecutionsRolloutConfig: JobExecutionsRolloutConfigTypeDef = ..., # (2)
abortConfig: AbortConfigTypeDef = ..., # (3)
timeoutConfig: TimeoutConfigTypeDef = ..., # (4)
tags: Sequence[TagTypeDef] = ..., # (5)
jobExecutionsRetryConfig: JobExecutionsRetryConfigTypeDef = ..., # (6)
maintenanceWindows: Sequence[MaintenanceWindowTypeDef] = ..., # (7)
destinationPackageVersions: Sequence[str] = ...,
) -> CreateJobTemplateResponseTypeDef: # (8)
...- See PresignedUrlConfigTypeDef
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef
- See TimeoutConfigTypeDef
- See TagTypeDef
- See JobExecutionsRetryConfigTypeDef
- See MaintenanceWindowTypeDef
- See CreateJobTemplateResponseTypeDef
# create_job_template method usage example with argument unpacking
kwargs: CreateJobTemplateRequestRequestTypeDef = { # (1)
"jobTemplateId": ...,
"description": ...,
}
parent.create_job_template(**kwargs)create_keys_and_certificate#
Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.
Type annotations and code completion for boto3.client("iot").create_keys_and_certificate method.
boto3 documentation
# create_keys_and_certificate method definition
def create_keys_and_certificate(
self,
*,
setAsActive: bool = ...,
) -> CreateKeysAndCertificateResponseTypeDef: # (1)
...# create_keys_and_certificate method usage example with argument unpacking
kwargs: CreateKeysAndCertificateRequestRequestTypeDef = { # (1)
"setAsActive": ...,
}
parent.create_keys_and_certificate(**kwargs)create_mitigation_action#
Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask.
Type annotations and code completion for boto3.client("iot").create_mitigation_action method.
boto3 documentation
# create_mitigation_action method definition
def create_mitigation_action(
self,
*,
actionName: str,
roleArn: str,
actionParams: MitigationActionParamsTypeDef, # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateMitigationActionResponseTypeDef: # (3)
...# create_mitigation_action method usage example with argument unpacking
kwargs: CreateMitigationActionRequestRequestTypeDef = { # (1)
"actionName": ...,
"roleArn": ...,
"actionParams": ...,
}
parent.create_mitigation_action(**kwargs)create_ota_update#
Creates an IoT OTA update on a target group of things or groups.
Type annotations and code completion for boto3.client("iot").create_ota_update method.
boto3 documentation
# create_ota_update method definition
def create_ota_update(
self,
*,
otaUpdateId: str,
targets: Sequence[str],
files: Sequence[OTAUpdateFileUnionTypeDef], # (1)
roleArn: str,
description: str = ...,
protocols: Sequence[ProtocolType] = ..., # (2)
targetSelection: TargetSelectionType = ..., # (3)
awsJobExecutionsRolloutConfig: AwsJobExecutionsRolloutConfigTypeDef = ..., # (4)
awsJobPresignedUrlConfig: AwsJobPresignedUrlConfigTypeDef = ..., # (5)
awsJobAbortConfig: AwsJobAbortConfigTypeDef = ..., # (6)
awsJobTimeoutConfig: AwsJobTimeoutConfigTypeDef = ..., # (7)
additionalParameters: Mapping[str, str] = ...,
tags: Sequence[TagTypeDef] = ..., # (8)
) -> CreateOTAUpdateResponseTypeDef: # (9)
...- See OTAUpdateFileTypeDef OTAUpdateFileOutputTypeDef
- See ProtocolType
- See TargetSelectionType
- See AwsJobExecutionsRolloutConfigTypeDef
- See AwsJobPresignedUrlConfigTypeDef
- See AwsJobAbortConfigTypeDef
- See AwsJobTimeoutConfigTypeDef
- See TagTypeDef
- See CreateOTAUpdateResponseTypeDef
# create_ota_update method usage example with argument unpacking
kwargs: CreateOTAUpdateRequestRequestTypeDef = { # (1)
"otaUpdateId": ...,
"targets": ...,
"files": ...,
"roleArn": ...,
}
parent.create_ota_update(**kwargs)create_package#
Creates an IoT software package that can be deployed to your fleet.
Type annotations and code completion for boto3.client("iot").create_package method.
boto3 documentation
# create_package method definition
def create_package(
self,
*,
packageName: str,
description: str = ...,
tags: Mapping[str, str] = ...,
clientToken: str = ...,
) -> CreatePackageResponseTypeDef: # (1)
...# create_package method usage example with argument unpacking
kwargs: CreatePackageRequestRequestTypeDef = { # (1)
"packageName": ...,
}
parent.create_package(**kwargs)create_package_version#
Creates a new version for an existing IoT software package.
Type annotations and code completion for boto3.client("iot").create_package_version method.
boto3 documentation
# create_package_version method definition
def create_package_version(
self,
*,
packageName: str,
versionName: str,
description: str = ...,
attributes: Mapping[str, str] = ...,
artifact: PackageVersionArtifactTypeDef = ..., # (1)
recipe: str = ...,
tags: Mapping[str, str] = ...,
clientToken: str = ...,
) -> CreatePackageVersionResponseTypeDef: # (2)
...# create_package_version method usage example with argument unpacking
kwargs: CreatePackageVersionRequestRequestTypeDef = { # (1)
"packageName": ...,
"versionName": ...,
}
parent.create_package_version(**kwargs)create_policy#
Creates an IoT policy.
Type annotations and code completion for boto3.client("iot").create_policy method.
boto3 documentation
# create_policy method definition
def create_policy(
self,
*,
policyName: str,
policyDocument: str,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreatePolicyResponseTypeDef: # (2)
...# create_policy method usage example with argument unpacking
kwargs: CreatePolicyRequestRequestTypeDef = { # (1)
"policyName": ...,
"policyDocument": ...,
}
parent.create_policy(**kwargs)create_policy_version#
Creates a new version of the specified IoT policy.
Type annotations and code completion for boto3.client("iot").create_policy_version method.
boto3 documentation
# create_policy_version method definition
def create_policy_version(
self,
*,
policyName: str,
policyDocument: str,
setAsDefault: bool = ...,
) -> CreatePolicyVersionResponseTypeDef: # (1)
...# create_policy_version method usage example with argument unpacking
kwargs: CreatePolicyVersionRequestRequestTypeDef = { # (1)
"policyName": ...,
"policyDocument": ...,
}
parent.create_policy_version(**kwargs)create_provisioning_claim#
Creates a provisioning claim.
Type annotations and code completion for boto3.client("iot").create_provisioning_claim method.
boto3 documentation
# create_provisioning_claim method definition
def create_provisioning_claim(
self,
*,
templateName: str,
) -> CreateProvisioningClaimResponseTypeDef: # (1)
...# create_provisioning_claim method usage example with argument unpacking
kwargs: CreateProvisioningClaimRequestRequestTypeDef = { # (1)
"templateName": ...,
}
parent.create_provisioning_claim(**kwargs)create_provisioning_template#
Creates a provisioning template.
Type annotations and code completion for boto3.client("iot").create_provisioning_template method.
boto3 documentation
# create_provisioning_template method definition
def create_provisioning_template(
self,
*,
templateName: str,
templateBody: str,
provisioningRoleArn: str,
description: str = ...,
enabled: bool = ...,
preProvisioningHook: ProvisioningHookTypeDef = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
type: TemplateTypeType = ..., # (3)
) -> CreateProvisioningTemplateResponseTypeDef: # (4)
...- See ProvisioningHookTypeDef
- See TagTypeDef
- See TemplateTypeType
- See CreateProvisioningTemplateResponseTypeDef
# create_provisioning_template method usage example with argument unpacking
kwargs: CreateProvisioningTemplateRequestRequestTypeDef = { # (1)
"templateName": ...,
"templateBody": ...,
"provisioningRoleArn": ...,
}
parent.create_provisioning_template(**kwargs)create_provisioning_template_version#
Creates a new version of a provisioning template.
Type annotations and code completion for boto3.client("iot").create_provisioning_template_version method.
boto3 documentation
# create_provisioning_template_version method definition
def create_provisioning_template_version(
self,
*,
templateName: str,
templateBody: str,
setAsDefault: bool = ...,
) -> CreateProvisioningTemplateVersionResponseTypeDef: # (1)
...# create_provisioning_template_version method usage example with argument unpacking
kwargs: CreateProvisioningTemplateVersionRequestRequestTypeDef = { # (1)
"templateName": ...,
"templateBody": ...,
}
parent.create_provisioning_template_version(**kwargs)create_role_alias#
Creates a role alias.
Type annotations and code completion for boto3.client("iot").create_role_alias method.
boto3 documentation
# create_role_alias method definition
def create_role_alias(
self,
*,
roleAlias: str,
roleArn: str,
credentialDurationSeconds: int = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateRoleAliasResponseTypeDef: # (2)
...# create_role_alias method usage example with argument unpacking
kwargs: CreateRoleAliasRequestRequestTypeDef = { # (1)
"roleAlias": ...,
"roleArn": ...,
}
parent.create_role_alias(**kwargs)create_scheduled_audit#
Creates a scheduled audit that is run at a specified time interval.
Type annotations and code completion for boto3.client("iot").create_scheduled_audit method.
boto3 documentation
# create_scheduled_audit method definition
def create_scheduled_audit(
self,
*,
frequency: AuditFrequencyType, # (1)
targetCheckNames: Sequence[str],
scheduledAuditName: str,
dayOfMonth: str = ...,
dayOfWeek: DayOfWeekType = ..., # (2)
tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateScheduledAuditResponseTypeDef: # (4)
...- See AuditFrequencyType
- See DayOfWeekType
- See TagTypeDef
- See CreateScheduledAuditResponseTypeDef
# create_scheduled_audit method usage example with argument unpacking
kwargs: CreateScheduledAuditRequestRequestTypeDef = { # (1)
"frequency": ...,
"targetCheckNames": ...,
"scheduledAuditName": ...,
}
parent.create_scheduled_audit(**kwargs)create_security_profile#
Creates a Device Defender security profile.
Type annotations and code completion for boto3.client("iot").create_security_profile method.
boto3 documentation
# create_security_profile method definition
def create_security_profile(
self,
*,
securityProfileName: str,
securityProfileDescription: str = ...,
behaviors: Sequence[BehaviorUnionTypeDef] = ..., # (1)
alertTargets: Mapping[AlertTargetTypeType, AlertTargetTypeDef] = ..., # (2)
additionalMetricsToRetain: Sequence[str] = ...,
additionalMetricsToRetainV2: Sequence[MetricToRetainTypeDef] = ..., # (3)
tags: Sequence[TagTypeDef] = ..., # (4)
metricsExportConfig: MetricsExportConfigTypeDef = ..., # (5)
) -> CreateSecurityProfileResponseTypeDef: # (6)
...- See BehaviorTypeDef BehaviorOutputTypeDef
- See AlertTargetTypeType AlertTargetTypeDef
- See MetricToRetainTypeDef
- See TagTypeDef
- See MetricsExportConfigTypeDef
- See CreateSecurityProfileResponseTypeDef
# create_security_profile method usage example with argument unpacking
kwargs: CreateSecurityProfileRequestRequestTypeDef = { # (1)
"securityProfileName": ...,
}
parent.create_security_profile(**kwargs)create_stream#
Creates a stream for delivering one or more large files in chunks over MQTT.
Type annotations and code completion for boto3.client("iot").create_stream method.
boto3 documentation
# create_stream method definition
def create_stream(
self,
*,
streamId: str,
files: Sequence[StreamFileTypeDef], # (1)
roleArn: str,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateStreamResponseTypeDef: # (3)
...- See StreamFileTypeDef
- See TagTypeDef
- See CreateStreamResponseTypeDef
# create_stream method usage example with argument unpacking
kwargs: CreateStreamRequestRequestTypeDef = { # (1)
"streamId": ...,
"files": ...,
"roleArn": ...,
}
parent.create_stream(**kwargs)create_thing#
Creates a thing record in the registry.
Type annotations and code completion for boto3.client("iot").create_thing method.
boto3 documentation
# create_thing method definition
def create_thing(
self,
*,
thingName: str,
thingTypeName: str = ...,
attributePayload: AttributePayloadTypeDef = ..., # (1)
billingGroupName: str = ...,
) -> CreateThingResponseTypeDef: # (2)
...# create_thing method usage example with argument unpacking
kwargs: CreateThingRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.create_thing(**kwargs)create_thing_group#
Create a thing group.
Type annotations and code completion for boto3.client("iot").create_thing_group method.
boto3 documentation
# create_thing_group method definition
def create_thing_group(
self,
*,
thingGroupName: str,
parentGroupName: str = ...,
thingGroupProperties: ThingGroupPropertiesTypeDef = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateThingGroupResponseTypeDef: # (3)
...# create_thing_group method usage example with argument unpacking
kwargs: CreateThingGroupRequestRequestTypeDef = { # (1)
"thingGroupName": ...,
}
parent.create_thing_group(**kwargs)create_thing_type#
Creates a new thing type.
Type annotations and code completion for boto3.client("iot").create_thing_type method.
boto3 documentation
# create_thing_type method definition
def create_thing_type(
self,
*,
thingTypeName: str,
thingTypeProperties: ThingTypePropertiesTypeDef = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateThingTypeResponseTypeDef: # (3)
...# create_thing_type method usage example with argument unpacking
kwargs: CreateThingTypeRequestRequestTypeDef = { # (1)
"thingTypeName": ...,
}
parent.create_thing_type(**kwargs)create_topic_rule#
Creates a rule.
Type annotations and code completion for boto3.client("iot").create_topic_rule method.
boto3 documentation
# create_topic_rule method definition
def create_topic_rule(
self,
*,
ruleName: str,
topicRulePayload: TopicRulePayloadTypeDef, # (1)
tags: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...# create_topic_rule method usage example with argument unpacking
kwargs: CreateTopicRuleRequestRequestTypeDef = { # (1)
"ruleName": ...,
"topicRulePayload": ...,
}
parent.create_topic_rule(**kwargs)create_topic_rule_destination#
Creates a topic rule destination.
Type annotations and code completion for boto3.client("iot").create_topic_rule_destination method.
boto3 documentation
# create_topic_rule_destination method definition
def create_topic_rule_destination(
self,
*,
destinationConfiguration: TopicRuleDestinationConfigurationTypeDef, # (1)
) -> CreateTopicRuleDestinationResponseTypeDef: # (2)
...# create_topic_rule_destination method usage example with argument unpacking
kwargs: CreateTopicRuleDestinationRequestRequestTypeDef = { # (1)
"destinationConfiguration": ...,
}
parent.create_topic_rule_destination(**kwargs)delete_account_audit_configuration#
Restores the default settings for Device Defender audits for this account.
Type annotations and code completion for boto3.client("iot").delete_account_audit_configuration method.
boto3 documentation
# delete_account_audit_configuration method definition
def delete_account_audit_configuration(
self,
*,
deleteScheduledAudits: bool = ...,
) -> dict[str, Any]:
...# delete_account_audit_configuration method usage example with argument unpacking
kwargs: DeleteAccountAuditConfigurationRequestRequestTypeDef = { # (1)
"deleteScheduledAudits": ...,
}
parent.delete_account_audit_configuration(**kwargs)delete_audit_suppression#
Deletes a Device Defender audit suppression.
Type annotations and code completion for boto3.client("iot").delete_audit_suppression method.
boto3 documentation
# delete_audit_suppression method definition
def delete_audit_suppression(
self,
*,
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
) -> dict[str, Any]:
...# delete_audit_suppression method usage example with argument unpacking
kwargs: DeleteAuditSuppressionRequestRequestTypeDef = { # (1)
"checkName": ...,
"resourceIdentifier": ...,
}
parent.delete_audit_suppression(**kwargs)delete_authorizer#
Deletes an authorizer.
Type annotations and code completion for boto3.client("iot").delete_authorizer method.
boto3 documentation
# delete_authorizer method definition
def delete_authorizer(
self,
*,
authorizerName: str,
) -> dict[str, Any]:
...# delete_authorizer method usage example with argument unpacking
kwargs: DeleteAuthorizerRequestRequestTypeDef = { # (1)
"authorizerName": ...,
}
parent.delete_authorizer(**kwargs)delete_billing_group#
Deletes the billing group.
Type annotations and code completion for boto3.client("iot").delete_billing_group method.
boto3 documentation
# delete_billing_group method definition
def delete_billing_group(
self,
*,
billingGroupName: str,
expectedVersion: int = ...,
) -> dict[str, Any]:
...# delete_billing_group method usage example with argument unpacking
kwargs: DeleteBillingGroupRequestRequestTypeDef = { # (1)
"billingGroupName": ...,
}
parent.delete_billing_group(**kwargs)delete_ca_certificate#
Deletes a registered CA certificate.
Type annotations and code completion for boto3.client("iot").delete_ca_certificate method.
boto3 documentation
# delete_ca_certificate method definition
def delete_ca_certificate(
self,
*,
certificateId: str,
) -> dict[str, Any]:
...# delete_ca_certificate method usage example with argument unpacking
kwargs: DeleteCACertificateRequestRequestTypeDef = { # (1)
"certificateId": ...,
}
parent.delete_ca_certificate(**kwargs)delete_certificate#
Deletes the specified certificate.
Type annotations and code completion for boto3.client("iot").delete_certificate method.
boto3 documentation
# delete_certificate method definition
def delete_certificate(
self,
*,
certificateId: str,
forceDelete: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_certificate method usage example with argument unpacking
kwargs: DeleteCertificateRequestRequestTypeDef = { # (1)
"certificateId": ...,
}
parent.delete_certificate(**kwargs)delete_certificate_provider#
Deletes a certificate provider.
Type annotations and code completion for boto3.client("iot").delete_certificate_provider method.
boto3 documentation
# delete_certificate_provider method definition
def delete_certificate_provider(
self,
*,
certificateProviderName: str,
) -> dict[str, Any]:
...# delete_certificate_provider method usage example with argument unpacking
kwargs: DeleteCertificateProviderRequestRequestTypeDef = { # (1)
"certificateProviderName": ...,
}
parent.delete_certificate_provider(**kwargs)delete_command#
Delete a command resource.
Type annotations and code completion for boto3.client("iot").delete_command method.
boto3 documentation
# delete_command method definition
def delete_command(
self,
*,
commandId: str,
) -> DeleteCommandResponseTypeDef: # (1)
...# delete_command method usage example with argument unpacking
kwargs: DeleteCommandRequestRequestTypeDef = { # (1)
"commandId": ...,
}
parent.delete_command(**kwargs)delete_command_execution#
Delete a command execution.
Type annotations and code completion for boto3.client("iot").delete_command_execution method.
boto3 documentation
# delete_command_execution method definition
def delete_command_execution(
self,
*,
executionId: str,
targetArn: str,
) -> dict[str, Any]:
...# delete_command_execution method usage example with argument unpacking
kwargs: DeleteCommandExecutionRequestRequestTypeDef = { # (1)
"executionId": ...,
"targetArn": ...,
}
parent.delete_command_execution(**kwargs)delete_custom_metric#
Deletes a Device Defender detect custom metric.
Type annotations and code completion for boto3.client("iot").delete_custom_metric method.
boto3 documentation
# delete_custom_metric method definition
def delete_custom_metric(
self,
*,
metricName: str,
) -> dict[str, Any]:
...# delete_custom_metric method usage example with argument unpacking
kwargs: DeleteCustomMetricRequestRequestTypeDef = { # (1)
"metricName": ...,
}
parent.delete_custom_metric(**kwargs)delete_dimension#
Removes the specified dimension from your Amazon Web Services accounts.
Type annotations and code completion for boto3.client("iot").delete_dimension method.
boto3 documentation
# delete_dimension method definition
def delete_dimension(
self,
*,
name: str,
) -> dict[str, Any]:
...# delete_dimension method usage example with argument unpacking
kwargs: DeleteDimensionRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.delete_dimension(**kwargs)delete_domain_configuration#
Deletes the specified domain configuration.
Type annotations and code completion for boto3.client("iot").delete_domain_configuration method.
boto3 documentation
# delete_domain_configuration method definition
def delete_domain_configuration(
self,
*,
domainConfigurationName: str,
) -> dict[str, Any]:
...# delete_domain_configuration method usage example with argument unpacking
kwargs: DeleteDomainConfigurationRequestRequestTypeDef = { # (1)
"domainConfigurationName": ...,
}
parent.delete_domain_configuration(**kwargs)delete_dynamic_thing_group#
Deletes a dynamic thing group.
Type annotations and code completion for boto3.client("iot").delete_dynamic_thing_group method.
boto3 documentation
# delete_dynamic_thing_group method definition
def delete_dynamic_thing_group(
self,
*,
thingGroupName: str,
expectedVersion: int = ...,
) -> dict[str, Any]:
...# delete_dynamic_thing_group method usage example with argument unpacking
kwargs: DeleteDynamicThingGroupRequestRequestTypeDef = { # (1)
"thingGroupName": ...,
}
parent.delete_dynamic_thing_group(**kwargs)delete_fleet_metric#
Deletes the specified fleet metric.
Type annotations and code completion for boto3.client("iot").delete_fleet_metric method.
boto3 documentation
# delete_fleet_metric method definition
def delete_fleet_metric(
self,
*,
metricName: str,
expectedVersion: int = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_fleet_metric method usage example with argument unpacking
kwargs: DeleteFleetMetricRequestRequestTypeDef = { # (1)
"metricName": ...,
}
parent.delete_fleet_metric(**kwargs)delete_job#
Deletes a job and its related job executions.
Type annotations and code completion for boto3.client("iot").delete_job method.
boto3 documentation
# delete_job method definition
def delete_job(
self,
*,
jobId: str,
force: bool = ...,
namespaceId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_job method usage example with argument unpacking
kwargs: DeleteJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.delete_job(**kwargs)delete_job_execution#
Deletes a job execution.
Type annotations and code completion for boto3.client("iot").delete_job_execution method.
boto3 documentation
# delete_job_execution method definition
def delete_job_execution(
self,
*,
jobId: str,
thingName: str,
executionNumber: int,
force: bool = ...,
namespaceId: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_job_execution method usage example with argument unpacking
kwargs: DeleteJobExecutionRequestRequestTypeDef = { # (1)
"jobId": ...,
"thingName": ...,
"executionNumber": ...,
}
parent.delete_job_execution(**kwargs)delete_job_template#
Deletes the specified job template.
Type annotations and code completion for boto3.client("iot").delete_job_template method.
boto3 documentation
# delete_job_template method definition
def delete_job_template(
self,
*,
jobTemplateId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_job_template method usage example with argument unpacking
kwargs: DeleteJobTemplateRequestRequestTypeDef = { # (1)
"jobTemplateId": ...,
}
parent.delete_job_template(**kwargs)delete_mitigation_action#
Deletes a defined mitigation action from your Amazon Web Services accounts.
Type annotations and code completion for boto3.client("iot").delete_mitigation_action method.
boto3 documentation
# delete_mitigation_action method definition
def delete_mitigation_action(
self,
*,
actionName: str,
) -> dict[str, Any]:
...# delete_mitigation_action method usage example with argument unpacking
kwargs: DeleteMitigationActionRequestRequestTypeDef = { # (1)
"actionName": ...,
}
parent.delete_mitigation_action(**kwargs)delete_ota_update#
Delete an OTA update.
Type annotations and code completion for boto3.client("iot").delete_ota_update method.
boto3 documentation
# delete_ota_update method definition
def delete_ota_update(
self,
*,
otaUpdateId: str,
deleteStream: bool = ...,
forceDeleteAWSJob: bool = ...,
) -> dict[str, Any]:
...# delete_ota_update method usage example with argument unpacking
kwargs: DeleteOTAUpdateRequestRequestTypeDef = { # (1)
"otaUpdateId": ...,
}
parent.delete_ota_update(**kwargs)delete_package#
Deletes a specific version from a software package.
Type annotations and code completion for boto3.client("iot").delete_package method.
boto3 documentation
# delete_package method definition
def delete_package(
self,
*,
packageName: str,
clientToken: str = ...,
) -> dict[str, Any]:
...# delete_package method usage example with argument unpacking
kwargs: DeletePackageRequestRequestTypeDef = { # (1)
"packageName": ...,
}
parent.delete_package(**kwargs)delete_package_version#
Deletes a specific version from a software package.
Type annotations and code completion for boto3.client("iot").delete_package_version method.
boto3 documentation
# delete_package_version method definition
def delete_package_version(
self,
*,
packageName: str,
versionName: str,
clientToken: str = ...,
) -> dict[str, Any]:
...# delete_package_version method usage example with argument unpacking
kwargs: DeletePackageVersionRequestRequestTypeDef = { # (1)
"packageName": ...,
"versionName": ...,
}
parent.delete_package_version(**kwargs)delete_policy#
Deletes the specified policy.
Type annotations and code completion for boto3.client("iot").delete_policy method.
boto3 documentation
# delete_policy method definition
def delete_policy(
self,
*,
policyName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_policy method usage example with argument unpacking
kwargs: DeletePolicyRequestRequestTypeDef = { # (1)
"policyName": ...,
}
parent.delete_policy(**kwargs)delete_policy_version#
Deletes the specified version of the specified policy.
Type annotations and code completion for boto3.client("iot").delete_policy_version method.
boto3 documentation
# delete_policy_version method definition
def delete_policy_version(
self,
*,
policyName: str,
policyVersionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_policy_version method usage example with argument unpacking
kwargs: DeletePolicyVersionRequestRequestTypeDef = { # (1)
"policyName": ...,
"policyVersionId": ...,
}
parent.delete_policy_version(**kwargs)delete_provisioning_template#
Deletes a provisioning template.
Type annotations and code completion for boto3.client("iot").delete_provisioning_template method.
boto3 documentation
# delete_provisioning_template method definition
def delete_provisioning_template(
self,
*,
templateName: str,
) -> dict[str, Any]:
...# delete_provisioning_template method usage example with argument unpacking
kwargs: DeleteProvisioningTemplateRequestRequestTypeDef = { # (1)
"templateName": ...,
}
parent.delete_provisioning_template(**kwargs)delete_provisioning_template_version#
Deletes a provisioning template version.
Type annotations and code completion for boto3.client("iot").delete_provisioning_template_version method.
boto3 documentation
# delete_provisioning_template_version method definition
def delete_provisioning_template_version(
self,
*,
templateName: str,
versionId: int,
) -> dict[str, Any]:
...# delete_provisioning_template_version method usage example with argument unpacking
kwargs: DeleteProvisioningTemplateVersionRequestRequestTypeDef = { # (1)
"templateName": ...,
"versionId": ...,
}
parent.delete_provisioning_template_version(**kwargs)delete_registration_code#
Deletes a CA certificate registration code.
Type annotations and code completion for boto3.client("iot").delete_registration_code method.
boto3 documentation
# delete_registration_code method definition
def delete_registration_code(
self,
) -> dict[str, Any]:
...delete_role_alias#
Deletes a role alias.
Type annotations and code completion for boto3.client("iot").delete_role_alias method.
boto3 documentation
# delete_role_alias method definition
def delete_role_alias(
self,
*,
roleAlias: str,
) -> dict[str, Any]:
...# delete_role_alias method usage example with argument unpacking
kwargs: DeleteRoleAliasRequestRequestTypeDef = { # (1)
"roleAlias": ...,
}
parent.delete_role_alias(**kwargs)delete_scheduled_audit#
Deletes a scheduled audit.
Type annotations and code completion for boto3.client("iot").delete_scheduled_audit method.
boto3 documentation
# delete_scheduled_audit method definition
def delete_scheduled_audit(
self,
*,
scheduledAuditName: str,
) -> dict[str, Any]:
...# delete_scheduled_audit method usage example with argument unpacking
kwargs: DeleteScheduledAuditRequestRequestTypeDef = { # (1)
"scheduledAuditName": ...,
}
parent.delete_scheduled_audit(**kwargs)delete_security_profile#
Deletes a Device Defender security profile.
Type annotations and code completion for boto3.client("iot").delete_security_profile method.
boto3 documentation
# delete_security_profile method definition
def delete_security_profile(
self,
*,
securityProfileName: str,
expectedVersion: int = ...,
) -> dict[str, Any]:
...# delete_security_profile method usage example with argument unpacking
kwargs: DeleteSecurityProfileRequestRequestTypeDef = { # (1)
"securityProfileName": ...,
}
parent.delete_security_profile(**kwargs)delete_stream#
Deletes a stream.
Type annotations and code completion for boto3.client("iot").delete_stream method.
boto3 documentation
# delete_stream method definition
def delete_stream(
self,
*,
streamId: str,
) -> dict[str, Any]:
...# delete_stream method usage example with argument unpacking
kwargs: DeleteStreamRequestRequestTypeDef = { # (1)
"streamId": ...,
}
parent.delete_stream(**kwargs)delete_thing#
Deletes the specified thing.
Type annotations and code completion for boto3.client("iot").delete_thing method.
boto3 documentation
# delete_thing method definition
def delete_thing(
self,
*,
thingName: str,
expectedVersion: int = ...,
) -> dict[str, Any]:
...# delete_thing method usage example with argument unpacking
kwargs: DeleteThingRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.delete_thing(**kwargs)delete_thing_group#
Deletes a thing group.
Type annotations and code completion for boto3.client("iot").delete_thing_group method.
boto3 documentation
# delete_thing_group method definition
def delete_thing_group(
self,
*,
thingGroupName: str,
expectedVersion: int = ...,
) -> dict[str, Any]:
...# delete_thing_group method usage example with argument unpacking
kwargs: DeleteThingGroupRequestRequestTypeDef = { # (1)
"thingGroupName": ...,
}
parent.delete_thing_group(**kwargs)delete_thing_type#
Deletes the specified thing type.
Type annotations and code completion for boto3.client("iot").delete_thing_type method.
boto3 documentation
# delete_thing_type method definition
def delete_thing_type(
self,
*,
thingTypeName: str,
) -> dict[str, Any]:
...# delete_thing_type method usage example with argument unpacking
kwargs: DeleteThingTypeRequestRequestTypeDef = { # (1)
"thingTypeName": ...,
}
parent.delete_thing_type(**kwargs)delete_topic_rule#
Deletes the rule.
Type annotations and code completion for boto3.client("iot").delete_topic_rule method.
boto3 documentation
# delete_topic_rule method definition
def delete_topic_rule(
self,
*,
ruleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_topic_rule method usage example with argument unpacking
kwargs: DeleteTopicRuleRequestRequestTypeDef = { # (1)
"ruleName": ...,
}
parent.delete_topic_rule(**kwargs)delete_topic_rule_destination#
Deletes a topic rule destination.
Type annotations and code completion for boto3.client("iot").delete_topic_rule_destination method.
boto3 documentation
# delete_topic_rule_destination method definition
def delete_topic_rule_destination(
self,
*,
arn: str,
) -> dict[str, Any]:
...# delete_topic_rule_destination method usage example with argument unpacking
kwargs: DeleteTopicRuleDestinationRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_topic_rule_destination(**kwargs)delete_v2_logging_level#
Deletes a logging level.
Type annotations and code completion for boto3.client("iot").delete_v2_logging_level method.
boto3 documentation
# delete_v2_logging_level method definition
def delete_v2_logging_level(
self,
*,
targetType: LogTargetTypeType, # (1)
targetName: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...# delete_v2_logging_level method usage example with argument unpacking
kwargs: DeleteV2LoggingLevelRequestRequestTypeDef = { # (1)
"targetType": ...,
"targetName": ...,
}
parent.delete_v2_logging_level(**kwargs)deprecate_thing_type#
Deprecates a thing type.
Type annotations and code completion for boto3.client("iot").deprecate_thing_type method.
boto3 documentation
# deprecate_thing_type method definition
def deprecate_thing_type(
self,
*,
thingTypeName: str,
undoDeprecate: bool = ...,
) -> dict[str, Any]:
...# deprecate_thing_type method usage example with argument unpacking
kwargs: DeprecateThingTypeRequestRequestTypeDef = { # (1)
"thingTypeName": ...,
}
parent.deprecate_thing_type(**kwargs)describe_account_audit_configuration#
Gets information about the Device Defender audit settings for this account.
Type annotations and code completion for boto3.client("iot").describe_account_audit_configuration method.
boto3 documentation
# describe_account_audit_configuration method definition
def describe_account_audit_configuration(
self,
) -> DescribeAccountAuditConfigurationResponseTypeDef: # (1)
...describe_audit_finding#
Gets information about a single audit finding.
Type annotations and code completion for boto3.client("iot").describe_audit_finding method.
boto3 documentation
# describe_audit_finding method definition
def describe_audit_finding(
self,
*,
findingId: str,
) -> DescribeAuditFindingResponseTypeDef: # (1)
...# describe_audit_finding method usage example with argument unpacking
kwargs: DescribeAuditFindingRequestRequestTypeDef = { # (1)
"findingId": ...,
}
parent.describe_audit_finding(**kwargs)describe_audit_mitigation_actions_task#
Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings.
Type annotations and code completion for boto3.client("iot").describe_audit_mitigation_actions_task method.
boto3 documentation
# describe_audit_mitigation_actions_task method definition
def describe_audit_mitigation_actions_task(
self,
*,
taskId: str,
) -> DescribeAuditMitigationActionsTaskResponseTypeDef: # (1)
...# describe_audit_mitigation_actions_task method usage example with argument unpacking
kwargs: DescribeAuditMitigationActionsTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.describe_audit_mitigation_actions_task(**kwargs)describe_audit_suppression#
Gets information about a Device Defender audit suppression.
Type annotations and code completion for boto3.client("iot").describe_audit_suppression method.
boto3 documentation
# describe_audit_suppression method definition
def describe_audit_suppression(
self,
*,
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
) -> DescribeAuditSuppressionResponseTypeDef: # (2)
...# describe_audit_suppression method usage example with argument unpacking
kwargs: DescribeAuditSuppressionRequestRequestTypeDef = { # (1)
"checkName": ...,
"resourceIdentifier": ...,
}
parent.describe_audit_suppression(**kwargs)describe_audit_task#
Gets information about a Device Defender audit.
Type annotations and code completion for boto3.client("iot").describe_audit_task method.
boto3 documentation
# describe_audit_task method definition
def describe_audit_task(
self,
*,
taskId: str,
) -> DescribeAuditTaskResponseTypeDef: # (1)
...# describe_audit_task method usage example with argument unpacking
kwargs: DescribeAuditTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.describe_audit_task(**kwargs)describe_authorizer#
Describes an authorizer.
Type annotations and code completion for boto3.client("iot").describe_authorizer method.
boto3 documentation
# describe_authorizer method definition
def describe_authorizer(
self,
*,
authorizerName: str,
) -> DescribeAuthorizerResponseTypeDef: # (1)
...# describe_authorizer method usage example with argument unpacking
kwargs: DescribeAuthorizerRequestRequestTypeDef = { # (1)
"authorizerName": ...,
}
parent.describe_authorizer(**kwargs)describe_billing_group#
Returns information about a billing group.
Type annotations and code completion for boto3.client("iot").describe_billing_group method.
boto3 documentation
# describe_billing_group method definition
def describe_billing_group(
self,
*,
billingGroupName: str,
) -> DescribeBillingGroupResponseTypeDef: # (1)
...# describe_billing_group method usage example with argument unpacking
kwargs: DescribeBillingGroupRequestRequestTypeDef = { # (1)
"billingGroupName": ...,
}
parent.describe_billing_group(**kwargs)describe_ca_certificate#
Describes a registered CA certificate.
Type annotations and code completion for boto3.client("iot").describe_ca_certificate method.
boto3 documentation
# describe_ca_certificate method definition
def describe_ca_certificate(
self,
*,
certificateId: str,
) -> DescribeCACertificateResponseTypeDef: # (1)
...# describe_ca_certificate method usage example with argument unpacking
kwargs: DescribeCACertificateRequestRequestTypeDef = { # (1)
"certificateId": ...,
}
parent.describe_ca_certificate(**kwargs)describe_certificate#
Gets information about the specified certificate.
Type annotations and code completion for boto3.client("iot").describe_certificate method.
boto3 documentation
# describe_certificate method definition
def describe_certificate(
self,
*,
certificateId: str,
) -> DescribeCertificateResponseTypeDef: # (1)
...# describe_certificate method usage example with argument unpacking
kwargs: DescribeCertificateRequestRequestTypeDef = { # (1)
"certificateId": ...,
}
parent.describe_certificate(**kwargs)describe_certificate_provider#
Describes a certificate provider.
Type annotations and code completion for boto3.client("iot").describe_certificate_provider method.
boto3 documentation
# describe_certificate_provider method definition
def describe_certificate_provider(
self,
*,
certificateProviderName: str,
) -> DescribeCertificateProviderResponseTypeDef: # (1)
...# describe_certificate_provider method usage example with argument unpacking
kwargs: DescribeCertificateProviderRequestRequestTypeDef = { # (1)
"certificateProviderName": ...,
}
parent.describe_certificate_provider(**kwargs)describe_custom_metric#
Gets information about a Device Defender detect custom metric.
Type annotations and code completion for boto3.client("iot").describe_custom_metric method.
boto3 documentation
# describe_custom_metric method definition
def describe_custom_metric(
self,
*,
metricName: str,
) -> DescribeCustomMetricResponseTypeDef: # (1)
...# describe_custom_metric method usage example with argument unpacking
kwargs: DescribeCustomMetricRequestRequestTypeDef = { # (1)
"metricName": ...,
}
parent.describe_custom_metric(**kwargs)describe_default_authorizer#
Describes the default authorizer.
Type annotations and code completion for boto3.client("iot").describe_default_authorizer method.
boto3 documentation
# describe_default_authorizer method definition
def describe_default_authorizer(
self,
) -> DescribeDefaultAuthorizerResponseTypeDef: # (1)
...describe_detect_mitigation_actions_task#
Gets information about a Device Defender ML Detect mitigation action.
Type annotations and code completion for boto3.client("iot").describe_detect_mitigation_actions_task method.
boto3 documentation
# describe_detect_mitigation_actions_task method definition
def describe_detect_mitigation_actions_task(
self,
*,
taskId: str,
) -> DescribeDetectMitigationActionsTaskResponseTypeDef: # (1)
...# describe_detect_mitigation_actions_task method usage example with argument unpacking
kwargs: DescribeDetectMitigationActionsTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.describe_detect_mitigation_actions_task(**kwargs)describe_dimension#
Provides details about a dimension that is defined in your Amazon Web Services accounts.
Type annotations and code completion for boto3.client("iot").describe_dimension method.
boto3 documentation
# describe_dimension method definition
def describe_dimension(
self,
*,
name: str,
) -> DescribeDimensionResponseTypeDef: # (1)
...# describe_dimension method usage example with argument unpacking
kwargs: DescribeDimensionRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.describe_dimension(**kwargs)describe_domain_configuration#
Gets summary information about a domain configuration.
Type annotations and code completion for boto3.client("iot").describe_domain_configuration method.
boto3 documentation
# describe_domain_configuration method definition
def describe_domain_configuration(
self,
*,
domainConfigurationName: str,
) -> DescribeDomainConfigurationResponseTypeDef: # (1)
...# describe_domain_configuration method usage example with argument unpacking
kwargs: DescribeDomainConfigurationRequestRequestTypeDef = { # (1)
"domainConfigurationName": ...,
}
parent.describe_domain_configuration(**kwargs)describe_endpoint#
Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.
Type annotations and code completion for boto3.client("iot").describe_endpoint method.
boto3 documentation
# describe_endpoint method definition
def describe_endpoint(
self,
*,
endpointType: str = ...,
) -> DescribeEndpointResponseTypeDef: # (1)
...# describe_endpoint method usage example with argument unpacking
kwargs: DescribeEndpointRequestRequestTypeDef = { # (1)
"endpointType": ...,
}
parent.describe_endpoint(**kwargs)describe_event_configurations#
Describes event configurations.
Type annotations and code completion for boto3.client("iot").describe_event_configurations method.
boto3 documentation
# describe_event_configurations method definition
def describe_event_configurations(
self,
) -> DescribeEventConfigurationsResponseTypeDef: # (1)
...describe_fleet_metric#
Gets information about the specified fleet metric.
Type annotations and code completion for boto3.client("iot").describe_fleet_metric method.
boto3 documentation
# describe_fleet_metric method definition
def describe_fleet_metric(
self,
*,
metricName: str,
) -> DescribeFleetMetricResponseTypeDef: # (1)
...# describe_fleet_metric method usage example with argument unpacking
kwargs: DescribeFleetMetricRequestRequestTypeDef = { # (1)
"metricName": ...,
}
parent.describe_fleet_metric(**kwargs)describe_index#
Describes a search index.
Type annotations and code completion for boto3.client("iot").describe_index method.
boto3 documentation
# describe_index method definition
def describe_index(
self,
*,
indexName: str,
) -> DescribeIndexResponseTypeDef: # (1)
...# describe_index method usage example with argument unpacking
kwargs: DescribeIndexRequestRequestTypeDef = { # (1)
"indexName": ...,
}
parent.describe_index(**kwargs)describe_job#
Describes a job.
Type annotations and code completion for boto3.client("iot").describe_job method.
boto3 documentation
# describe_job method definition
def describe_job(
self,
*,
jobId: str,
beforeSubstitution: bool = ...,
) -> DescribeJobResponseTypeDef: # (1)
...# describe_job method usage example with argument unpacking
kwargs: DescribeJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.describe_job(**kwargs)describe_job_execution#
Describes a job execution.
Type annotations and code completion for boto3.client("iot").describe_job_execution method.
boto3 documentation
# describe_job_execution method definition
def describe_job_execution(
self,
*,
jobId: str,
thingName: str,
executionNumber: int = ...,
) -> DescribeJobExecutionResponseTypeDef: # (1)
...# describe_job_execution method usage example with argument unpacking
kwargs: DescribeJobExecutionRequestRequestTypeDef = { # (1)
"jobId": ...,
"thingName": ...,
}
parent.describe_job_execution(**kwargs)describe_job_template#
Returns information about a job template.
Type annotations and code completion for boto3.client("iot").describe_job_template method.
boto3 documentation
# describe_job_template method definition
def describe_job_template(
self,
*,
jobTemplateId: str,
) -> DescribeJobTemplateResponseTypeDef: # (1)
...# describe_job_template method usage example with argument unpacking
kwargs: DescribeJobTemplateRequestRequestTypeDef = { # (1)
"jobTemplateId": ...,
}
parent.describe_job_template(**kwargs)describe_managed_job_template#
View details of a managed job template.
Type annotations and code completion for boto3.client("iot").describe_managed_job_template method.
boto3 documentation
# describe_managed_job_template method definition
def describe_managed_job_template(
self,
*,
templateName: str,
templateVersion: str = ...,
) -> DescribeManagedJobTemplateResponseTypeDef: # (1)
...# describe_managed_job_template method usage example with argument unpacking
kwargs: DescribeManagedJobTemplateRequestRequestTypeDef = { # (1)
"templateName": ...,
}
parent.describe_managed_job_template(**kwargs)describe_mitigation_action#
Gets information about a mitigation action.
Type annotations and code completion for boto3.client("iot").describe_mitigation_action method.
boto3 documentation
# describe_mitigation_action method definition
def describe_mitigation_action(
self,
*,
actionName: str,
) -> DescribeMitigationActionResponseTypeDef: # (1)
...# describe_mitigation_action method usage example with argument unpacking
kwargs: DescribeMitigationActionRequestRequestTypeDef = { # (1)
"actionName": ...,
}
parent.describe_mitigation_action(**kwargs)describe_provisioning_template#
Returns information about a provisioning template.
Type annotations and code completion for boto3.client("iot").describe_provisioning_template method.
boto3 documentation
# describe_provisioning_template method definition
def describe_provisioning_template(
self,
*,
templateName: str,
) -> DescribeProvisioningTemplateResponseTypeDef: # (1)
...# describe_provisioning_template method usage example with argument unpacking
kwargs: DescribeProvisioningTemplateRequestRequestTypeDef = { # (1)
"templateName": ...,
}
parent.describe_provisioning_template(**kwargs)describe_provisioning_template_version#
Returns information about a provisioning template version.
Type annotations and code completion for boto3.client("iot").describe_provisioning_template_version method.
boto3 documentation
# describe_provisioning_template_version method definition
def describe_provisioning_template_version(
self,
*,
templateName: str,
versionId: int,
) -> DescribeProvisioningTemplateVersionResponseTypeDef: # (1)
...# describe_provisioning_template_version method usage example with argument unpacking
kwargs: DescribeProvisioningTemplateVersionRequestRequestTypeDef = { # (1)
"templateName": ...,
"versionId": ...,
}
parent.describe_provisioning_template_version(**kwargs)describe_role_alias#
Describes a role alias.
Type annotations and code completion for boto3.client("iot").describe_role_alias method.
boto3 documentation
# describe_role_alias method definition
def describe_role_alias(
self,
*,
roleAlias: str,
) -> DescribeRoleAliasResponseTypeDef: # (1)
...# describe_role_alias method usage example with argument unpacking
kwargs: DescribeRoleAliasRequestRequestTypeDef = { # (1)
"roleAlias": ...,
}
parent.describe_role_alias(**kwargs)describe_scheduled_audit#
Gets information about a scheduled audit.
Type annotations and code completion for boto3.client("iot").describe_scheduled_audit method.
boto3 documentation
# describe_scheduled_audit method definition
def describe_scheduled_audit(
self,
*,
scheduledAuditName: str,
) -> DescribeScheduledAuditResponseTypeDef: # (1)
...# describe_scheduled_audit method usage example with argument unpacking
kwargs: DescribeScheduledAuditRequestRequestTypeDef = { # (1)
"scheduledAuditName": ...,
}
parent.describe_scheduled_audit(**kwargs)describe_security_profile#
Gets information about a Device Defender security profile.
Type annotations and code completion for boto3.client("iot").describe_security_profile method.
boto3 documentation
# describe_security_profile method definition
def describe_security_profile(
self,
*,
securityProfileName: str,
) -> DescribeSecurityProfileResponseTypeDef: # (1)
...# describe_security_profile method usage example with argument unpacking
kwargs: DescribeSecurityProfileRequestRequestTypeDef = { # (1)
"securityProfileName": ...,
}
parent.describe_security_profile(**kwargs)describe_stream#
Gets information about a stream.
Type annotations and code completion for boto3.client("iot").describe_stream method.
boto3 documentation
# describe_stream method definition
def describe_stream(
self,
*,
streamId: str,
) -> DescribeStreamResponseTypeDef: # (1)
...# describe_stream method usage example with argument unpacking
kwargs: DescribeStreamRequestRequestTypeDef = { # (1)
"streamId": ...,
}
parent.describe_stream(**kwargs)describe_thing#
Gets information about the specified thing.
Type annotations and code completion for boto3.client("iot").describe_thing method.
boto3 documentation
# describe_thing method definition
def describe_thing(
self,
*,
thingName: str,
) -> DescribeThingResponseTypeDef: # (1)
...# describe_thing method usage example with argument unpacking
kwargs: DescribeThingRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.describe_thing(**kwargs)describe_thing_group#
Describe a thing group.
Type annotations and code completion for boto3.client("iot").describe_thing_group method.
boto3 documentation
# describe_thing_group method definition
def describe_thing_group(
self,
*,
thingGroupName: str,
) -> DescribeThingGroupResponseTypeDef: # (1)
...# describe_thing_group method usage example with argument unpacking
kwargs: DescribeThingGroupRequestRequestTypeDef = { # (1)
"thingGroupName": ...,
}
parent.describe_thing_group(**kwargs)describe_thing_registration_task#
Describes a bulk thing provisioning task.
Type annotations and code completion for boto3.client("iot").describe_thing_registration_task method.
boto3 documentation
# describe_thing_registration_task method definition
def describe_thing_registration_task(
self,
*,
taskId: str,
) -> DescribeThingRegistrationTaskResponseTypeDef: # (1)
...# describe_thing_registration_task method usage example with argument unpacking
kwargs: DescribeThingRegistrationTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.describe_thing_registration_task(**kwargs)describe_thing_type#
Gets information about the specified thing type.
Type annotations and code completion for boto3.client("iot").describe_thing_type method.
boto3 documentation
# describe_thing_type method definition
def describe_thing_type(
self,
*,
thingTypeName: str,
) -> DescribeThingTypeResponseTypeDef: # (1)
...# describe_thing_type method usage example with argument unpacking
kwargs: DescribeThingTypeRequestRequestTypeDef = { # (1)
"thingTypeName": ...,
}
parent.describe_thing_type(**kwargs)detach_policy#
Detaches a policy from the specified target.
Type annotations and code completion for boto3.client("iot").detach_policy method.
boto3 documentation
# detach_policy method definition
def detach_policy(
self,
*,
policyName: str,
target: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# detach_policy method usage example with argument unpacking
kwargs: DetachPolicyRequestRequestTypeDef = { # (1)
"policyName": ...,
"target": ...,
}
parent.detach_policy(**kwargs)detach_principal_policy#
Removes the specified policy from the specified certificate.
Type annotations and code completion for boto3.client("iot").detach_principal_policy method.
boto3 documentation
# detach_principal_policy method definition
def detach_principal_policy(
self,
*,
policyName: str,
principal: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# detach_principal_policy method usage example with argument unpacking
kwargs: DetachPrincipalPolicyRequestRequestTypeDef = { # (1)
"policyName": ...,
"principal": ...,
}
parent.detach_principal_policy(**kwargs)detach_security_profile#
Disassociates a Device Defender security profile from a thing group or from this account.
Type annotations and code completion for boto3.client("iot").detach_security_profile method.
boto3 documentation
# detach_security_profile method definition
def detach_security_profile(
self,
*,
securityProfileName: str,
securityProfileTargetArn: str,
) -> dict[str, Any]:
...# detach_security_profile method usage example with argument unpacking
kwargs: DetachSecurityProfileRequestRequestTypeDef = { # (1)
"securityProfileName": ...,
"securityProfileTargetArn": ...,
}
parent.detach_security_profile(**kwargs)detach_thing_principal#
Detaches the specified principal from the specified thing.
Type annotations and code completion for boto3.client("iot").detach_thing_principal method.
boto3 documentation
# detach_thing_principal method definition
def detach_thing_principal(
self,
*,
thingName: str,
principal: str,
) -> dict[str, Any]:
...# detach_thing_principal method usage example with argument unpacking
kwargs: DetachThingPrincipalRequestRequestTypeDef = { # (1)
"thingName": ...,
"principal": ...,
}
parent.detach_thing_principal(**kwargs)disable_topic_rule#
Disables the rule.
Type annotations and code completion for boto3.client("iot").disable_topic_rule method.
boto3 documentation
# disable_topic_rule method definition
def disable_topic_rule(
self,
*,
ruleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disable_topic_rule method usage example with argument unpacking
kwargs: DisableTopicRuleRequestRequestTypeDef = { # (1)
"ruleName": ...,
}
parent.disable_topic_rule(**kwargs)disassociate_sbom_from_package_version#
Disassociates the selected software bill of materials (SBOM) from a specific software package version.
Type annotations and code completion for boto3.client("iot").disassociate_sbom_from_package_version method.
boto3 documentation
# disassociate_sbom_from_package_version method definition
def disassociate_sbom_from_package_version(
self,
*,
packageName: str,
versionName: str,
clientToken: str = ...,
) -> dict[str, Any]:
...# disassociate_sbom_from_package_version method usage example with argument unpacking
kwargs: DisassociateSbomFromPackageVersionRequestRequestTypeDef = { # (1)
"packageName": ...,
"versionName": ...,
}
parent.disassociate_sbom_from_package_version(**kwargs)enable_topic_rule#
Enables the rule.
Type annotations and code completion for boto3.client("iot").enable_topic_rule method.
boto3 documentation
# enable_topic_rule method definition
def enable_topic_rule(
self,
*,
ruleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# enable_topic_rule method usage example with argument unpacking
kwargs: EnableTopicRuleRequestRequestTypeDef = { # (1)
"ruleName": ...,
}
parent.enable_topic_rule(**kwargs)get_behavior_model_training_summaries#
Returns a Device Defender's ML Detect Security Profile training model's status.
Type annotations and code completion for boto3.client("iot").get_behavior_model_training_summaries method.
boto3 documentation
# get_behavior_model_training_summaries method definition
def get_behavior_model_training_summaries(
self,
*,
securityProfileName: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> GetBehaviorModelTrainingSummariesResponseTypeDef: # (1)
...# get_behavior_model_training_summaries method usage example with argument unpacking
kwargs: GetBehaviorModelTrainingSummariesRequestRequestTypeDef = { # (1)
"securityProfileName": ...,
}
parent.get_behavior_model_training_summaries(**kwargs)get_buckets_aggregation#
Aggregates on indexed data with search queries pertaining to particular fields.
Type annotations and code completion for boto3.client("iot").get_buckets_aggregation method.
boto3 documentation
# get_buckets_aggregation method definition
def get_buckets_aggregation(
self,
*,
queryString: str,
aggregationField: str,
bucketsAggregationType: BucketsAggregationTypeTypeDef, # (1)
indexName: str = ...,
queryVersion: str = ...,
) -> GetBucketsAggregationResponseTypeDef: # (2)
...# get_buckets_aggregation method usage example with argument unpacking
kwargs: GetBucketsAggregationRequestRequestTypeDef = { # (1)
"queryString": ...,
"aggregationField": ...,
"bucketsAggregationType": ...,
}
parent.get_buckets_aggregation(**kwargs)get_cardinality#
Returns the approximate count of unique values that match the query.
Type annotations and code completion for boto3.client("iot").get_cardinality method.
boto3 documentation
# get_cardinality method definition
def get_cardinality(
self,
*,
queryString: str,
indexName: str = ...,
aggregationField: str = ...,
queryVersion: str = ...,
) -> GetCardinalityResponseTypeDef: # (1)
...# get_cardinality method usage example with argument unpacking
kwargs: GetCardinalityRequestRequestTypeDef = { # (1)
"queryString": ...,
}
parent.get_cardinality(**kwargs)get_command#
Gets information about the specified command.
Type annotations and code completion for boto3.client("iot").get_command method.
boto3 documentation
# get_command method definition
def get_command(
self,
*,
commandId: str,
) -> GetCommandResponseTypeDef: # (1)
...# get_command method usage example with argument unpacking
kwargs: GetCommandRequestRequestTypeDef = { # (1)
"commandId": ...,
}
parent.get_command(**kwargs)get_command_execution#
Gets information about the specific command execution on a single device.
Type annotations and code completion for boto3.client("iot").get_command_execution method.
boto3 documentation
# get_command_execution method definition
def get_command_execution(
self,
*,
executionId: str,
targetArn: str,
includeResult: bool = ...,
) -> GetCommandExecutionResponseTypeDef: # (1)
...# get_command_execution method usage example with argument unpacking
kwargs: GetCommandExecutionRequestRequestTypeDef = { # (1)
"executionId": ...,
"targetArn": ...,
}
parent.get_command_execution(**kwargs)get_effective_policies#
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.
Type annotations and code completion for boto3.client("iot").get_effective_policies method.
boto3 documentation
# get_effective_policies method definition
def get_effective_policies(
self,
*,
principal: str = ...,
cognitoIdentityPoolId: str = ...,
thingName: str = ...,
) -> GetEffectivePoliciesResponseTypeDef: # (1)
...# get_effective_policies method usage example with argument unpacking
kwargs: GetEffectivePoliciesRequestRequestTypeDef = { # (1)
"principal": ...,
}
parent.get_effective_policies(**kwargs)get_indexing_configuration#
Gets the indexing configuration.
Type annotations and code completion for boto3.client("iot").get_indexing_configuration method.
boto3 documentation
# get_indexing_configuration method definition
def get_indexing_configuration(
self,
) -> GetIndexingConfigurationResponseTypeDef: # (1)
...get_job_document#
Gets a job document.
Type annotations and code completion for boto3.client("iot").get_job_document method.
boto3 documentation
# get_job_document method definition
def get_job_document(
self,
*,
jobId: str,
beforeSubstitution: bool = ...,
) -> GetJobDocumentResponseTypeDef: # (1)
...# get_job_document method usage example with argument unpacking
kwargs: GetJobDocumentRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.get_job_document(**kwargs)get_logging_options#
Gets the logging options.
Type annotations and code completion for boto3.client("iot").get_logging_options method.
boto3 documentation
# get_logging_options method definition
def get_logging_options(
self,
) -> GetLoggingOptionsResponseTypeDef: # (1)
...get_ota_update#
Gets an OTA update.
Type annotations and code completion for boto3.client("iot").get_ota_update method.
boto3 documentation
# get_ota_update method definition
def get_ota_update(
self,
*,
otaUpdateId: str,
) -> GetOTAUpdateResponseTypeDef: # (1)
...# get_ota_update method usage example with argument unpacking
kwargs: GetOTAUpdateRequestRequestTypeDef = { # (1)
"otaUpdateId": ...,
}
parent.get_ota_update(**kwargs)get_package#
Gets information about the specified software package.
Type annotations and code completion for boto3.client("iot").get_package method.
boto3 documentation
# get_package method definition
def get_package(
self,
*,
packageName: str,
) -> GetPackageResponseTypeDef: # (1)
...# get_package method usage example with argument unpacking
kwargs: GetPackageRequestRequestTypeDef = { # (1)
"packageName": ...,
}
parent.get_package(**kwargs)get_package_configuration#
Gets information about the specified software package's configuration.
Type annotations and code completion for boto3.client("iot").get_package_configuration method.
boto3 documentation
# get_package_configuration method definition
def get_package_configuration(
self,
) -> GetPackageConfigurationResponseTypeDef: # (1)
...get_package_version#
Gets information about the specified package version.
Type annotations and code completion for boto3.client("iot").get_package_version method.
boto3 documentation
# get_package_version method definition
def get_package_version(
self,
*,
packageName: str,
versionName: str,
) -> GetPackageVersionResponseTypeDef: # (1)
...# get_package_version method usage example with argument unpacking
kwargs: GetPackageVersionRequestRequestTypeDef = { # (1)
"packageName": ...,
"versionName": ...,
}
parent.get_package_version(**kwargs)get_percentiles#
Groups the aggregated values that match the query into percentile groupings.
Type annotations and code completion for boto3.client("iot").get_percentiles method.
boto3 documentation
# get_percentiles method definition
def get_percentiles(
self,
*,
queryString: str,
indexName: str = ...,
aggregationField: str = ...,
queryVersion: str = ...,
percents: Sequence[float] = ...,
) -> GetPercentilesResponseTypeDef: # (1)
...# get_percentiles method usage example with argument unpacking
kwargs: GetPercentilesRequestRequestTypeDef = { # (1)
"queryString": ...,
}
parent.get_percentiles(**kwargs)get_policy#
Gets information about the specified policy with the policy document of the default version.
Type annotations and code completion for boto3.client("iot").get_policy method.
boto3 documentation
# get_policy method definition
def get_policy(
self,
*,
policyName: str,
) -> GetPolicyResponseTypeDef: # (1)
...# get_policy method usage example with argument unpacking
kwargs: GetPolicyRequestRequestTypeDef = { # (1)
"policyName": ...,
}
parent.get_policy(**kwargs)get_policy_version#
Gets information about the specified policy version.
Type annotations and code completion for boto3.client("iot").get_policy_version method.
boto3 documentation
# get_policy_version method definition
def get_policy_version(
self,
*,
policyName: str,
policyVersionId: str,
) -> GetPolicyVersionResponseTypeDef: # (1)
...# get_policy_version method usage example with argument unpacking
kwargs: GetPolicyVersionRequestRequestTypeDef = { # (1)
"policyName": ...,
"policyVersionId": ...,
}
parent.get_policy_version(**kwargs)get_registration_code#
Gets a registration code used to register a CA certificate with IoT.
Type annotations and code completion for boto3.client("iot").get_registration_code method.
boto3 documentation
# get_registration_code method definition
def get_registration_code(
self,
) -> GetRegistrationCodeResponseTypeDef: # (1)
...get_statistics#
Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field.
Type annotations and code completion for boto3.client("iot").get_statistics method.
boto3 documentation
# get_statistics method definition
def get_statistics(
self,
*,
queryString: str,
indexName: str = ...,
aggregationField: str = ...,
queryVersion: str = ...,
) -> GetStatisticsResponseTypeDef: # (1)
...# get_statistics method usage example with argument unpacking
kwargs: GetStatisticsRequestRequestTypeDef = { # (1)
"queryString": ...,
}
parent.get_statistics(**kwargs)get_thing_connectivity_data#
Retrieves the live connectivity status per device.
Type annotations and code completion for boto3.client("iot").get_thing_connectivity_data method.
boto3 documentation
# get_thing_connectivity_data method definition
def get_thing_connectivity_data(
self,
*,
thingName: str,
) -> GetThingConnectivityDataResponseTypeDef: # (1)
...# get_thing_connectivity_data method usage example with argument unpacking
kwargs: GetThingConnectivityDataRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.get_thing_connectivity_data(**kwargs)get_topic_rule#
Gets information about the rule.
Type annotations and code completion for boto3.client("iot").get_topic_rule method.
boto3 documentation
# get_topic_rule method definition
def get_topic_rule(
self,
*,
ruleName: str,
) -> GetTopicRuleResponseTypeDef: # (1)
...# get_topic_rule method usage example with argument unpacking
kwargs: GetTopicRuleRequestRequestTypeDef = { # (1)
"ruleName": ...,
}
parent.get_topic_rule(**kwargs)get_topic_rule_destination#
Gets information about a topic rule destination.
Type annotations and code completion for boto3.client("iot").get_topic_rule_destination method.
boto3 documentation
# get_topic_rule_destination method definition
def get_topic_rule_destination(
self,
*,
arn: str,
) -> GetTopicRuleDestinationResponseTypeDef: # (1)
...# get_topic_rule_destination method usage example with argument unpacking
kwargs: GetTopicRuleDestinationRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.get_topic_rule_destination(**kwargs)get_v2_logging_options#
Gets the fine grained logging options.
Type annotations and code completion for boto3.client("iot").get_v2_logging_options method.
boto3 documentation
# get_v2_logging_options method definition
def get_v2_logging_options(
self,
) -> GetV2LoggingOptionsResponseTypeDef: # (1)
...list_active_violations#
Lists the active violations for a given Device Defender security profile.
Type annotations and code completion for boto3.client("iot").list_active_violations method.
boto3 documentation
# list_active_violations method definition
def list_active_violations(
self,
*,
thingName: str = ...,
securityProfileName: str = ...,
behaviorCriteriaType: BehaviorCriteriaTypeType = ..., # (1)
listSuppressedAlerts: bool = ...,
verificationState: VerificationStateType = ..., # (2)
nextToken: str = ...,
maxResults: int = ...,
) -> ListActiveViolationsResponseTypeDef: # (3)
...# list_active_violations method usage example with argument unpacking
kwargs: ListActiveViolationsRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.list_active_violations(**kwargs)list_attached_policies#
Lists the policies attached to the specified thing group.
Type annotations and code completion for boto3.client("iot").list_attached_policies method.
boto3 documentation
# list_attached_policies method definition
def list_attached_policies(
self,
*,
target: str,
recursive: bool = ...,
marker: str = ...,
pageSize: int = ...,
) -> ListAttachedPoliciesResponseTypeDef: # (1)
...# list_attached_policies method usage example with argument unpacking
kwargs: ListAttachedPoliciesRequestRequestTypeDef = { # (1)
"target": ...,
}
parent.list_attached_policies(**kwargs)list_audit_findings#
Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period.
Type annotations and code completion for boto3.client("iot").list_audit_findings method.
boto3 documentation
# list_audit_findings method definition
def list_audit_findings(
self,
*,
taskId: str = ...,
checkName: str = ...,
resourceIdentifier: ResourceIdentifierTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
startTime: TimestampTypeDef = ...,
endTime: TimestampTypeDef = ...,
listSuppressedFindings: bool = ...,
) -> ListAuditFindingsResponseTypeDef: # (2)
...# list_audit_findings method usage example with argument unpacking
kwargs: ListAuditFindingsRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.list_audit_findings(**kwargs)list_audit_mitigation_actions_executions#
Gets the status of audit mitigation action tasks that were executed.
Type annotations and code completion for boto3.client("iot").list_audit_mitigation_actions_executions method.
boto3 documentation
# list_audit_mitigation_actions_executions method definition
def list_audit_mitigation_actions_executions(
self,
*,
taskId: str,
findingId: str,
actionStatus: AuditMitigationActionsExecutionStatusType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListAuditMitigationActionsExecutionsResponseTypeDef: # (2)
...- See AuditMitigationActionsExecutionStatusType
- See ListAuditMitigationActionsExecutionsResponseTypeDef
# list_audit_mitigation_actions_executions method usage example with argument unpacking
kwargs: ListAuditMitigationActionsExecutionsRequestRequestTypeDef = { # (1)
"taskId": ...,
"findingId": ...,
}
parent.list_audit_mitigation_actions_executions(**kwargs)list_audit_mitigation_actions_tasks#
Gets a list of audit mitigation action tasks that match the specified filters.
Type annotations and code completion for boto3.client("iot").list_audit_mitigation_actions_tasks method.
boto3 documentation
# list_audit_mitigation_actions_tasks method definition
def list_audit_mitigation_actions_tasks(
self,
*,
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
auditTaskId: str = ...,
findingId: str = ...,
taskStatus: AuditMitigationActionsTaskStatusType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListAuditMitigationActionsTasksResponseTypeDef: # (2)
...# list_audit_mitigation_actions_tasks method usage example with argument unpacking
kwargs: ListAuditMitigationActionsTasksRequestRequestTypeDef = { # (1)
"startTime": ...,
"endTime": ...,
}
parent.list_audit_mitigation_actions_tasks(**kwargs)list_audit_suppressions#
Lists your Device Defender audit listings.
Type annotations and code completion for boto3.client("iot").list_audit_suppressions method.
boto3 documentation
# list_audit_suppressions method definition
def list_audit_suppressions(
self,
*,
checkName: str = ...,
resourceIdentifier: ResourceIdentifierTypeDef = ..., # (1)
ascendingOrder: bool = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListAuditSuppressionsResponseTypeDef: # (2)
...# list_audit_suppressions method usage example with argument unpacking
kwargs: ListAuditSuppressionsRequestRequestTypeDef = { # (1)
"checkName": ...,
}
parent.list_audit_suppressions(**kwargs)list_audit_tasks#
Lists the Device Defender audits that have been performed during a given time period.
Type annotations and code completion for boto3.client("iot").list_audit_tasks method.
boto3 documentation
# list_audit_tasks method definition
def list_audit_tasks(
self,
*,
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
taskType: AuditTaskTypeType = ..., # (1)
taskStatus: AuditTaskStatusType = ..., # (2)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAuditTasksResponseTypeDef: # (3)
...# list_audit_tasks method usage example with argument unpacking
kwargs: ListAuditTasksRequestRequestTypeDef = { # (1)
"startTime": ...,
"endTime": ...,
}
parent.list_audit_tasks(**kwargs)list_authorizers#
Lists the authorizers registered in your account.
Type annotations and code completion for boto3.client("iot").list_authorizers method.
boto3 documentation
# list_authorizers method definition
def list_authorizers(
self,
*,
pageSize: int = ...,
marker: str = ...,
ascendingOrder: bool = ...,
status: AuthorizerStatusType = ..., # (1)
) -> ListAuthorizersResponseTypeDef: # (2)
...# list_authorizers method usage example with argument unpacking
kwargs: ListAuthorizersRequestRequestTypeDef = { # (1)
"pageSize": ...,
}
parent.list_authorizers(**kwargs)list_billing_groups#
Lists the billing groups you have created.
Type annotations and code completion for boto3.client("iot").list_billing_groups method.
boto3 documentation
# list_billing_groups method definition
def list_billing_groups(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
namePrefixFilter: str = ...,
) -> ListBillingGroupsResponseTypeDef: # (1)
...# list_billing_groups method usage example with argument unpacking
kwargs: ListBillingGroupsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_billing_groups(**kwargs)list_ca_certificates#
Lists the CA certificates registered for your Amazon Web Services account.
Type annotations and code completion for boto3.client("iot").list_ca_certificates method.
boto3 documentation
# list_ca_certificates method definition
def list_ca_certificates(
self,
*,
pageSize: int = ...,
marker: str = ...,
ascendingOrder: bool = ...,
templateName: str = ...,
) -> ListCACertificatesResponseTypeDef: # (1)
...# list_ca_certificates method usage example with argument unpacking
kwargs: ListCACertificatesRequestRequestTypeDef = { # (1)
"pageSize": ...,
}
parent.list_ca_certificates(**kwargs)list_certificate_providers#
Lists all your certificate providers in your Amazon Web Services account.
Type annotations and code completion for boto3.client("iot").list_certificate_providers method.
boto3 documentation
# list_certificate_providers method definition
def list_certificate_providers(
self,
*,
nextToken: str = ...,
ascendingOrder: bool = ...,
) -> ListCertificateProvidersResponseTypeDef: # (1)
...# list_certificate_providers method usage example with argument unpacking
kwargs: ListCertificateProvidersRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_certificate_providers(**kwargs)list_certificates#
Lists the certificates registered in your Amazon Web Services account.
Type annotations and code completion for boto3.client("iot").list_certificates method.
boto3 documentation
# list_certificates method definition
def list_certificates(
self,
*,
pageSize: int = ...,
marker: str = ...,
ascendingOrder: bool = ...,
) -> ListCertificatesResponseTypeDef: # (1)
...# list_certificates method usage example with argument unpacking
kwargs: ListCertificatesRequestRequestTypeDef = { # (1)
"pageSize": ...,
}
parent.list_certificates(**kwargs)list_certificates_by_ca#
List the device certificates signed by the specified CA certificate.
Type annotations and code completion for boto3.client("iot").list_certificates_by_ca method.
boto3 documentation
# list_certificates_by_ca method definition
def list_certificates_by_ca(
self,
*,
caCertificateId: str,
pageSize: int = ...,
marker: str = ...,
ascendingOrder: bool = ...,
) -> ListCertificatesByCAResponseTypeDef: # (1)
...# list_certificates_by_ca method usage example with argument unpacking
kwargs: ListCertificatesByCARequestRequestTypeDef = { # (1)
"caCertificateId": ...,
}
parent.list_certificates_by_ca(**kwargs)list_command_executions#
List all command executions.
Type annotations and code completion for boto3.client("iot").list_command_executions method.
boto3 documentation
# list_command_executions method definition
def list_command_executions(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
namespace: CommandNamespaceType = ..., # (1)
status: CommandExecutionStatusType = ..., # (2)
sortOrder: SortOrderType = ..., # (3)
startedTimeFilter: TimeFilterTypeDef = ..., # (4)
completedTimeFilter: TimeFilterTypeDef = ..., # (4)
targetArn: str = ...,
commandArn: str = ...,
) -> ListCommandExecutionsResponseTypeDef: # (6)
...- See CommandNamespaceType
- See CommandExecutionStatusType
- See SortOrderType
- See TimeFilterTypeDef
- See TimeFilterTypeDef
- See ListCommandExecutionsResponseTypeDef
# list_command_executions method usage example with argument unpacking
kwargs: ListCommandExecutionsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_command_executions(**kwargs)list_commands#
List all commands in your account.
Type annotations and code completion for boto3.client("iot").list_commands method.
boto3 documentation
# list_commands method definition
def list_commands(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
namespace: CommandNamespaceType = ..., # (1)
commandParameterName: str = ...,
sortOrder: SortOrderType = ..., # (2)
) -> ListCommandsResponseTypeDef: # (3)
...# list_commands method usage example with argument unpacking
kwargs: ListCommandsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_commands(**kwargs)list_custom_metrics#
Lists your Device Defender detect custom metrics.
Type annotations and code completion for boto3.client("iot").list_custom_metrics method.
boto3 documentation
# list_custom_metrics method definition
def list_custom_metrics(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListCustomMetricsResponseTypeDef: # (1)
...# list_custom_metrics method usage example with argument unpacking
kwargs: ListCustomMetricsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_custom_metrics(**kwargs)list_detect_mitigation_actions_executions#
Lists mitigation actions executions for a Device Defender ML Detect Security Profile.
Type annotations and code completion for boto3.client("iot").list_detect_mitigation_actions_executions method.
boto3 documentation
# list_detect_mitigation_actions_executions method definition
def list_detect_mitigation_actions_executions(
self,
*,
taskId: str = ...,
violationId: str = ...,
thingName: str = ...,
startTime: TimestampTypeDef = ...,
endTime: TimestampTypeDef = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListDetectMitigationActionsExecutionsResponseTypeDef: # (1)
...# list_detect_mitigation_actions_executions method usage example with argument unpacking
kwargs: ListDetectMitigationActionsExecutionsRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.list_detect_mitigation_actions_executions(**kwargs)list_detect_mitigation_actions_tasks#
List of Device Defender ML Detect mitigation actions tasks.
Type annotations and code completion for boto3.client("iot").list_detect_mitigation_actions_tasks method.
boto3 documentation
# list_detect_mitigation_actions_tasks method definition
def list_detect_mitigation_actions_tasks(
self,
*,
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
maxResults: int = ...,
nextToken: str = ...,
) -> ListDetectMitigationActionsTasksResponseTypeDef: # (1)
...# list_detect_mitigation_actions_tasks method usage example with argument unpacking
kwargs: ListDetectMitigationActionsTasksRequestRequestTypeDef = { # (1)
"startTime": ...,
"endTime": ...,
}
parent.list_detect_mitigation_actions_tasks(**kwargs)list_dimensions#
List the set of dimensions that are defined for your Amazon Web Services accounts.
Type annotations and code completion for boto3.client("iot").list_dimensions method.
boto3 documentation
# list_dimensions method definition
def list_dimensions(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListDimensionsResponseTypeDef: # (1)
...# list_dimensions method usage example with argument unpacking
kwargs: ListDimensionsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_dimensions(**kwargs)list_domain_configurations#
Gets a list of domain configurations for the user.
Type annotations and code completion for boto3.client("iot").list_domain_configurations method.
boto3 documentation
# list_domain_configurations method definition
def list_domain_configurations(
self,
*,
marker: str = ...,
pageSize: int = ...,
serviceType: ServiceTypeType = ..., # (1)
) -> ListDomainConfigurationsResponseTypeDef: # (2)
...# list_domain_configurations method usage example with argument unpacking
kwargs: ListDomainConfigurationsRequestRequestTypeDef = { # (1)
"marker": ...,
}
parent.list_domain_configurations(**kwargs)list_fleet_metrics#
Lists all your fleet metrics.
Type annotations and code completion for boto3.client("iot").list_fleet_metrics method.
boto3 documentation
# list_fleet_metrics method definition
def list_fleet_metrics(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListFleetMetricsResponseTypeDef: # (1)
...# list_fleet_metrics method usage example with argument unpacking
kwargs: ListFleetMetricsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_fleet_metrics(**kwargs)list_indices#
Lists the search indices.
Type annotations and code completion for boto3.client("iot").list_indices method.
boto3 documentation
# list_indices method definition
def list_indices(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListIndicesResponseTypeDef: # (1)
...# list_indices method usage example with argument unpacking
kwargs: ListIndicesRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_indices(**kwargs)list_job_executions_for_job#
Lists the job executions for a job.
Type annotations and code completion for boto3.client("iot").list_job_executions_for_job method.
boto3 documentation
# list_job_executions_for_job method definition
def list_job_executions_for_job(
self,
*,
jobId: str,
status: JobExecutionStatusType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListJobExecutionsForJobResponseTypeDef: # (2)
...# list_job_executions_for_job method usage example with argument unpacking
kwargs: ListJobExecutionsForJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.list_job_executions_for_job(**kwargs)list_job_executions_for_thing#
Lists the job executions for the specified thing.
Type annotations and code completion for boto3.client("iot").list_job_executions_for_thing method.
boto3 documentation
# list_job_executions_for_thing method definition
def list_job_executions_for_thing(
self,
*,
thingName: str,
status: JobExecutionStatusType = ..., # (1)
namespaceId: str = ...,
maxResults: int = ...,
nextToken: str = ...,
jobId: str = ...,
) -> ListJobExecutionsForThingResponseTypeDef: # (2)
...# list_job_executions_for_thing method usage example with argument unpacking
kwargs: ListJobExecutionsForThingRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.list_job_executions_for_thing(**kwargs)list_job_templates#
Returns a list of job templates.
Type annotations and code completion for boto3.client("iot").list_job_templates method.
boto3 documentation
# list_job_templates method definition
def list_job_templates(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListJobTemplatesResponseTypeDef: # (1)
...# list_job_templates method usage example with argument unpacking
kwargs: ListJobTemplatesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_job_templates(**kwargs)list_jobs#
Lists jobs.
Type annotations and code completion for boto3.client("iot").list_jobs method.
boto3 documentation
# list_jobs method definition
def list_jobs(
self,
*,
status: JobStatusType = ..., # (1)
targetSelection: TargetSelectionType = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
thingGroupName: str = ...,
thingGroupId: str = ...,
namespaceId: str = ...,
) -> ListJobsResponseTypeDef: # (3)
...- See JobStatusType
- See TargetSelectionType
- See ListJobsResponseTypeDef
# list_jobs method usage example with argument unpacking
kwargs: ListJobsRequestRequestTypeDef = { # (1)
"status": ...,
}
parent.list_jobs(**kwargs)list_managed_job_templates#
Returns a list of managed job templates.
Type annotations and code completion for boto3.client("iot").list_managed_job_templates method.
boto3 documentation
# list_managed_job_templates method definition
def list_managed_job_templates(
self,
*,
templateName: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListManagedJobTemplatesResponseTypeDef: # (1)
...# list_managed_job_templates method usage example with argument unpacking
kwargs: ListManagedJobTemplatesRequestRequestTypeDef = { # (1)
"templateName": ...,
}
parent.list_managed_job_templates(**kwargs)list_metric_values#
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.
Type annotations and code completion for boto3.client("iot").list_metric_values method.
boto3 documentation
# list_metric_values method definition
def list_metric_values(
self,
*,
thingName: str,
metricName: str,
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
dimensionName: str = ...,
dimensionValueOperator: DimensionValueOperatorType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListMetricValuesResponseTypeDef: # (2)
...# list_metric_values method usage example with argument unpacking
kwargs: ListMetricValuesRequestRequestTypeDef = { # (1)
"thingName": ...,
"metricName": ...,
"startTime": ...,
"endTime": ...,
}
parent.list_metric_values(**kwargs)list_mitigation_actions#
Gets a list of all mitigation actions that match the specified filter criteria.
Type annotations and code completion for boto3.client("iot").list_mitigation_actions method.
boto3 documentation
# list_mitigation_actions method definition
def list_mitigation_actions(
self,
*,
actionType: MitigationActionTypeType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListMitigationActionsResponseTypeDef: # (2)
...# list_mitigation_actions method usage example with argument unpacking
kwargs: ListMitigationActionsRequestRequestTypeDef = { # (1)
"actionType": ...,
}
parent.list_mitigation_actions(**kwargs)list_ota_updates#
Lists OTA updates.
Type annotations and code completion for boto3.client("iot").list_ota_updates method.
boto3 documentation
# list_ota_updates method definition
def list_ota_updates(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
otaUpdateStatus: OTAUpdateStatusType = ..., # (1)
) -> ListOTAUpdatesResponseTypeDef: # (2)
...# list_ota_updates method usage example with argument unpacking
kwargs: ListOTAUpdatesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_ota_updates(**kwargs)list_outgoing_certificates#
Lists certificates that are being transferred but not yet accepted.
Type annotations and code completion for boto3.client("iot").list_outgoing_certificates method.
boto3 documentation
# list_outgoing_certificates method definition
def list_outgoing_certificates(
self,
*,
pageSize: int = ...,
marker: str = ...,
ascendingOrder: bool = ...,
) -> ListOutgoingCertificatesResponseTypeDef: # (1)
...# list_outgoing_certificates method usage example with argument unpacking
kwargs: ListOutgoingCertificatesRequestRequestTypeDef = { # (1)
"pageSize": ...,
}
parent.list_outgoing_certificates(**kwargs)list_package_versions#
Lists the software package versions associated to the account.
Type annotations and code completion for boto3.client("iot").list_package_versions method.
boto3 documentation
# list_package_versions method definition
def list_package_versions(
self,
*,
packageName: str,
status: PackageVersionStatusType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListPackageVersionsResponseTypeDef: # (2)
...# list_package_versions method usage example with argument unpacking
kwargs: ListPackageVersionsRequestRequestTypeDef = { # (1)
"packageName": ...,
}
parent.list_package_versions(**kwargs)list_packages#
Lists the software packages associated to the account.
Type annotations and code completion for boto3.client("iot").list_packages method.
boto3 documentation
# list_packages method definition
def list_packages(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListPackagesResponseTypeDef: # (1)
...# list_packages method usage example with argument unpacking
kwargs: ListPackagesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_packages(**kwargs)list_policies#
Lists your policies.
Type annotations and code completion for boto3.client("iot").list_policies method.
boto3 documentation
# list_policies method definition
def list_policies(
self,
*,
marker: str = ...,
pageSize: int = ...,
ascendingOrder: bool = ...,
) -> ListPoliciesResponseTypeDef: # (1)
...# list_policies method usage example with argument unpacking
kwargs: ListPoliciesRequestRequestTypeDef = { # (1)
"marker": ...,
}
parent.list_policies(**kwargs)list_policy_principals#
Lists the principals associated with the specified policy.
Type annotations and code completion for boto3.client("iot").list_policy_principals method.
boto3 documentation
# list_policy_principals method definition
def list_policy_principals(
self,
*,
policyName: str,
marker: str = ...,
pageSize: int = ...,
ascendingOrder: bool = ...,
) -> ListPolicyPrincipalsResponseTypeDef: # (1)
...# list_policy_principals method usage example with argument unpacking
kwargs: ListPolicyPrincipalsRequestRequestTypeDef = { # (1)
"policyName": ...,
}
parent.list_policy_principals(**kwargs)list_policy_versions#
Lists the versions of the specified policy and identifies the default version.
Type annotations and code completion for boto3.client("iot").list_policy_versions method.
boto3 documentation
# list_policy_versions method definition
def list_policy_versions(
self,
*,
policyName: str,
) -> ListPolicyVersionsResponseTypeDef: # (1)
...# list_policy_versions method usage example with argument unpacking
kwargs: ListPolicyVersionsRequestRequestTypeDef = { # (1)
"policyName": ...,
}
parent.list_policy_versions(**kwargs)list_principal_policies#
Lists the policies attached to the specified principal.
Type annotations and code completion for boto3.client("iot").list_principal_policies method.
boto3 documentation
# list_principal_policies method definition
def list_principal_policies(
self,
*,
principal: str,
marker: str = ...,
pageSize: int = ...,
ascendingOrder: bool = ...,
) -> ListPrincipalPoliciesResponseTypeDef: # (1)
...# list_principal_policies method usage example with argument unpacking
kwargs: ListPrincipalPoliciesRequestRequestTypeDef = { # (1)
"principal": ...,
}
parent.list_principal_policies(**kwargs)list_principal_things#
Lists the things associated with the specified principal.
Type annotations and code completion for boto3.client("iot").list_principal_things method.
boto3 documentation
# list_principal_things method definition
def list_principal_things(
self,
*,
principal: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListPrincipalThingsResponseTypeDef: # (1)
...# list_principal_things method usage example with argument unpacking
kwargs: ListPrincipalThingsRequestRequestTypeDef = { # (1)
"principal": ...,
}
parent.list_principal_things(**kwargs)list_principal_things_v2#
Lists the things associated with the specified principal.
Type annotations and code completion for boto3.client("iot").list_principal_things_v2 method.
boto3 documentation
# list_principal_things_v2 method definition
def list_principal_things_v2(
self,
*,
principal: str,
nextToken: str = ...,
maxResults: int = ...,
thingPrincipalType: ThingPrincipalTypeType = ..., # (1)
) -> ListPrincipalThingsV2ResponseTypeDef: # (2)
...# list_principal_things_v2 method usage example with argument unpacking
kwargs: ListPrincipalThingsV2RequestRequestTypeDef = { # (1)
"principal": ...,
}
parent.list_principal_things_v2(**kwargs)list_provisioning_template_versions#
A list of provisioning template versions.
Type annotations and code completion for boto3.client("iot").list_provisioning_template_versions method.
boto3 documentation
# list_provisioning_template_versions method definition
def list_provisioning_template_versions(
self,
*,
templateName: str,
maxResults: int = ...,
nextToken: str = ...,
) -> ListProvisioningTemplateVersionsResponseTypeDef: # (1)
...# list_provisioning_template_versions method usage example with argument unpacking
kwargs: ListProvisioningTemplateVersionsRequestRequestTypeDef = { # (1)
"templateName": ...,
}
parent.list_provisioning_template_versions(**kwargs)list_provisioning_templates#
Lists the provisioning templates in your Amazon Web Services account.
Type annotations and code completion for boto3.client("iot").list_provisioning_templates method.
boto3 documentation
# list_provisioning_templates method definition
def list_provisioning_templates(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListProvisioningTemplatesResponseTypeDef: # (1)
...# list_provisioning_templates method usage example with argument unpacking
kwargs: ListProvisioningTemplatesRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_provisioning_templates(**kwargs)list_related_resources_for_audit_finding#
The related resources of an Audit finding.
Type annotations and code completion for boto3.client("iot").list_related_resources_for_audit_finding method.
boto3 documentation
# list_related_resources_for_audit_finding method definition
def list_related_resources_for_audit_finding(
self,
*,
findingId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListRelatedResourcesForAuditFindingResponseTypeDef: # (1)
...# list_related_resources_for_audit_finding method usage example with argument unpacking
kwargs: ListRelatedResourcesForAuditFindingRequestRequestTypeDef = { # (1)
"findingId": ...,
}
parent.list_related_resources_for_audit_finding(**kwargs)list_role_aliases#
Lists the role aliases registered in your account.
Type annotations and code completion for boto3.client("iot").list_role_aliases method.
boto3 documentation
# list_role_aliases method definition
def list_role_aliases(
self,
*,
pageSize: int = ...,
marker: str = ...,
ascendingOrder: bool = ...,
) -> ListRoleAliasesResponseTypeDef: # (1)
...# list_role_aliases method usage example with argument unpacking
kwargs: ListRoleAliasesRequestRequestTypeDef = { # (1)
"pageSize": ...,
}
parent.list_role_aliases(**kwargs)list_sbom_validation_results#
The validation results for all software bill of materials (SBOM) attached to a specific software package version.
Type annotations and code completion for boto3.client("iot").list_sbom_validation_results method.
boto3 documentation
# list_sbom_validation_results method definition
def list_sbom_validation_results(
self,
*,
packageName: str,
versionName: str,
validationResult: SbomValidationResultType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListSbomValidationResultsResponseTypeDef: # (2)
...# list_sbom_validation_results method usage example with argument unpacking
kwargs: ListSbomValidationResultsRequestRequestTypeDef = { # (1)
"packageName": ...,
"versionName": ...,
}
parent.list_sbom_validation_results(**kwargs)list_scheduled_audits#
Lists all of your scheduled audits.
Type annotations and code completion for boto3.client("iot").list_scheduled_audits method.
boto3 documentation
# list_scheduled_audits method definition
def list_scheduled_audits(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListScheduledAuditsResponseTypeDef: # (1)
...# list_scheduled_audits method usage example with argument unpacking
kwargs: ListScheduledAuditsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_scheduled_audits(**kwargs)list_security_profiles#
Lists the Device Defender security profiles you've created.
Type annotations and code completion for boto3.client("iot").list_security_profiles method.
boto3 documentation
# list_security_profiles method definition
def list_security_profiles(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
dimensionName: str = ...,
metricName: str = ...,
) -> ListSecurityProfilesResponseTypeDef: # (1)
...# list_security_profiles method usage example with argument unpacking
kwargs: ListSecurityProfilesRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_security_profiles(**kwargs)list_security_profiles_for_target#
Lists the Device Defender security profiles attached to a target (thing group).
Type annotations and code completion for boto3.client("iot").list_security_profiles_for_target method.
boto3 documentation
# list_security_profiles_for_target method definition
def list_security_profiles_for_target(
self,
*,
securityProfileTargetArn: str,
nextToken: str = ...,
maxResults: int = ...,
recursive: bool = ...,
) -> ListSecurityProfilesForTargetResponseTypeDef: # (1)
...# list_security_profiles_for_target method usage example with argument unpacking
kwargs: ListSecurityProfilesForTargetRequestRequestTypeDef = { # (1)
"securityProfileTargetArn": ...,
}
parent.list_security_profiles_for_target(**kwargs)list_streams#
Lists all of the streams in your Amazon Web Services account.
Type annotations and code completion for boto3.client("iot").list_streams method.
boto3 documentation
# list_streams method definition
def list_streams(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
ascendingOrder: bool = ...,
) -> ListStreamsResponseTypeDef: # (1)
...# list_streams method usage example with argument unpacking
kwargs: ListStreamsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_streams(**kwargs)list_tags_for_resource#
Lists the tags (metadata) you have assigned to the resource.
Type annotations and code completion for boto3.client("iot").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
nextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)list_targets_for_policy#
List targets for the specified policy.
Type annotations and code completion for boto3.client("iot").list_targets_for_policy method.
boto3 documentation
# list_targets_for_policy method definition
def list_targets_for_policy(
self,
*,
policyName: str,
marker: str = ...,
pageSize: int = ...,
) -> ListTargetsForPolicyResponseTypeDef: # (1)
...# list_targets_for_policy method usage example with argument unpacking
kwargs: ListTargetsForPolicyRequestRequestTypeDef = { # (1)
"policyName": ...,
}
parent.list_targets_for_policy(**kwargs)list_targets_for_security_profile#
Lists the targets (thing groups) associated with a given Device Defender security profile.
Type annotations and code completion for boto3.client("iot").list_targets_for_security_profile method.
boto3 documentation
# list_targets_for_security_profile method definition
def list_targets_for_security_profile(
self,
*,
securityProfileName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListTargetsForSecurityProfileResponseTypeDef: # (1)
...# list_targets_for_security_profile method usage example with argument unpacking
kwargs: ListTargetsForSecurityProfileRequestRequestTypeDef = { # (1)
"securityProfileName": ...,
}
parent.list_targets_for_security_profile(**kwargs)list_thing_groups#
List the thing groups in your account.
Type annotations and code completion for boto3.client("iot").list_thing_groups method.
boto3 documentation
# list_thing_groups method definition
def list_thing_groups(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
parentGroup: str = ...,
namePrefixFilter: str = ...,
recursive: bool = ...,
) -> ListThingGroupsResponseTypeDef: # (1)
...# list_thing_groups method usage example with argument unpacking
kwargs: ListThingGroupsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_thing_groups(**kwargs)list_thing_groups_for_thing#
List the thing groups to which the specified thing belongs.
Type annotations and code completion for boto3.client("iot").list_thing_groups_for_thing method.
boto3 documentation
# list_thing_groups_for_thing method definition
def list_thing_groups_for_thing(
self,
*,
thingName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListThingGroupsForThingResponseTypeDef: # (1)
...# list_thing_groups_for_thing method usage example with argument unpacking
kwargs: ListThingGroupsForThingRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.list_thing_groups_for_thing(**kwargs)list_thing_principals#
Lists the principals associated with the specified thing.
Type annotations and code completion for boto3.client("iot").list_thing_principals method.
boto3 documentation
# list_thing_principals method definition
def list_thing_principals(
self,
*,
thingName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListThingPrincipalsResponseTypeDef: # (1)
...# list_thing_principals method usage example with argument unpacking
kwargs: ListThingPrincipalsRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.list_thing_principals(**kwargs)list_thing_principals_v2#
Lists the principals associated with the specified thing.
Type annotations and code completion for boto3.client("iot").list_thing_principals_v2 method.
boto3 documentation
# list_thing_principals_v2 method definition
def list_thing_principals_v2(
self,
*,
thingName: str,
nextToken: str = ...,
maxResults: int = ...,
thingPrincipalType: ThingPrincipalTypeType = ..., # (1)
) -> ListThingPrincipalsV2ResponseTypeDef: # (2)
...# list_thing_principals_v2 method usage example with argument unpacking
kwargs: ListThingPrincipalsV2RequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.list_thing_principals_v2(**kwargs)list_thing_registration_task_reports#
Information about the thing registration tasks.
Type annotations and code completion for boto3.client("iot").list_thing_registration_task_reports method.
boto3 documentation
# list_thing_registration_task_reports method definition
def list_thing_registration_task_reports(
self,
*,
taskId: str,
reportType: ReportTypeType, # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListThingRegistrationTaskReportsResponseTypeDef: # (2)
...# list_thing_registration_task_reports method usage example with argument unpacking
kwargs: ListThingRegistrationTaskReportsRequestRequestTypeDef = { # (1)
"taskId": ...,
"reportType": ...,
}
parent.list_thing_registration_task_reports(**kwargs)list_thing_registration_tasks#
List bulk thing provisioning tasks.
Type annotations and code completion for boto3.client("iot").list_thing_registration_tasks method.
boto3 documentation
# list_thing_registration_tasks method definition
def list_thing_registration_tasks(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
status: StatusType = ..., # (1)
) -> ListThingRegistrationTasksResponseTypeDef: # (2)
...# list_thing_registration_tasks method usage example with argument unpacking
kwargs: ListThingRegistrationTasksRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_thing_registration_tasks(**kwargs)list_thing_types#
Lists the existing thing types.
Type annotations and code completion for boto3.client("iot").list_thing_types method.
boto3 documentation
# list_thing_types method definition
def list_thing_types(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
thingTypeName: str = ...,
) -> ListThingTypesResponseTypeDef: # (1)
...# list_thing_types method usage example with argument unpacking
kwargs: ListThingTypesRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_thing_types(**kwargs)list_things#
Lists your things.
Type annotations and code completion for boto3.client("iot").list_things method.
boto3 documentation
# list_things method definition
def list_things(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
attributeName: str = ...,
attributeValue: str = ...,
thingTypeName: str = ...,
usePrefixAttributeValue: bool = ...,
) -> ListThingsResponseTypeDef: # (1)
...# list_things method usage example with argument unpacking
kwargs: ListThingsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_things(**kwargs)list_things_in_billing_group#
Lists the things you have added to the given billing group.
Type annotations and code completion for boto3.client("iot").list_things_in_billing_group method.
boto3 documentation
# list_things_in_billing_group method definition
def list_things_in_billing_group(
self,
*,
billingGroupName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListThingsInBillingGroupResponseTypeDef: # (1)
...# list_things_in_billing_group method usage example with argument unpacking
kwargs: ListThingsInBillingGroupRequestRequestTypeDef = { # (1)
"billingGroupName": ...,
}
parent.list_things_in_billing_group(**kwargs)list_things_in_thing_group#
Lists the things in the specified group.
Type annotations and code completion for boto3.client("iot").list_things_in_thing_group method.
boto3 documentation
# list_things_in_thing_group method definition
def list_things_in_thing_group(
self,
*,
thingGroupName: str,
recursive: bool = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListThingsInThingGroupResponseTypeDef: # (1)
...# list_things_in_thing_group method usage example with argument unpacking
kwargs: ListThingsInThingGroupRequestRequestTypeDef = { # (1)
"thingGroupName": ...,
}
parent.list_things_in_thing_group(**kwargs)list_topic_rule_destinations#
Lists all the topic rule destinations in your Amazon Web Services account.
Type annotations and code completion for boto3.client("iot").list_topic_rule_destinations method.
boto3 documentation
# list_topic_rule_destinations method definition
def list_topic_rule_destinations(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListTopicRuleDestinationsResponseTypeDef: # (1)
...# list_topic_rule_destinations method usage example with argument unpacking
kwargs: ListTopicRuleDestinationsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_topic_rule_destinations(**kwargs)list_topic_rules#
Lists the rules for the specific topic.
Type annotations and code completion for boto3.client("iot").list_topic_rules method.
boto3 documentation
# list_topic_rules method definition
def list_topic_rules(
self,
*,
topic: str = ...,
maxResults: int = ...,
nextToken: str = ...,
ruleDisabled: bool = ...,
) -> ListTopicRulesResponseTypeDef: # (1)
...# list_topic_rules method usage example with argument unpacking
kwargs: ListTopicRulesRequestRequestTypeDef = { # (1)
"topic": ...,
}
parent.list_topic_rules(**kwargs)list_v2_logging_levels#
Lists logging levels.
Type annotations and code completion for boto3.client("iot").list_v2_logging_levels method.
boto3 documentation
# list_v2_logging_levels method definition
def list_v2_logging_levels(
self,
*,
targetType: LogTargetTypeType = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListV2LoggingLevelsResponseTypeDef: # (2)
...# list_v2_logging_levels method usage example with argument unpacking
kwargs: ListV2LoggingLevelsRequestRequestTypeDef = { # (1)
"targetType": ...,
}
parent.list_v2_logging_levels(**kwargs)list_violation_events#
Lists the Device Defender security profile violations discovered during the given time period.
Type annotations and code completion for boto3.client("iot").list_violation_events method.
boto3 documentation
# list_violation_events method definition
def list_violation_events(
self,
*,
startTime: TimestampTypeDef,
endTime: TimestampTypeDef,
thingName: str = ...,
securityProfileName: str = ...,
behaviorCriteriaType: BehaviorCriteriaTypeType = ..., # (1)
listSuppressedAlerts: bool = ...,
verificationState: VerificationStateType = ..., # (2)
nextToken: str = ...,
maxResults: int = ...,
) -> ListViolationEventsResponseTypeDef: # (3)
...# list_violation_events method usage example with argument unpacking
kwargs: ListViolationEventsRequestRequestTypeDef = { # (1)
"startTime": ...,
"endTime": ...,
}
parent.list_violation_events(**kwargs)put_verification_state_on_violation#
Set a verification state and provide a description of that verification state on a violation (detect alarm).
Type annotations and code completion for boto3.client("iot").put_verification_state_on_violation method.
boto3 documentation
# put_verification_state_on_violation method definition
def put_verification_state_on_violation(
self,
*,
violationId: str,
verificationState: VerificationStateType, # (1)
verificationStateDescription: str = ...,
) -> dict[str, Any]:
...# put_verification_state_on_violation method usage example with argument unpacking
kwargs: PutVerificationStateOnViolationRequestRequestTypeDef = { # (1)
"violationId": ...,
"verificationState": ...,
}
parent.put_verification_state_on_violation(**kwargs)register_ca_certificate#
Registers a CA certificate with Amazon Web Services IoT Core.
Type annotations and code completion for boto3.client("iot").register_ca_certificate method.
boto3 documentation
# register_ca_certificate method definition
def register_ca_certificate(
self,
*,
caCertificate: str,
verificationCertificate: str = ...,
setAsActive: bool = ...,
allowAutoRegistration: bool = ...,
registrationConfig: RegistrationConfigTypeDef = ..., # (1)
tags: Sequence[TagTypeDef] = ..., # (2)
certificateMode: CertificateModeType = ..., # (3)
) -> RegisterCACertificateResponseTypeDef: # (4)
...- See RegistrationConfigTypeDef
- See TagTypeDef
- See CertificateModeType
- See RegisterCACertificateResponseTypeDef
# register_ca_certificate method usage example with argument unpacking
kwargs: RegisterCACertificateRequestRequestTypeDef = { # (1)
"caCertificate": ...,
}
parent.register_ca_certificate(**kwargs)register_certificate#
Registers a device certificate with IoT in the same certificate mode as the signing CA.
Type annotations and code completion for boto3.client("iot").register_certificate method.
boto3 documentation
# register_certificate method definition
def register_certificate(
self,
*,
certificatePem: str,
caCertificatePem: str = ...,
setAsActive: bool = ...,
status: CertificateStatusType = ..., # (1)
) -> RegisterCertificateResponseTypeDef: # (2)
...# register_certificate method usage example with argument unpacking
kwargs: RegisterCertificateRequestRequestTypeDef = { # (1)
"certificatePem": ...,
}
parent.register_certificate(**kwargs)register_certificate_without_ca#
Register a certificate that does not have a certificate authority (CA).
Type annotations and code completion for boto3.client("iot").register_certificate_without_ca method.
boto3 documentation
# register_certificate_without_ca method definition
def register_certificate_without_ca(
self,
*,
certificatePem: str,
status: CertificateStatusType = ..., # (1)
) -> RegisterCertificateWithoutCAResponseTypeDef: # (2)
...# register_certificate_without_ca method usage example with argument unpacking
kwargs: RegisterCertificateWithoutCARequestRequestTypeDef = { # (1)
"certificatePem": ...,
}
parent.register_certificate_without_ca(**kwargs)register_thing#
Provisions a thing in the device registry.
Type annotations and code completion for boto3.client("iot").register_thing method.
boto3 documentation
# register_thing method definition
def register_thing(
self,
*,
templateBody: str,
parameters: Mapping[str, str] = ...,
) -> RegisterThingResponseTypeDef: # (1)
...# register_thing method usage example with argument unpacking
kwargs: RegisterThingRequestRequestTypeDef = { # (1)
"templateBody": ...,
}
parent.register_thing(**kwargs)reject_certificate_transfer#
Rejects a pending certificate transfer.
Type annotations and code completion for boto3.client("iot").reject_certificate_transfer method.
boto3 documentation
# reject_certificate_transfer method definition
def reject_certificate_transfer(
self,
*,
certificateId: str,
rejectReason: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# reject_certificate_transfer method usage example with argument unpacking
kwargs: RejectCertificateTransferRequestRequestTypeDef = { # (1)
"certificateId": ...,
}
parent.reject_certificate_transfer(**kwargs)remove_thing_from_billing_group#
Removes the given thing from the billing group.
Type annotations and code completion for boto3.client("iot").remove_thing_from_billing_group method.
boto3 documentation
# remove_thing_from_billing_group method definition
def remove_thing_from_billing_group(
self,
*,
billingGroupName: str = ...,
billingGroupArn: str = ...,
thingName: str = ...,
thingArn: str = ...,
) -> dict[str, Any]:
...# remove_thing_from_billing_group method usage example with argument unpacking
kwargs: RemoveThingFromBillingGroupRequestRequestTypeDef = { # (1)
"billingGroupName": ...,
}
parent.remove_thing_from_billing_group(**kwargs)remove_thing_from_thing_group#
Remove the specified thing from the specified group.
Type annotations and code completion for boto3.client("iot").remove_thing_from_thing_group method.
boto3 documentation
# remove_thing_from_thing_group method definition
def remove_thing_from_thing_group(
self,
*,
thingGroupName: str = ...,
thingGroupArn: str = ...,
thingName: str = ...,
thingArn: str = ...,
) -> dict[str, Any]:
...# remove_thing_from_thing_group method usage example with argument unpacking
kwargs: RemoveThingFromThingGroupRequestRequestTypeDef = { # (1)
"thingGroupName": ...,
}
parent.remove_thing_from_thing_group(**kwargs)replace_topic_rule#
Replaces the rule.
Type annotations and code completion for boto3.client("iot").replace_topic_rule method.
boto3 documentation
# replace_topic_rule method definition
def replace_topic_rule(
self,
*,
ruleName: str,
topicRulePayload: TopicRulePayloadTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# replace_topic_rule method usage example with argument unpacking
kwargs: ReplaceTopicRuleRequestRequestTypeDef = { # (1)
"ruleName": ...,
"topicRulePayload": ...,
}
parent.replace_topic_rule(**kwargs)search_index#
The query search index.
Type annotations and code completion for boto3.client("iot").search_index method.
boto3 documentation
# search_index method definition
def search_index(
self,
*,
queryString: str,
indexName: str = ...,
nextToken: str = ...,
maxResults: int = ...,
queryVersion: str = ...,
) -> SearchIndexResponseTypeDef: # (1)
...# search_index method usage example with argument unpacking
kwargs: SearchIndexRequestRequestTypeDef = { # (1)
"queryString": ...,
}
parent.search_index(**kwargs)set_default_authorizer#
Sets the default authorizer.
Type annotations and code completion for boto3.client("iot").set_default_authorizer method.
boto3 documentation
# set_default_authorizer method definition
def set_default_authorizer(
self,
*,
authorizerName: str,
) -> SetDefaultAuthorizerResponseTypeDef: # (1)
...# set_default_authorizer method usage example with argument unpacking
kwargs: SetDefaultAuthorizerRequestRequestTypeDef = { # (1)
"authorizerName": ...,
}
parent.set_default_authorizer(**kwargs)set_default_policy_version#
Sets the specified version of the specified policy as the policy's default (operative) version.
Type annotations and code completion for boto3.client("iot").set_default_policy_version method.
boto3 documentation
# set_default_policy_version method definition
def set_default_policy_version(
self,
*,
policyName: str,
policyVersionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# set_default_policy_version method usage example with argument unpacking
kwargs: SetDefaultPolicyVersionRequestRequestTypeDef = { # (1)
"policyName": ...,
"policyVersionId": ...,
}
parent.set_default_policy_version(**kwargs)set_logging_options#
Sets the logging options.
Type annotations and code completion for boto3.client("iot").set_logging_options method.
boto3 documentation
# set_logging_options method definition
def set_logging_options(
self,
*,
loggingOptionsPayload: LoggingOptionsPayloadTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# set_logging_options method usage example with argument unpacking
kwargs: SetLoggingOptionsRequestRequestTypeDef = { # (1)
"loggingOptionsPayload": ...,
}
parent.set_logging_options(**kwargs)set_v2_logging_level#
Sets the logging level.
Type annotations and code completion for boto3.client("iot").set_v2_logging_level method.
boto3 documentation
# set_v2_logging_level method definition
def set_v2_logging_level(
self,
*,
logTarget: LogTargetTypeDef, # (1)
logLevel: LogLevelType, # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...- See LogTargetTypeDef
- See LogLevelType
- See EmptyResponseMetadataTypeDef
# set_v2_logging_level method usage example with argument unpacking
kwargs: SetV2LoggingLevelRequestRequestTypeDef = { # (1)
"logTarget": ...,
"logLevel": ...,
}
parent.set_v2_logging_level(**kwargs)set_v2_logging_options#
Sets the logging options for the V2 logging service.
Type annotations and code completion for boto3.client("iot").set_v2_logging_options method.
boto3 documentation
# set_v2_logging_options method definition
def set_v2_logging_options(
self,
*,
roleArn: str = ...,
defaultLogLevel: LogLevelType = ..., # (1)
disableAllLogs: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...# set_v2_logging_options method usage example with argument unpacking
kwargs: SetV2LoggingOptionsRequestRequestTypeDef = { # (1)
"roleArn": ...,
}
parent.set_v2_logging_options(**kwargs)start_audit_mitigation_actions_task#
Starts a task that applies a set of mitigation actions to the specified target.
Type annotations and code completion for boto3.client("iot").start_audit_mitigation_actions_task method.
boto3 documentation
# start_audit_mitigation_actions_task method definition
def start_audit_mitigation_actions_task(
self,
*,
taskId: str,
target: AuditMitigationActionsTaskTargetTypeDef, # (1)
auditCheckToActionsMapping: Mapping[str, Sequence[str]],
clientRequestToken: str,
) -> StartAuditMitigationActionsTaskResponseTypeDef: # (2)
...# start_audit_mitigation_actions_task method usage example with argument unpacking
kwargs: StartAuditMitigationActionsTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
"target": ...,
"auditCheckToActionsMapping": ...,
"clientRequestToken": ...,
}
parent.start_audit_mitigation_actions_task(**kwargs)start_detect_mitigation_actions_task#
Starts a Device Defender ML Detect mitigation actions task.
Type annotations and code completion for boto3.client("iot").start_detect_mitigation_actions_task method.
boto3 documentation
# start_detect_mitigation_actions_task method definition
def start_detect_mitigation_actions_task(
self,
*,
taskId: str,
target: DetectMitigationActionsTaskTargetTypeDef, # (1)
actions: Sequence[str],
clientRequestToken: str,
violationEventOccurrenceRange: ViolationEventOccurrenceRangeTypeDef = ..., # (2)
includeOnlyActiveViolations: bool = ...,
includeSuppressedAlerts: bool = ...,
) -> StartDetectMitigationActionsTaskResponseTypeDef: # (3)
...- See DetectMitigationActionsTaskTargetTypeDef
- See ViolationEventOccurrenceRangeTypeDef
- See StartDetectMitigationActionsTaskResponseTypeDef
# start_detect_mitigation_actions_task method usage example with argument unpacking
kwargs: StartDetectMitigationActionsTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
"target": ...,
"actions": ...,
"clientRequestToken": ...,
}
parent.start_detect_mitigation_actions_task(**kwargs)start_on_demand_audit_task#
Starts an on-demand Device Defender audit.
Type annotations and code completion for boto3.client("iot").start_on_demand_audit_task method.
boto3 documentation
# start_on_demand_audit_task method definition
def start_on_demand_audit_task(
self,
*,
targetCheckNames: Sequence[str],
) -> StartOnDemandAuditTaskResponseTypeDef: # (1)
...# start_on_demand_audit_task method usage example with argument unpacking
kwargs: StartOnDemandAuditTaskRequestRequestTypeDef = { # (1)
"targetCheckNames": ...,
}
parent.start_on_demand_audit_task(**kwargs)start_thing_registration_task#
Creates a bulk thing provisioning task.
Type annotations and code completion for boto3.client("iot").start_thing_registration_task method.
boto3 documentation
# start_thing_registration_task method definition
def start_thing_registration_task(
self,
*,
templateBody: str,
inputFileBucket: str,
inputFileKey: str,
roleArn: str,
) -> StartThingRegistrationTaskResponseTypeDef: # (1)
...# start_thing_registration_task method usage example with argument unpacking
kwargs: StartThingRegistrationTaskRequestRequestTypeDef = { # (1)
"templateBody": ...,
"inputFileBucket": ...,
"inputFileKey": ...,
"roleArn": ...,
}
parent.start_thing_registration_task(**kwargs)stop_thing_registration_task#
Cancels a bulk thing provisioning task.
Type annotations and code completion for boto3.client("iot").stop_thing_registration_task method.
boto3 documentation
# stop_thing_registration_task method definition
def stop_thing_registration_task(
self,
*,
taskId: str,
) -> dict[str, Any]:
...# stop_thing_registration_task method usage example with argument unpacking
kwargs: StopThingRegistrationTaskRequestRequestTypeDef = { # (1)
"taskId": ...,
}
parent.stop_thing_registration_task(**kwargs)tag_resource#
Adds to or modifies the tags of the given resource.
Type annotations and code completion for boto3.client("iot").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> dict[str, Any]:
...- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)test_authorization#
Tests if a specified principal is authorized to perform an IoT action on a specified resource.
Type annotations and code completion for boto3.client("iot").test_authorization method.
boto3 documentation
# test_authorization method definition
def test_authorization(
self,
*,
authInfos: Sequence[AuthInfoUnionTypeDef], # (1)
principal: str = ...,
cognitoIdentityPoolId: str = ...,
clientId: str = ...,
policyNamesToAdd: Sequence[str] = ...,
policyNamesToSkip: Sequence[str] = ...,
) -> TestAuthorizationResponseTypeDef: # (2)
...# test_authorization method usage example with argument unpacking
kwargs: TestAuthorizationRequestRequestTypeDef = { # (1)
"authInfos": ...,
}
parent.test_authorization(**kwargs)test_invoke_authorizer#
Tests a custom authorization behavior by invoking a specified custom authorizer.
Type annotations and code completion for boto3.client("iot").test_invoke_authorizer method.
boto3 documentation
# test_invoke_authorizer method definition
def test_invoke_authorizer(
self,
*,
authorizerName: str,
token: str = ...,
tokenSignature: str = ...,
httpContext: HttpContextTypeDef = ..., # (1)
mqttContext: MqttContextTypeDef = ..., # (2)
tlsContext: TlsContextTypeDef = ..., # (3)
) -> TestInvokeAuthorizerResponseTypeDef: # (4)
...- See HttpContextTypeDef
- See MqttContextTypeDef
- See TlsContextTypeDef
- See TestInvokeAuthorizerResponseTypeDef
# test_invoke_authorizer method usage example with argument unpacking
kwargs: TestInvokeAuthorizerRequestRequestTypeDef = { # (1)
"authorizerName": ...,
}
parent.test_invoke_authorizer(**kwargs)transfer_certificate#
Transfers the specified certificate to the specified Amazon Web Services account.
Type annotations and code completion for boto3.client("iot").transfer_certificate method.
boto3 documentation
# transfer_certificate method definition
def transfer_certificate(
self,
*,
certificateId: str,
targetAwsAccount: str,
transferMessage: str = ...,
) -> TransferCertificateResponseTypeDef: # (1)
...# transfer_certificate method usage example with argument unpacking
kwargs: TransferCertificateRequestRequestTypeDef = { # (1)
"certificateId": ...,
"targetAwsAccount": ...,
}
parent.transfer_certificate(**kwargs)untag_resource#
Removes the given tags (metadata) from the resource.
Type annotations and code completion for boto3.client("iot").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)update_account_audit_configuration#
Configures or reconfigures the Device Defender audit settings for this account.
Type annotations and code completion for boto3.client("iot").update_account_audit_configuration method.
boto3 documentation
# update_account_audit_configuration method definition
def update_account_audit_configuration(
self,
*,
roleArn: str = ...,
auditNotificationTargetConfigurations: Mapping[AuditNotificationTypeType, AuditNotificationTargetTypeDef] = ..., # (1)
auditCheckConfigurations: Mapping[str, AuditCheckConfigurationTypeDef] = ..., # (2)
) -> dict[str, Any]:
...# update_account_audit_configuration method usage example with argument unpacking
kwargs: UpdateAccountAuditConfigurationRequestRequestTypeDef = { # (1)
"roleArn": ...,
}
parent.update_account_audit_configuration(**kwargs)update_audit_suppression#
Updates a Device Defender audit suppression.
Type annotations and code completion for boto3.client("iot").update_audit_suppression method.
boto3 documentation
# update_audit_suppression method definition
def update_audit_suppression(
self,
*,
checkName: str,
resourceIdentifier: ResourceIdentifierTypeDef, # (1)
expirationDate: TimestampTypeDef = ...,
suppressIndefinitely: bool = ...,
description: str = ...,
) -> dict[str, Any]:
...# update_audit_suppression method usage example with argument unpacking
kwargs: UpdateAuditSuppressionRequestRequestTypeDef = { # (1)
"checkName": ...,
"resourceIdentifier": ...,
}
parent.update_audit_suppression(**kwargs)update_authorizer#
Updates an authorizer.
Type annotations and code completion for boto3.client("iot").update_authorizer method.
boto3 documentation
# update_authorizer method definition
def update_authorizer(
self,
*,
authorizerName: str,
authorizerFunctionArn: str = ...,
tokenKeyName: str = ...,
tokenSigningPublicKeys: Mapping[str, str] = ...,
status: AuthorizerStatusType = ..., # (1)
enableCachingForHttp: bool = ...,
) -> UpdateAuthorizerResponseTypeDef: # (2)
...# update_authorizer method usage example with argument unpacking
kwargs: UpdateAuthorizerRequestRequestTypeDef = { # (1)
"authorizerName": ...,
}
parent.update_authorizer(**kwargs)update_billing_group#
Updates information about the billing group.
Type annotations and code completion for boto3.client("iot").update_billing_group method.
boto3 documentation
# update_billing_group method definition
def update_billing_group(
self,
*,
billingGroupName: str,
billingGroupProperties: BillingGroupPropertiesTypeDef, # (1)
expectedVersion: int = ...,
) -> UpdateBillingGroupResponseTypeDef: # (2)
...# update_billing_group method usage example with argument unpacking
kwargs: UpdateBillingGroupRequestRequestTypeDef = { # (1)
"billingGroupName": ...,
"billingGroupProperties": ...,
}
parent.update_billing_group(**kwargs)update_ca_certificate#
Updates a registered CA certificate.
Type annotations and code completion for boto3.client("iot").update_ca_certificate method.
boto3 documentation
# update_ca_certificate method definition
def update_ca_certificate(
self,
*,
certificateId: str,
newStatus: CACertificateStatusType = ..., # (1)
newAutoRegistrationStatus: AutoRegistrationStatusType = ..., # (2)
registrationConfig: RegistrationConfigTypeDef = ..., # (3)
removeAutoRegistration: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (4)
...- See CACertificateStatusType
- See AutoRegistrationStatusType
- See RegistrationConfigTypeDef
- See EmptyResponseMetadataTypeDef
# update_ca_certificate method usage example with argument unpacking
kwargs: UpdateCACertificateRequestRequestTypeDef = { # (1)
"certificateId": ...,
}
parent.update_ca_certificate(**kwargs)update_certificate#
Updates the status of the specified certificate.
Type annotations and code completion for boto3.client("iot").update_certificate method.
boto3 documentation
# update_certificate method definition
def update_certificate(
self,
*,
certificateId: str,
newStatus: CertificateStatusType, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# update_certificate method usage example with argument unpacking
kwargs: UpdateCertificateRequestRequestTypeDef = { # (1)
"certificateId": ...,
"newStatus": ...,
}
parent.update_certificate(**kwargs)update_certificate_provider#
Updates a certificate provider.
Type annotations and code completion for boto3.client("iot").update_certificate_provider method.
boto3 documentation
# update_certificate_provider method definition
def update_certificate_provider(
self,
*,
certificateProviderName: str,
lambdaFunctionArn: str = ...,
accountDefaultForOperations: Sequence[CertificateProviderOperationType] = ..., # (1)
) -> UpdateCertificateProviderResponseTypeDef: # (2)
...# update_certificate_provider method usage example with argument unpacking
kwargs: UpdateCertificateProviderRequestRequestTypeDef = { # (1)
"certificateProviderName": ...,
}
parent.update_certificate_provider(**kwargs)update_command#
Update information about a command or mark a command for deprecation.
Type annotations and code completion for boto3.client("iot").update_command method.
boto3 documentation
# update_command method definition
def update_command(
self,
*,
commandId: str,
displayName: str = ...,
description: str = ...,
deprecated: bool = ...,
) -> UpdateCommandResponseTypeDef: # (1)
...# update_command method usage example with argument unpacking
kwargs: UpdateCommandRequestRequestTypeDef = { # (1)
"commandId": ...,
}
parent.update_command(**kwargs)update_custom_metric#
Updates a Device Defender detect custom metric.
Type annotations and code completion for boto3.client("iot").update_custom_metric method.
boto3 documentation
# update_custom_metric method definition
def update_custom_metric(
self,
*,
metricName: str,
displayName: str,
) -> UpdateCustomMetricResponseTypeDef: # (1)
...# update_custom_metric method usage example with argument unpacking
kwargs: UpdateCustomMetricRequestRequestTypeDef = { # (1)
"metricName": ...,
"displayName": ...,
}
parent.update_custom_metric(**kwargs)update_dimension#
Updates the definition for a dimension.
Type annotations and code completion for boto3.client("iot").update_dimension method.
boto3 documentation
# update_dimension method definition
def update_dimension(
self,
*,
name: str,
stringValues: Sequence[str],
) -> UpdateDimensionResponseTypeDef: # (1)
...# update_dimension method usage example with argument unpacking
kwargs: UpdateDimensionRequestRequestTypeDef = { # (1)
"name": ...,
"stringValues": ...,
}
parent.update_dimension(**kwargs)update_domain_configuration#
Updates values stored in the domain configuration.
Type annotations and code completion for boto3.client("iot").update_domain_configuration method.
boto3 documentation
# update_domain_configuration method definition
def update_domain_configuration(
self,
*,
domainConfigurationName: str,
authorizerConfig: AuthorizerConfigTypeDef = ..., # (1)
domainConfigurationStatus: DomainConfigurationStatusType = ..., # (2)
removeAuthorizerConfig: bool = ...,
tlsConfig: TlsConfigTypeDef = ..., # (3)
serverCertificateConfig: ServerCertificateConfigTypeDef = ..., # (4)
authenticationType: AuthenticationTypeType = ..., # (5)
applicationProtocol: ApplicationProtocolType = ..., # (6)
clientCertificateConfig: ClientCertificateConfigTypeDef = ..., # (7)
) -> UpdateDomainConfigurationResponseTypeDef: # (8)
...- See AuthorizerConfigTypeDef
- See DomainConfigurationStatusType
- See TlsConfigTypeDef
- See ServerCertificateConfigTypeDef
- See AuthenticationTypeType
- See ApplicationProtocolType
- See ClientCertificateConfigTypeDef
- See UpdateDomainConfigurationResponseTypeDef
# update_domain_configuration method usage example with argument unpacking
kwargs: UpdateDomainConfigurationRequestRequestTypeDef = { # (1)
"domainConfigurationName": ...,
}
parent.update_domain_configuration(**kwargs)update_dynamic_thing_group#
Updates a dynamic thing group.
Type annotations and code completion for boto3.client("iot").update_dynamic_thing_group method.
boto3 documentation
# update_dynamic_thing_group method definition
def update_dynamic_thing_group(
self,
*,
thingGroupName: str,
thingGroupProperties: ThingGroupPropertiesTypeDef, # (1)
expectedVersion: int = ...,
indexName: str = ...,
queryString: str = ...,
queryVersion: str = ...,
) -> UpdateDynamicThingGroupResponseTypeDef: # (2)
...# update_dynamic_thing_group method usage example with argument unpacking
kwargs: UpdateDynamicThingGroupRequestRequestTypeDef = { # (1)
"thingGroupName": ...,
"thingGroupProperties": ...,
}
parent.update_dynamic_thing_group(**kwargs)update_event_configurations#
Updates the event configurations.
Type annotations and code completion for boto3.client("iot").update_event_configurations method.
boto3 documentation
# update_event_configurations method definition
def update_event_configurations(
self,
*,
eventConfigurations: Mapping[EventTypeType, ConfigurationTypeDef] = ..., # (1)
) -> dict[str, Any]:
...# update_event_configurations method usage example with argument unpacking
kwargs: UpdateEventConfigurationsRequestRequestTypeDef = { # (1)
"eventConfigurations": ...,
}
parent.update_event_configurations(**kwargs)update_fleet_metric#
Updates the data for a fleet metric.
Type annotations and code completion for boto3.client("iot").update_fleet_metric method.
boto3 documentation
# update_fleet_metric method definition
def update_fleet_metric(
self,
*,
metricName: str,
indexName: str,
queryString: str = ...,
aggregationType: AggregationTypeTypeDef = ..., # (1)
period: int = ...,
aggregationField: str = ...,
description: str = ...,
queryVersion: str = ...,
unit: FleetMetricUnitType = ..., # (2)
expectedVersion: int = ...,
) -> EmptyResponseMetadataTypeDef: # (3)
...# update_fleet_metric method usage example with argument unpacking
kwargs: UpdateFleetMetricRequestRequestTypeDef = { # (1)
"metricName": ...,
"indexName": ...,
}
parent.update_fleet_metric(**kwargs)update_indexing_configuration#
Updates the search configuration.
Type annotations and code completion for boto3.client("iot").update_indexing_configuration method.
boto3 documentation
# update_indexing_configuration method definition
def update_indexing_configuration(
self,
*,
thingIndexingConfiguration: ThingIndexingConfigurationTypeDef = ..., # (1)
thingGroupIndexingConfiguration: ThingGroupIndexingConfigurationTypeDef = ..., # (2)
) -> dict[str, Any]:
...# update_indexing_configuration method usage example with argument unpacking
kwargs: UpdateIndexingConfigurationRequestRequestTypeDef = { # (1)
"thingIndexingConfiguration": ...,
}
parent.update_indexing_configuration(**kwargs)update_job#
Updates supported fields of the specified job.
Type annotations and code completion for boto3.client("iot").update_job method.
boto3 documentation
# update_job method definition
def update_job(
self,
*,
jobId: str,
description: str = ...,
presignedUrlConfig: PresignedUrlConfigTypeDef = ..., # (1)
jobExecutionsRolloutConfig: JobExecutionsRolloutConfigTypeDef = ..., # (2)
abortConfig: AbortConfigTypeDef = ..., # (3)
timeoutConfig: TimeoutConfigTypeDef = ..., # (4)
namespaceId: str = ...,
jobExecutionsRetryConfig: JobExecutionsRetryConfigTypeDef = ..., # (5)
) -> EmptyResponseMetadataTypeDef: # (6)
...- See PresignedUrlConfigTypeDef
- See JobExecutionsRolloutConfigTypeDef
- See AbortConfigTypeDef
- See TimeoutConfigTypeDef
- See JobExecutionsRetryConfigTypeDef
- See EmptyResponseMetadataTypeDef
# update_job method usage example with argument unpacking
kwargs: UpdateJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.update_job(**kwargs)update_mitigation_action#
Updates the definition for the specified mitigation action.
Type annotations and code completion for boto3.client("iot").update_mitigation_action method.
boto3 documentation
# update_mitigation_action method definition
def update_mitigation_action(
self,
*,
actionName: str,
roleArn: str = ...,
actionParams: MitigationActionParamsTypeDef = ..., # (1)
) -> UpdateMitigationActionResponseTypeDef: # (2)
...# update_mitigation_action method usage example with argument unpacking
kwargs: UpdateMitigationActionRequestRequestTypeDef = { # (1)
"actionName": ...,
}
parent.update_mitigation_action(**kwargs)update_package#
Updates the supported fields for a specific software package.
Type annotations and code completion for boto3.client("iot").update_package method.
boto3 documentation
# update_package method definition
def update_package(
self,
*,
packageName: str,
description: str = ...,
defaultVersionName: str = ...,
unsetDefaultVersion: bool = ...,
clientToken: str = ...,
) -> dict[str, Any]:
...# update_package method usage example with argument unpacking
kwargs: UpdatePackageRequestRequestTypeDef = { # (1)
"packageName": ...,
}
parent.update_package(**kwargs)update_package_configuration#
Updates the software package configuration.
Type annotations and code completion for boto3.client("iot").update_package_configuration method.
boto3 documentation
# update_package_configuration method definition
def update_package_configuration(
self,
*,
versionUpdateByJobsConfig: VersionUpdateByJobsConfigTypeDef = ..., # (1)
clientToken: str = ...,
) -> dict[str, Any]:
...# update_package_configuration method usage example with argument unpacking
kwargs: UpdatePackageConfigurationRequestRequestTypeDef = { # (1)
"versionUpdateByJobsConfig": ...,
}
parent.update_package_configuration(**kwargs)update_package_version#
Updates the supported fields for a specific package version.
Type annotations and code completion for boto3.client("iot").update_package_version method.
boto3 documentation
# update_package_version method definition
def update_package_version(
self,
*,
packageName: str,
versionName: str,
description: str = ...,
attributes: Mapping[str, str] = ...,
artifact: PackageVersionArtifactTypeDef = ..., # (1)
action: PackageVersionActionType = ..., # (2)
recipe: str = ...,
clientToken: str = ...,
) -> dict[str, Any]:
...# update_package_version method usage example with argument unpacking
kwargs: UpdatePackageVersionRequestRequestTypeDef = { # (1)
"packageName": ...,
"versionName": ...,
}
parent.update_package_version(**kwargs)update_provisioning_template#
Updates a provisioning template.
Type annotations and code completion for boto3.client("iot").update_provisioning_template method.
boto3 documentation
# update_provisioning_template method definition
def update_provisioning_template(
self,
*,
templateName: str,
description: str = ...,
enabled: bool = ...,
defaultVersionId: int = ...,
provisioningRoleArn: str = ...,
preProvisioningHook: ProvisioningHookTypeDef = ..., # (1)
removePreProvisioningHook: bool = ...,
) -> dict[str, Any]:
...# update_provisioning_template method usage example with argument unpacking
kwargs: UpdateProvisioningTemplateRequestRequestTypeDef = { # (1)
"templateName": ...,
}
parent.update_provisioning_template(**kwargs)update_role_alias#
Updates a role alias.
Type annotations and code completion for boto3.client("iot").update_role_alias method.
boto3 documentation
# update_role_alias method definition
def update_role_alias(
self,
*,
roleAlias: str,
roleArn: str = ...,
credentialDurationSeconds: int = ...,
) -> UpdateRoleAliasResponseTypeDef: # (1)
...# update_role_alias method usage example with argument unpacking
kwargs: UpdateRoleAliasRequestRequestTypeDef = { # (1)
"roleAlias": ...,
}
parent.update_role_alias(**kwargs)update_scheduled_audit#
Updates a scheduled audit, including which checks are performed and how often the audit takes place.
Type annotations and code completion for boto3.client("iot").update_scheduled_audit method.
boto3 documentation
# update_scheduled_audit method definition
def update_scheduled_audit(
self,
*,
scheduledAuditName: str,
frequency: AuditFrequencyType = ..., # (1)
dayOfMonth: str = ...,
dayOfWeek: DayOfWeekType = ..., # (2)
targetCheckNames: Sequence[str] = ...,
) -> UpdateScheduledAuditResponseTypeDef: # (3)
...# update_scheduled_audit method usage example with argument unpacking
kwargs: UpdateScheduledAuditRequestRequestTypeDef = { # (1)
"scheduledAuditName": ...,
}
parent.update_scheduled_audit(**kwargs)update_security_profile#
Updates a Device Defender security profile.
Type annotations and code completion for boto3.client("iot").update_security_profile method.
boto3 documentation
# update_security_profile method definition
def update_security_profile(
self,
*,
securityProfileName: str,
securityProfileDescription: str = ...,
behaviors: Sequence[BehaviorTypeDef] = ..., # (1)
alertTargets: Mapping[AlertTargetTypeType, AlertTargetTypeDef] = ..., # (2)
additionalMetricsToRetain: Sequence[str] = ...,
additionalMetricsToRetainV2: Sequence[MetricToRetainTypeDef] = ..., # (3)
deleteBehaviors: bool = ...,
deleteAlertTargets: bool = ...,
deleteAdditionalMetricsToRetain: bool = ...,
expectedVersion: int = ...,
metricsExportConfig: MetricsExportConfigTypeDef = ..., # (4)
deleteMetricsExportConfig: bool = ...,
) -> UpdateSecurityProfileResponseTypeDef: # (5)
...- See BehaviorTypeDef
- See AlertTargetTypeType AlertTargetTypeDef
- See MetricToRetainTypeDef
- See MetricsExportConfigTypeDef
- See UpdateSecurityProfileResponseTypeDef
# update_security_profile method usage example with argument unpacking
kwargs: UpdateSecurityProfileRequestRequestTypeDef = { # (1)
"securityProfileName": ...,
}
parent.update_security_profile(**kwargs)update_stream#
Updates an existing stream.
Type annotations and code completion for boto3.client("iot").update_stream method.
boto3 documentation
# update_stream method definition
def update_stream(
self,
*,
streamId: str,
description: str = ...,
files: Sequence[StreamFileTypeDef] = ..., # (1)
roleArn: str = ...,
) -> UpdateStreamResponseTypeDef: # (2)
...# update_stream method usage example with argument unpacking
kwargs: UpdateStreamRequestRequestTypeDef = { # (1)
"streamId": ...,
}
parent.update_stream(**kwargs)update_thing#
Updates the data for a thing.
Type annotations and code completion for boto3.client("iot").update_thing method.
boto3 documentation
# update_thing method definition
def update_thing(
self,
*,
thingName: str,
thingTypeName: str = ...,
attributePayload: AttributePayloadTypeDef = ..., # (1)
expectedVersion: int = ...,
removeThingType: bool = ...,
) -> dict[str, Any]:
...# update_thing method usage example with argument unpacking
kwargs: UpdateThingRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.update_thing(**kwargs)update_thing_group#
Update a thing group.
Type annotations and code completion for boto3.client("iot").update_thing_group method.
boto3 documentation
# update_thing_group method definition
def update_thing_group(
self,
*,
thingGroupName: str,
thingGroupProperties: ThingGroupPropertiesTypeDef, # (1)
expectedVersion: int = ...,
) -> UpdateThingGroupResponseTypeDef: # (2)
...# update_thing_group method usage example with argument unpacking
kwargs: UpdateThingGroupRequestRequestTypeDef = { # (1)
"thingGroupName": ...,
"thingGroupProperties": ...,
}
parent.update_thing_group(**kwargs)update_thing_groups_for_thing#
Updates the groups to which the thing belongs.
Type annotations and code completion for boto3.client("iot").update_thing_groups_for_thing method.
boto3 documentation
# update_thing_groups_for_thing method definition
def update_thing_groups_for_thing(
self,
*,
thingName: str = ...,
thingGroupsToAdd: Sequence[str] = ...,
thingGroupsToRemove: Sequence[str] = ...,
overrideDynamicGroups: bool = ...,
) -> dict[str, Any]:
...# update_thing_groups_for_thing method usage example with argument unpacking
kwargs: UpdateThingGroupsForThingRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.update_thing_groups_for_thing(**kwargs)update_thing_type#
Updates a thing type.
Type annotations and code completion for boto3.client("iot").update_thing_type method.
boto3 documentation
# update_thing_type method definition
def update_thing_type(
self,
*,
thingTypeName: str,
thingTypeProperties: ThingTypePropertiesTypeDef = ..., # (1)
) -> dict[str, Any]:
...# update_thing_type method usage example with argument unpacking
kwargs: UpdateThingTypeRequestRequestTypeDef = { # (1)
"thingTypeName": ...,
}
parent.update_thing_type(**kwargs)update_topic_rule_destination#
Updates a topic rule destination.
Type annotations and code completion for boto3.client("iot").update_topic_rule_destination method.
boto3 documentation
# update_topic_rule_destination method definition
def update_topic_rule_destination(
self,
*,
arn: str,
status: TopicRuleDestinationStatusType, # (1)
) -> dict[str, Any]:
...# update_topic_rule_destination method usage example with argument unpacking
kwargs: UpdateTopicRuleDestinationRequestRequestTypeDef = { # (1)
"arn": ...,
"status": ...,
}
parent.update_topic_rule_destination(**kwargs)validate_security_profile_behaviors#
Validates a Device Defender security profile behaviors specification.
Type annotations and code completion for boto3.client("iot").validate_security_profile_behaviors method.
boto3 documentation
# validate_security_profile_behaviors method definition
def validate_security_profile_behaviors(
self,
*,
behaviors: Sequence[BehaviorTypeDef], # (1)
) -> ValidateSecurityProfileBehaviorsResponseTypeDef: # (2)
...# validate_security_profile_behaviors method usage example with argument unpacking
kwargs: ValidateSecurityProfileBehaviorsRequestRequestTypeDef = { # (1)
"behaviors": ...,
}
parent.validate_security_profile_behaviors(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("iot").get_paginator method with overloads.
client.get_paginator("get_behavior_model_training_summaries")-> GetBehaviorModelTrainingSummariesPaginatorclient.get_paginator("list_active_violations")-> ListActiveViolationsPaginatorclient.get_paginator("list_attached_policies")-> ListAttachedPoliciesPaginatorclient.get_paginator("list_audit_findings")-> ListAuditFindingsPaginatorclient.get_paginator("list_audit_mitigation_actions_executions")-> ListAuditMitigationActionsExecutionsPaginatorclient.get_paginator("list_audit_mitigation_actions_tasks")-> ListAuditMitigationActionsTasksPaginatorclient.get_paginator("list_audit_suppressions")-> ListAuditSuppressionsPaginatorclient.get_paginator("list_audit_tasks")-> ListAuditTasksPaginatorclient.get_paginator("list_authorizers")-> ListAuthorizersPaginatorclient.get_paginator("list_billing_groups")-> ListBillingGroupsPaginatorclient.get_paginator("list_ca_certificates")-> ListCACertificatesPaginatorclient.get_paginator("list_certificates_by_ca")-> ListCertificatesByCAPaginatorclient.get_paginator("list_certificates")-> ListCertificatesPaginatorclient.get_paginator("list_command_executions")-> ListCommandExecutionsPaginatorclient.get_paginator("list_commands")-> ListCommandsPaginatorclient.get_paginator("list_custom_metrics")-> ListCustomMetricsPaginatorclient.get_paginator("list_detect_mitigation_actions_executions")-> ListDetectMitigationActionsExecutionsPaginatorclient.get_paginator("list_detect_mitigation_actions_tasks")-> ListDetectMitigationActionsTasksPaginatorclient.get_paginator("list_dimensions")-> ListDimensionsPaginatorclient.get_paginator("list_domain_configurations")-> ListDomainConfigurationsPaginatorclient.get_paginator("list_fleet_metrics")-> ListFleetMetricsPaginatorclient.get_paginator("list_indices")-> ListIndicesPaginatorclient.get_paginator("list_job_executions_for_job")-> ListJobExecutionsForJobPaginatorclient.get_paginator("list_job_executions_for_thing")-> ListJobExecutionsForThingPaginatorclient.get_paginator("list_job_templates")-> ListJobTemplatesPaginatorclient.get_paginator("list_jobs")-> ListJobsPaginatorclient.get_paginator("list_managed_job_templates")-> ListManagedJobTemplatesPaginatorclient.get_paginator("list_metric_values")-> ListMetricValuesPaginatorclient.get_paginator("list_mitigation_actions")-> ListMitigationActionsPaginatorclient.get_paginator("list_ota_updates")-> ListOTAUpdatesPaginatorclient.get_paginator("list_outgoing_certificates")-> ListOutgoingCertificatesPaginatorclient.get_paginator("list_package_versions")-> ListPackageVersionsPaginatorclient.get_paginator("list_packages")-> ListPackagesPaginatorclient.get_paginator("list_policies")-> ListPoliciesPaginatorclient.get_paginator("list_policy_principals")-> ListPolicyPrincipalsPaginatorclient.get_paginator("list_principal_policies")-> ListPrincipalPoliciesPaginatorclient.get_paginator("list_principal_things")-> ListPrincipalThingsPaginatorclient.get_paginator("list_principal_things_v2")-> ListPrincipalThingsV2Paginatorclient.get_paginator("list_provisioning_template_versions")-> ListProvisioningTemplateVersionsPaginatorclient.get_paginator("list_provisioning_templates")-> ListProvisioningTemplatesPaginatorclient.get_paginator("list_related_resources_for_audit_finding")-> ListRelatedResourcesForAuditFindingPaginatorclient.get_paginator("list_role_aliases")-> ListRoleAliasesPaginatorclient.get_paginator("list_sbom_validation_results")-> ListSbomValidationResultsPaginatorclient.get_paginator("list_scheduled_audits")-> ListScheduledAuditsPaginatorclient.get_paginator("list_security_profiles_for_target")-> ListSecurityProfilesForTargetPaginatorclient.get_paginator("list_security_profiles")-> ListSecurityProfilesPaginatorclient.get_paginator("list_streams")-> ListStreamsPaginatorclient.get_paginator("list_tags_for_resource")-> ListTagsForResourcePaginatorclient.get_paginator("list_targets_for_policy")-> ListTargetsForPolicyPaginatorclient.get_paginator("list_targets_for_security_profile")-> ListTargetsForSecurityProfilePaginatorclient.get_paginator("list_thing_groups_for_thing")-> ListThingGroupsForThingPaginatorclient.get_paginator("list_thing_groups")-> ListThingGroupsPaginatorclient.get_paginator("list_thing_principals")-> ListThingPrincipalsPaginatorclient.get_paginator("list_thing_principals_v2")-> ListThingPrincipalsV2Paginatorclient.get_paginator("list_thing_registration_task_reports")-> ListThingRegistrationTaskReportsPaginatorclient.get_paginator("list_thing_registration_tasks")-> ListThingRegistrationTasksPaginatorclient.get_paginator("list_thing_types")-> ListThingTypesPaginatorclient.get_paginator("list_things_in_billing_group")-> ListThingsInBillingGroupPaginatorclient.get_paginator("list_things_in_thing_group")-> ListThingsInThingGroupPaginatorclient.get_paginator("list_things")-> ListThingsPaginatorclient.get_paginator("list_topic_rule_destinations")-> ListTopicRuleDestinationsPaginatorclient.get_paginator("list_topic_rules")-> ListTopicRulesPaginatorclient.get_paginator("list_v2_logging_levels")-> ListV2LoggingLevelsPaginatorclient.get_paginator("list_violation_events")-> ListViolationEventsPaginator