IoTClient

Index > IoT > IoTClient

Auto-generated documentation for IoT type annotations stubs module mypy-boto3-iot.

IoTClient

Type annotations and code completion for boto3.client("iot"). boto3 documentation

# IoTClient usage example

from boto3.session import Session
from mypy_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 mypy_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)
    ...

1. See EmptyResponseMetadataTypeDef

# accept_certificate_transfer method usage example with argument unpacking

kwargs: AcceptCertificateTransferRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.accept_certificate_transfer(**kwargs)

1. See AcceptCertificateTransferRequestTypeDef

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: AddThingToBillingGroupRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.add_thing_to_billing_group(**kwargs)

1. See AddThingToBillingGroupRequestTypeDef

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: AddThingToThingGroupRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.add_thing_to_thing_group(**kwargs)

1. See AddThingToThingGroupRequestTypeDef

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

1. See SbomTypeDef
2. See AssociateSbomWithPackageVersionResponseTypeDef

# associate_sbom_with_package_version method usage example with argument unpacking

kwargs: AssociateSbomWithPackageVersionRequestTypeDef = {  # (1)
    "packageName": ...,
    "versionName": ...,
    "sbom": ...,
}

parent.associate_sbom_with_package_version(**kwargs)

1. See AssociateSbomWithPackageVersionRequestTypeDef

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

1. See AssociateTargetsWithJobResponseTypeDef

# associate_targets_with_job method usage example with argument unpacking

kwargs: AssociateTargetsWithJobRequestTypeDef = {  # (1)
    "targets": ...,
    "jobId": ...,
}

parent.associate_targets_with_job(**kwargs)

1. See AssociateTargetsWithJobRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# attach_policy method usage example with argument unpacking

kwargs: AttachPolicyRequestTypeDef = {  # (1)
    "policyName": ...,
    "target": ...,
}

parent.attach_policy(**kwargs)

1. See AttachPolicyRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# attach_principal_policy method usage example with argument unpacking

kwargs: AttachPrincipalPolicyRequestTypeDef = {  # (1)
    "policyName": ...,
    "principal": ...,
}

parent.attach_principal_policy(**kwargs)

1. See AttachPrincipalPolicyRequestTypeDef

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: AttachSecurityProfileRequestTypeDef = {  # (1)
    "securityProfileName": ...,
    "securityProfileTargetArn": ...,
}

parent.attach_security_profile(**kwargs)

1. See AttachSecurityProfileRequestTypeDef

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]:
    ...

1. See ThingPrincipalTypeType

# attach_thing_principal method usage example with argument unpacking

kwargs: AttachThingPrincipalRequestTypeDef = {  # (1)
    "thingName": ...,
    "principal": ...,
}

parent.attach_thing_principal(**kwargs)

1. See AttachThingPrincipalRequestTypeDef

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: CancelAuditMitigationActionsTaskRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.cancel_audit_mitigation_actions_task(**kwargs)

1. See CancelAuditMitigationActionsTaskRequestTypeDef

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: CancelAuditTaskRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.cancel_audit_task(**kwargs)

1. See CancelAuditTaskRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# cancel_certificate_transfer method usage example with argument unpacking

kwargs: CancelCertificateTransferRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.cancel_certificate_transfer(**kwargs)

1. See CancelCertificateTransferRequestTypeDef

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: CancelDetectMitigationActionsTaskRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.cancel_detect_mitigation_actions_task(**kwargs)

1. See CancelDetectMitigationActionsTaskRequestTypeDef

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

1. See CancelJobResponseTypeDef

# cancel_job method usage example with argument unpacking

kwargs: CancelJobRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.cancel_job(**kwargs)

1. See CancelJobRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# cancel_job_execution method usage example with argument unpacking

kwargs: CancelJobExecutionRequestTypeDef = {  # (1)
    "jobId": ...,
    "thingName": ...,
}

parent.cancel_job_execution(**kwargs)

1. See CancelJobExecutionRequestTypeDef

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: ConfirmTopicRuleDestinationRequestTypeDef = {  # (1)
    "confirmationToken": ...,
}

parent.confirm_topic_rule_destination(**kwargs)

1. See ConfirmTopicRuleDestinationRequestTypeDef

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]:
    ...

1. See ResourceIdentifierTypeDef

# create_audit_suppression method usage example with argument unpacking

kwargs: CreateAuditSuppressionRequestTypeDef = {  # (1)
    "checkName": ...,
    "resourceIdentifier": ...,
    "clientRequestToken": ...,
}

parent.create_audit_suppression(**kwargs)

1. See CreateAuditSuppressionRequestTypeDef

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

1. See AuthorizerStatusType
2. See Sequence[TagTypeDef]
3. See CreateAuthorizerResponseTypeDef

# create_authorizer method usage example with argument unpacking

kwargs: CreateAuthorizerRequestTypeDef = {  # (1)
    "authorizerName": ...,
    "authorizerFunctionArn": ...,
}

parent.create_authorizer(**kwargs)

1. See CreateAuthorizerRequestTypeDef

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

1. See BillingGroupPropertiesTypeDef
2. See Sequence[TagTypeDef]
3. See CreateBillingGroupResponseTypeDef

# create_billing_group method usage example with argument unpacking

kwargs: CreateBillingGroupRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.create_billing_group(**kwargs)

1. See CreateBillingGroupRequestTypeDef

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

1. See CreateCertificateFromCsrResponseTypeDef

# create_certificate_from_csr method usage example with argument unpacking

kwargs: CreateCertificateFromCsrRequestTypeDef = {  # (1)
    "certificateSigningRequest": ...,
}

parent.create_certificate_from_csr(**kwargs)

1. See CreateCertificateFromCsrRequestTypeDef

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

1. See Sequence[Literal['CreateCertificateFromCsr']]
2. See Sequence[TagTypeDef]
3. See CreateCertificateProviderResponseTypeDef

# create_certificate_provider method usage example with argument unpacking

kwargs: CreateCertificateProviderRequestTypeDef = {  # (1)
    "certificateProviderName": ...,
    "lambdaFunctionArn": ...,
    "accountDefaultForOperations": ...,
}

parent.create_certificate_provider(**kwargs)

1. See CreateCertificateProviderRequestTypeDef

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: CommandPayloadUnionTypeDef = ...,  # (2)
    mandatoryParameters: Sequence[CommandParameterUnionTypeDef] = ...,  # (3)
    roleArn: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateCommandResponseTypeDef:  # (5)
    ...

1. See CommandNamespaceType
2. See CommandPayloadUnionTypeDef
3. See Sequence[CommandParameterUnionTypeDef]
4. See Sequence[TagTypeDef]
5. See CreateCommandResponseTypeDef

# create_command method usage example with argument unpacking

kwargs: CreateCommandRequestTypeDef = {  # (1)
    "commandId": ...,
}

parent.create_command(**kwargs)

1. See CreateCommandRequestTypeDef

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

1. See CustomMetricTypeType
2. See Sequence[TagTypeDef]
3. See CreateCustomMetricResponseTypeDef

# create_custom_metric method usage example with argument unpacking

kwargs: CreateCustomMetricRequestTypeDef = {  # (1)
    "metricName": ...,
    "metricType": ...,
    "clientRequestToken": ...,
}

parent.create_custom_metric(**kwargs)

1. See CreateCustomMetricRequestTypeDef

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

1. See DimensionTypeType
2. See Sequence[TagTypeDef]
3. See CreateDimensionResponseTypeDef

# create_dimension method usage example with argument unpacking

kwargs: CreateDimensionRequestTypeDef = {  # (1)
    "name": ...,
    "type": ...,
    "stringValues": ...,
    "clientRequestToken": ...,
}

parent.create_dimension(**kwargs)

1. See CreateDimensionRequestTypeDef

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

1. See AuthorizerConfigTypeDef
2. See ServiceTypeType
3. See Sequence[TagTypeDef]
4. See TlsConfigTypeDef
5. See ServerCertificateConfigTypeDef
6. See AuthenticationTypeType
7. See ApplicationProtocolType
8. See ClientCertificateConfigTypeDef
9. See CreateDomainConfigurationResponseTypeDef

# create_domain_configuration method usage example with argument unpacking

kwargs: CreateDomainConfigurationRequestTypeDef = {  # (1)
    "domainConfigurationName": ...,
}

parent.create_domain_configuration(**kwargs)

1. See CreateDomainConfigurationRequestTypeDef

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: ThingGroupPropertiesUnionTypeDef = ...,  # (1)
    indexName: str = ...,
    queryVersion: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateDynamicThingGroupResponseTypeDef:  # (3)
    ...

1. See ThingGroupPropertiesUnionTypeDef
2. See Sequence[TagTypeDef]
3. See CreateDynamicThingGroupResponseTypeDef

# create_dynamic_thing_group method usage example with argument unpacking

kwargs: CreateDynamicThingGroupRequestTypeDef = {  # (1)
    "thingGroupName": ...,
    "queryString": ...,
}

parent.create_dynamic_thing_group(**kwargs)

1. See CreateDynamicThingGroupRequestTypeDef

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: AggregationTypeUnionTypeDef,  # (1)
    period: int,
    aggregationField: str,
    description: str = ...,
    queryVersion: str = ...,
    indexName: str = ...,
    unit: FleetMetricUnitType = ...,  # (2)
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateFleetMetricResponseTypeDef:  # (4)
    ...

1. See AggregationTypeUnionTypeDef
2. See FleetMetricUnitType
3. See Sequence[TagTypeDef]
4. See CreateFleetMetricResponseTypeDef

# create_fleet_metric method usage example with argument unpacking

kwargs: CreateFleetMetricRequestTypeDef = {  # (1)
    "metricName": ...,
    "queryString": ...,
    "aggregationType": ...,
    "period": ...,
    "aggregationField": ...,
}

parent.create_fleet_metric(**kwargs)

1. See CreateFleetMetricRequestTypeDef

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: AbortConfigUnionTypeDef = ...,  # (4)
    timeoutConfig: TimeoutConfigTypeDef = ...,  # (5)
    tags: Sequence[TagTypeDef] = ...,  # (6)
    namespaceId: str = ...,
    jobTemplateArn: str = ...,
    jobExecutionsRetryConfig: JobExecutionsRetryConfigUnionTypeDef = ...,  # (7)
    documentParameters: Mapping[str, str] = ...,
    schedulingConfig: SchedulingConfigUnionTypeDef = ...,  # (8)
    destinationPackageVersions: Sequence[str] = ...,
) -> CreateJobResponseTypeDef:  # (9)
    ...

1. See PresignedUrlConfigTypeDef
2. See TargetSelectionType
3. See JobExecutionsRolloutConfigTypeDef
4. See AbortConfigUnionTypeDef
5. See TimeoutConfigTypeDef
6. See Sequence[TagTypeDef]
7. See JobExecutionsRetryConfigUnionTypeDef
8. See SchedulingConfigUnionTypeDef
9. See CreateJobResponseTypeDef

# create_job method usage example with argument unpacking

kwargs: CreateJobRequestTypeDef = {  # (1)
    "jobId": ...,
    "targets": ...,
}

parent.create_job(**kwargs)

1. See CreateJobRequestTypeDef

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: AbortConfigUnionTypeDef = ...,  # (3)
    timeoutConfig: TimeoutConfigTypeDef = ...,  # (4)
    tags: Sequence[TagTypeDef] = ...,  # (5)
    jobExecutionsRetryConfig: JobExecutionsRetryConfigUnionTypeDef = ...,  # (6)
    maintenanceWindows: Sequence[MaintenanceWindowTypeDef] = ...,  # (7)
    destinationPackageVersions: Sequence[str] = ...,
) -> CreateJobTemplateResponseTypeDef:  # (8)
    ...

1. See PresignedUrlConfigTypeDef
2. See JobExecutionsRolloutConfigTypeDef
3. See AbortConfigUnionTypeDef
4. See TimeoutConfigTypeDef
5. See Sequence[TagTypeDef]
6. See JobExecutionsRetryConfigUnionTypeDef
7. See Sequence[MaintenanceWindowTypeDef]
8. See CreateJobTemplateResponseTypeDef

# create_job_template method usage example with argument unpacking

kwargs: CreateJobTemplateRequestTypeDef = {  # (1)
    "jobTemplateId": ...,
    "description": ...,
}

parent.create_job_template(**kwargs)

1. See CreateJobTemplateRequestTypeDef

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

1. See CreateKeysAndCertificateResponseTypeDef

# create_keys_and_certificate method usage example with argument unpacking

kwargs: CreateKeysAndCertificateRequestTypeDef = {  # (1)
    "setAsActive": ...,
}

parent.create_keys_and_certificate(**kwargs)

1. See CreateKeysAndCertificateRequestTypeDef

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: MitigationActionParamsUnionTypeDef,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateMitigationActionResponseTypeDef:  # (3)
    ...

1. See MitigationActionParamsUnionTypeDef
2. See Sequence[TagTypeDef]
3. See CreateMitigationActionResponseTypeDef

# create_mitigation_action method usage example with argument unpacking

kwargs: CreateMitigationActionRequestTypeDef = {  # (1)
    "actionName": ...,
    "roleArn": ...,
    "actionParams": ...,
}

parent.create_mitigation_action(**kwargs)

1. See CreateMitigationActionRequestTypeDef

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

1. See Sequence[OTAUpdateFileUnionTypeDef]
2. See Sequence[ProtocolType]
3. See TargetSelectionType
4. See AwsJobExecutionsRolloutConfigTypeDef
5. See AwsJobPresignedUrlConfigTypeDef
6. See AwsJobAbortConfigTypeDef
7. See AwsJobTimeoutConfigTypeDef
8. See Sequence[TagTypeDef]
9. See CreateOTAUpdateResponseTypeDef

# create_ota_update method usage example with argument unpacking

kwargs: CreateOTAUpdateRequestTypeDef = {  # (1)
    "otaUpdateId": ...,
    "targets": ...,
    "files": ...,
    "roleArn": ...,
}

parent.create_ota_update(**kwargs)

1. See CreateOTAUpdateRequestTypeDef

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

1. See CreatePackageResponseTypeDef

# create_package method usage example with argument unpacking

kwargs: CreatePackageRequestTypeDef = {  # (1)
    "packageName": ...,
}

parent.create_package(**kwargs)

1. See CreatePackageRequestTypeDef

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

1. See PackageVersionArtifactTypeDef
2. See CreatePackageVersionResponseTypeDef

# create_package_version method usage example with argument unpacking

kwargs: CreatePackageVersionRequestTypeDef = {  # (1)
    "packageName": ...,
    "versionName": ...,
}

parent.create_package_version(**kwargs)

1. See CreatePackageVersionRequestTypeDef

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

1. See Sequence[TagTypeDef]
2. See CreatePolicyResponseTypeDef

# create_policy method usage example with argument unpacking

kwargs: CreatePolicyRequestTypeDef = {  # (1)
    "policyName": ...,
    "policyDocument": ...,
}

parent.create_policy(**kwargs)

1. See CreatePolicyRequestTypeDef

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

1. See CreatePolicyVersionResponseTypeDef

# create_policy_version method usage example with argument unpacking

kwargs: CreatePolicyVersionRequestTypeDef = {  # (1)
    "policyName": ...,
    "policyDocument": ...,
}

parent.create_policy_version(**kwargs)

1. See CreatePolicyVersionRequestTypeDef

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

1. See CreateProvisioningClaimResponseTypeDef

# create_provisioning_claim method usage example with argument unpacking

kwargs: CreateProvisioningClaimRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.create_provisioning_claim(**kwargs)

1. See CreateProvisioningClaimRequestTypeDef

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

1. See ProvisioningHookTypeDef
2. See Sequence[TagTypeDef]
3. See TemplateTypeType
4. See CreateProvisioningTemplateResponseTypeDef

# create_provisioning_template method usage example with argument unpacking

kwargs: CreateProvisioningTemplateRequestTypeDef = {  # (1)
    "templateName": ...,
    "templateBody": ...,
    "provisioningRoleArn": ...,
}

parent.create_provisioning_template(**kwargs)

1. See CreateProvisioningTemplateRequestTypeDef

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

1. See CreateProvisioningTemplateVersionResponseTypeDef

# create_provisioning_template_version method usage example with argument unpacking

kwargs: CreateProvisioningTemplateVersionRequestTypeDef = {  # (1)
    "templateName": ...,
    "templateBody": ...,
}

parent.create_provisioning_template_version(**kwargs)

1. See CreateProvisioningTemplateVersionRequestTypeDef

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

1. See Sequence[TagTypeDef]
2. See CreateRoleAliasResponseTypeDef

# create_role_alias method usage example with argument unpacking

kwargs: CreateRoleAliasRequestTypeDef = {  # (1)
    "roleAlias": ...,
    "roleArn": ...,
}

parent.create_role_alias(**kwargs)

1. See CreateRoleAliasRequestTypeDef

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

1. See AuditFrequencyType
2. See DayOfWeekType
3. See Sequence[TagTypeDef]
4. See CreateScheduledAuditResponseTypeDef

# create_scheduled_audit method usage example with argument unpacking

kwargs: CreateScheduledAuditRequestTypeDef = {  # (1)
    "frequency": ...,
    "targetCheckNames": ...,
    "scheduledAuditName": ...,
}

parent.create_scheduled_audit(**kwargs)

1. See CreateScheduledAuditRequestTypeDef

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

1. See Sequence[BehaviorUnionTypeDef]
2. See Mapping[Literal['SNS'], AlertTargetTypeDef]
3. See Sequence[MetricToRetainTypeDef]
4. See Sequence[TagTypeDef]
5. See MetricsExportConfigTypeDef
6. See CreateSecurityProfileResponseTypeDef

# create_security_profile method usage example with argument unpacking

kwargs: CreateSecurityProfileRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.create_security_profile(**kwargs)

1. See CreateSecurityProfileRequestTypeDef

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

1. See Sequence[StreamFileTypeDef]
2. See Sequence[TagTypeDef]
3. See CreateStreamResponseTypeDef

# create_stream method usage example with argument unpacking

kwargs: CreateStreamRequestTypeDef = {  # (1)
    "streamId": ...,
    "files": ...,
    "roleArn": ...,
}

parent.create_stream(**kwargs)

1. See CreateStreamRequestTypeDef

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: AttributePayloadUnionTypeDef = ...,  # (1)
    billingGroupName: str = ...,
) -> CreateThingResponseTypeDef:  # (2)
    ...

1. See AttributePayloadUnionTypeDef
2. See CreateThingResponseTypeDef

# create_thing method usage example with argument unpacking

kwargs: CreateThingRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.create_thing(**kwargs)

1. See CreateThingRequestTypeDef

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: ThingGroupPropertiesUnionTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateThingGroupResponseTypeDef:  # (3)
    ...

1. See ThingGroupPropertiesUnionTypeDef
2. See Sequence[TagTypeDef]
3. See CreateThingGroupResponseTypeDef

# create_thing_group method usage example with argument unpacking

kwargs: CreateThingGroupRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.create_thing_group(**kwargs)

1. See CreateThingGroupRequestTypeDef

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: ThingTypePropertiesUnionTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateThingTypeResponseTypeDef:  # (3)
    ...

1. See ThingTypePropertiesUnionTypeDef
2. See Sequence[TagTypeDef]
3. See CreateThingTypeResponseTypeDef

# create_thing_type method usage example with argument unpacking

kwargs: CreateThingTypeRequestTypeDef = {  # (1)
    "thingTypeName": ...,
}

parent.create_thing_type(**kwargs)

1. See CreateThingTypeRequestTypeDef

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

1. See TopicRulePayloadTypeDef
2. See EmptyResponseMetadataTypeDef

# create_topic_rule method usage example with argument unpacking

kwargs: CreateTopicRuleRequestTypeDef = {  # (1)
    "ruleName": ...,
    "topicRulePayload": ...,
}

parent.create_topic_rule(**kwargs)

1. See CreateTopicRuleRequestTypeDef

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

1. See TopicRuleDestinationConfigurationTypeDef
2. See CreateTopicRuleDestinationResponseTypeDef

# create_topic_rule_destination method usage example with argument unpacking

kwargs: CreateTopicRuleDestinationRequestTypeDef = {  # (1)
    "destinationConfiguration": ...,
}

parent.create_topic_rule_destination(**kwargs)

1. See CreateTopicRuleDestinationRequestTypeDef

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: DeleteAccountAuditConfigurationRequestTypeDef = {  # (1)
    "deleteScheduledAudits": ...,
}

parent.delete_account_audit_configuration(**kwargs)

1. See DeleteAccountAuditConfigurationRequestTypeDef

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]:
    ...

1. See ResourceIdentifierTypeDef

# delete_audit_suppression method usage example with argument unpacking

kwargs: DeleteAuditSuppressionRequestTypeDef = {  # (1)
    "checkName": ...,
    "resourceIdentifier": ...,
}

parent.delete_audit_suppression(**kwargs)

1. See DeleteAuditSuppressionRequestTypeDef

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: DeleteAuthorizerRequestTypeDef = {  # (1)
    "authorizerName": ...,
}

parent.delete_authorizer(**kwargs)

1. See DeleteAuthorizerRequestTypeDef

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: DeleteBillingGroupRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.delete_billing_group(**kwargs)

1. See DeleteBillingGroupRequestTypeDef

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: DeleteCACertificateRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.delete_ca_certificate(**kwargs)

1. See DeleteCACertificateRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_certificate method usage example with argument unpacking

kwargs: DeleteCertificateRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.delete_certificate(**kwargs)

1. See DeleteCertificateRequestTypeDef

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: DeleteCertificateProviderRequestTypeDef = {  # (1)
    "certificateProviderName": ...,
}

parent.delete_certificate_provider(**kwargs)

1. See DeleteCertificateProviderRequestTypeDef

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

1. See DeleteCommandResponseTypeDef

# delete_command method usage example with argument unpacking

kwargs: DeleteCommandRequestTypeDef = {  # (1)
    "commandId": ...,
}

parent.delete_command(**kwargs)

1. See DeleteCommandRequestTypeDef

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: DeleteCommandExecutionRequestTypeDef = {  # (1)
    "executionId": ...,
    "targetArn": ...,
}

parent.delete_command_execution(**kwargs)

1. See DeleteCommandExecutionRequestTypeDef

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: DeleteCustomMetricRequestTypeDef = {  # (1)
    "metricName": ...,
}

parent.delete_custom_metric(**kwargs)

1. See DeleteCustomMetricRequestTypeDef

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: DeleteDimensionRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_dimension(**kwargs)

1. See DeleteDimensionRequestTypeDef

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: DeleteDomainConfigurationRequestTypeDef = {  # (1)
    "domainConfigurationName": ...,
}

parent.delete_domain_configuration(**kwargs)

1. See DeleteDomainConfigurationRequestTypeDef

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: DeleteDynamicThingGroupRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.delete_dynamic_thing_group(**kwargs)

1. See DeleteDynamicThingGroupRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_fleet_metric method usage example with argument unpacking

kwargs: DeleteFleetMetricRequestTypeDef = {  # (1)
    "metricName": ...,
}

parent.delete_fleet_metric(**kwargs)

1. See DeleteFleetMetricRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_job method usage example with argument unpacking

kwargs: DeleteJobRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.delete_job(**kwargs)

1. See DeleteJobRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_job_execution method usage example with argument unpacking

kwargs: DeleteJobExecutionRequestTypeDef = {  # (1)
    "jobId": ...,
    "thingName": ...,
    "executionNumber": ...,
}

parent.delete_job_execution(**kwargs)

1. See DeleteJobExecutionRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_job_template method usage example with argument unpacking

kwargs: DeleteJobTemplateRequestTypeDef = {  # (1)
    "jobTemplateId": ...,
}

parent.delete_job_template(**kwargs)

1. See DeleteJobTemplateRequestTypeDef

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: DeleteMitigationActionRequestTypeDef = {  # (1)
    "actionName": ...,
}

parent.delete_mitigation_action(**kwargs)

1. See DeleteMitigationActionRequestTypeDef

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: DeleteOTAUpdateRequestTypeDef = {  # (1)
    "otaUpdateId": ...,
}

parent.delete_ota_update(**kwargs)

1. See DeleteOTAUpdateRequestTypeDef

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: DeletePackageRequestTypeDef = {  # (1)
    "packageName": ...,
}

parent.delete_package(**kwargs)

1. See DeletePackageRequestTypeDef

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: DeletePackageVersionRequestTypeDef = {  # (1)
    "packageName": ...,
    "versionName": ...,
}

parent.delete_package_version(**kwargs)

1. See DeletePackageVersionRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_policy method usage example with argument unpacking

kwargs: DeletePolicyRequestTypeDef = {  # (1)
    "policyName": ...,
}

parent.delete_policy(**kwargs)

1. See DeletePolicyRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_policy_version method usage example with argument unpacking

kwargs: DeletePolicyVersionRequestTypeDef = {  # (1)
    "policyName": ...,
    "policyVersionId": ...,
}

parent.delete_policy_version(**kwargs)

1. See DeletePolicyVersionRequestTypeDef

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: DeleteProvisioningTemplateRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.delete_provisioning_template(**kwargs)

1. See DeleteProvisioningTemplateRequestTypeDef

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: DeleteProvisioningTemplateVersionRequestTypeDef = {  # (1)
    "templateName": ...,
    "versionId": ...,
}

parent.delete_provisioning_template_version(**kwargs)

1. See DeleteProvisioningTemplateVersionRequestTypeDef

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: DeleteRoleAliasRequestTypeDef = {  # (1)
    "roleAlias": ...,
}

parent.delete_role_alias(**kwargs)

1. See DeleteRoleAliasRequestTypeDef

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: DeleteScheduledAuditRequestTypeDef = {  # (1)
    "scheduledAuditName": ...,
}

parent.delete_scheduled_audit(**kwargs)

1. See DeleteScheduledAuditRequestTypeDef

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: DeleteSecurityProfileRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.delete_security_profile(**kwargs)

1. See DeleteSecurityProfileRequestTypeDef

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: DeleteStreamRequestTypeDef = {  # (1)
    "streamId": ...,
}

parent.delete_stream(**kwargs)

1. See DeleteStreamRequestTypeDef

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: DeleteThingRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.delete_thing(**kwargs)

1. See DeleteThingRequestTypeDef

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: DeleteThingGroupRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.delete_thing_group(**kwargs)

1. See DeleteThingGroupRequestTypeDef

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: DeleteThingTypeRequestTypeDef = {  # (1)
    "thingTypeName": ...,
}

parent.delete_thing_type(**kwargs)

1. See DeleteThingTypeRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# delete_topic_rule method usage example with argument unpacking

kwargs: DeleteTopicRuleRequestTypeDef = {  # (1)
    "ruleName": ...,
}

parent.delete_topic_rule(**kwargs)

1. See DeleteTopicRuleRequestTypeDef

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: DeleteTopicRuleDestinationRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_topic_rule_destination(**kwargs)

1. See DeleteTopicRuleDestinationRequestTypeDef

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

1. See LogTargetTypeType
2. See EmptyResponseMetadataTypeDef

# delete_v2_logging_level method usage example with argument unpacking

kwargs: DeleteV2LoggingLevelRequestTypeDef = {  # (1)
    "targetType": ...,
    "targetName": ...,
}

parent.delete_v2_logging_level(**kwargs)

1. See DeleteV2LoggingLevelRequestTypeDef

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: DeprecateThingTypeRequestTypeDef = {  # (1)
    "thingTypeName": ...,
}

parent.deprecate_thing_type(**kwargs)

1. See DeprecateThingTypeRequestTypeDef

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

1. See DescribeAccountAuditConfigurationResponseTypeDef

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

1. See DescribeAuditFindingResponseTypeDef

# describe_audit_finding method usage example with argument unpacking

kwargs: DescribeAuditFindingRequestTypeDef = {  # (1)
    "findingId": ...,
}

parent.describe_audit_finding(**kwargs)

1. See DescribeAuditFindingRequestTypeDef

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

1. See DescribeAuditMitigationActionsTaskResponseTypeDef

# describe_audit_mitigation_actions_task method usage example with argument unpacking

kwargs: DescribeAuditMitigationActionsTaskRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.describe_audit_mitigation_actions_task(**kwargs)

1. See DescribeAuditMitigationActionsTaskRequestTypeDef

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

1. See ResourceIdentifierTypeDef
2. See DescribeAuditSuppressionResponseTypeDef

# describe_audit_suppression method usage example with argument unpacking

kwargs: DescribeAuditSuppressionRequestTypeDef = {  # (1)
    "checkName": ...,
    "resourceIdentifier": ...,
}

parent.describe_audit_suppression(**kwargs)

1. See DescribeAuditSuppressionRequestTypeDef

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

1. See DescribeAuditTaskResponseTypeDef

# describe_audit_task method usage example with argument unpacking

kwargs: DescribeAuditTaskRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.describe_audit_task(**kwargs)

1. See DescribeAuditTaskRequestTypeDef

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

1. See DescribeAuthorizerResponseTypeDef

# describe_authorizer method usage example with argument unpacking

kwargs: DescribeAuthorizerRequestTypeDef = {  # (1)
    "authorizerName": ...,
}

parent.describe_authorizer(**kwargs)

1. See DescribeAuthorizerRequestTypeDef

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

1. See DescribeBillingGroupResponseTypeDef

# describe_billing_group method usage example with argument unpacking

kwargs: DescribeBillingGroupRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.describe_billing_group(**kwargs)

1. See DescribeBillingGroupRequestTypeDef

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

1. See DescribeCACertificateResponseTypeDef

# describe_ca_certificate method usage example with argument unpacking

kwargs: DescribeCACertificateRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.describe_ca_certificate(**kwargs)

1. See DescribeCACertificateRequestTypeDef

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

1. See DescribeCertificateResponseTypeDef

# describe_certificate method usage example with argument unpacking

kwargs: DescribeCertificateRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.describe_certificate(**kwargs)

1. See DescribeCertificateRequestTypeDef

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

1. See DescribeCertificateProviderResponseTypeDef

# describe_certificate_provider method usage example with argument unpacking

kwargs: DescribeCertificateProviderRequestTypeDef = {  # (1)
    "certificateProviderName": ...,
}

parent.describe_certificate_provider(**kwargs)

1. See DescribeCertificateProviderRequestTypeDef

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

1. See DescribeCustomMetricResponseTypeDef

# describe_custom_metric method usage example with argument unpacking

kwargs: DescribeCustomMetricRequestTypeDef = {  # (1)
    "metricName": ...,
}

parent.describe_custom_metric(**kwargs)

1. See DescribeCustomMetricRequestTypeDef

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

1. See DescribeDefaultAuthorizerResponseTypeDef

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

1. See DescribeDetectMitigationActionsTaskResponseTypeDef

# describe_detect_mitigation_actions_task method usage example with argument unpacking

kwargs: DescribeDetectMitigationActionsTaskRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.describe_detect_mitigation_actions_task(**kwargs)

1. See DescribeDetectMitigationActionsTaskRequestTypeDef

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

1. See DescribeDimensionResponseTypeDef

# describe_dimension method usage example with argument unpacking

kwargs: DescribeDimensionRequestTypeDef = {  # (1)
    "name": ...,
}

parent.describe_dimension(**kwargs)

1. See DescribeDimensionRequestTypeDef

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

1. See DescribeDomainConfigurationResponseTypeDef

# describe_domain_configuration method usage example with argument unpacking

kwargs: DescribeDomainConfigurationRequestTypeDef = {  # (1)
    "domainConfigurationName": ...,
}

parent.describe_domain_configuration(**kwargs)

1. See DescribeDomainConfigurationRequestTypeDef

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

1. See DescribeEndpointResponseTypeDef

# describe_endpoint method usage example with argument unpacking

kwargs: DescribeEndpointRequestTypeDef = {  # (1)
    "endpointType": ...,
}

parent.describe_endpoint(**kwargs)

1. See DescribeEndpointRequestTypeDef

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

1. See DescribeEventConfigurationsResponseTypeDef

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

1. See DescribeFleetMetricResponseTypeDef

# describe_fleet_metric method usage example with argument unpacking

kwargs: DescribeFleetMetricRequestTypeDef = {  # (1)
    "metricName": ...,
}

parent.describe_fleet_metric(**kwargs)

1. See DescribeFleetMetricRequestTypeDef

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

1. See DescribeIndexResponseTypeDef

# describe_index method usage example with argument unpacking

kwargs: DescribeIndexRequestTypeDef = {  # (1)
    "indexName": ...,
}

parent.describe_index(**kwargs)

1. See DescribeIndexRequestTypeDef

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

1. See DescribeJobResponseTypeDef

# describe_job method usage example with argument unpacking

kwargs: DescribeJobRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.describe_job(**kwargs)

1. See DescribeJobRequestTypeDef

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

1. See DescribeJobExecutionResponseTypeDef

# describe_job_execution method usage example with argument unpacking

kwargs: DescribeJobExecutionRequestTypeDef = {  # (1)
    "jobId": ...,
    "thingName": ...,
}

parent.describe_job_execution(**kwargs)

1. See DescribeJobExecutionRequestTypeDef

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

1. See DescribeJobTemplateResponseTypeDef

# describe_job_template method usage example with argument unpacking

kwargs: DescribeJobTemplateRequestTypeDef = {  # (1)
    "jobTemplateId": ...,
}

parent.describe_job_template(**kwargs)

1. See DescribeJobTemplateRequestTypeDef

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

1. See DescribeManagedJobTemplateResponseTypeDef

# describe_managed_job_template method usage example with argument unpacking

kwargs: DescribeManagedJobTemplateRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.describe_managed_job_template(**kwargs)

1. See DescribeManagedJobTemplateRequestTypeDef

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

1. See DescribeMitigationActionResponseTypeDef

# describe_mitigation_action method usage example with argument unpacking

kwargs: DescribeMitigationActionRequestTypeDef = {  # (1)
    "actionName": ...,
}

parent.describe_mitigation_action(**kwargs)

1. See DescribeMitigationActionRequestTypeDef

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

1. See DescribeProvisioningTemplateResponseTypeDef

# describe_provisioning_template method usage example with argument unpacking

kwargs: DescribeProvisioningTemplateRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.describe_provisioning_template(**kwargs)

1. See DescribeProvisioningTemplateRequestTypeDef

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

1. See DescribeProvisioningTemplateVersionResponseTypeDef

# describe_provisioning_template_version method usage example with argument unpacking

kwargs: DescribeProvisioningTemplateVersionRequestTypeDef = {  # (1)
    "templateName": ...,
    "versionId": ...,
}

parent.describe_provisioning_template_version(**kwargs)

1. See DescribeProvisioningTemplateVersionRequestTypeDef

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

1. See DescribeRoleAliasResponseTypeDef

# describe_role_alias method usage example with argument unpacking

kwargs: DescribeRoleAliasRequestTypeDef = {  # (1)
    "roleAlias": ...,
}

parent.describe_role_alias(**kwargs)

1. See DescribeRoleAliasRequestTypeDef

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

1. See DescribeScheduledAuditResponseTypeDef

# describe_scheduled_audit method usage example with argument unpacking

kwargs: DescribeScheduledAuditRequestTypeDef = {  # (1)
    "scheduledAuditName": ...,
}

parent.describe_scheduled_audit(**kwargs)

1. See DescribeScheduledAuditRequestTypeDef

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

1. See DescribeSecurityProfileResponseTypeDef

# describe_security_profile method usage example with argument unpacking

kwargs: DescribeSecurityProfileRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.describe_security_profile(**kwargs)

1. See DescribeSecurityProfileRequestTypeDef

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

1. See DescribeStreamResponseTypeDef

# describe_stream method usage example with argument unpacking

kwargs: DescribeStreamRequestTypeDef = {  # (1)
    "streamId": ...,
}

parent.describe_stream(**kwargs)

1. See DescribeStreamRequestTypeDef

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

1. See DescribeThingResponseTypeDef

# describe_thing method usage example with argument unpacking

kwargs: DescribeThingRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.describe_thing(**kwargs)

1. See DescribeThingRequestTypeDef

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

1. See DescribeThingGroupResponseTypeDef

# describe_thing_group method usage example with argument unpacking

kwargs: DescribeThingGroupRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.describe_thing_group(**kwargs)

1. See DescribeThingGroupRequestTypeDef

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

1. See DescribeThingRegistrationTaskResponseTypeDef

# describe_thing_registration_task method usage example with argument unpacking

kwargs: DescribeThingRegistrationTaskRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.describe_thing_registration_task(**kwargs)

1. See DescribeThingRegistrationTaskRequestTypeDef

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

1. See DescribeThingTypeResponseTypeDef

# describe_thing_type method usage example with argument unpacking

kwargs: DescribeThingTypeRequestTypeDef = {  # (1)
    "thingTypeName": ...,
}

parent.describe_thing_type(**kwargs)

1. See DescribeThingTypeRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# detach_policy method usage example with argument unpacking

kwargs: DetachPolicyRequestTypeDef = {  # (1)
    "policyName": ...,
    "target": ...,
}

parent.detach_policy(**kwargs)

1. See DetachPolicyRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# detach_principal_policy method usage example with argument unpacking

kwargs: DetachPrincipalPolicyRequestTypeDef = {  # (1)
    "policyName": ...,
    "principal": ...,
}

parent.detach_principal_policy(**kwargs)

1. See DetachPrincipalPolicyRequestTypeDef

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: DetachSecurityProfileRequestTypeDef = {  # (1)
    "securityProfileName": ...,
    "securityProfileTargetArn": ...,
}

parent.detach_security_profile(**kwargs)

1. See DetachSecurityProfileRequestTypeDef

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: DetachThingPrincipalRequestTypeDef = {  # (1)
    "thingName": ...,
    "principal": ...,
}

parent.detach_thing_principal(**kwargs)

1. See DetachThingPrincipalRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# disable_topic_rule method usage example with argument unpacking

kwargs: DisableTopicRuleRequestTypeDef = {  # (1)
    "ruleName": ...,
}

parent.disable_topic_rule(**kwargs)

1. See DisableTopicRuleRequestTypeDef

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: DisassociateSbomFromPackageVersionRequestTypeDef = {  # (1)
    "packageName": ...,
    "versionName": ...,
}

parent.disassociate_sbom_from_package_version(**kwargs)

1. See DisassociateSbomFromPackageVersionRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# enable_topic_rule method usage example with argument unpacking

kwargs: EnableTopicRuleRequestTypeDef = {  # (1)
    "ruleName": ...,
}

parent.enable_topic_rule(**kwargs)

1. See EnableTopicRuleRequestTypeDef

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

1. See GetBehaviorModelTrainingSummariesResponseTypeDef

# get_behavior_model_training_summaries method usage example with argument unpacking

kwargs: GetBehaviorModelTrainingSummariesRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.get_behavior_model_training_summaries(**kwargs)

1. See GetBehaviorModelTrainingSummariesRequestTypeDef

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

1. See BucketsAggregationTypeTypeDef
2. See GetBucketsAggregationResponseTypeDef

# get_buckets_aggregation method usage example with argument unpacking

kwargs: GetBucketsAggregationRequestTypeDef = {  # (1)
    "queryString": ...,
    "aggregationField": ...,
    "bucketsAggregationType": ...,
}

parent.get_buckets_aggregation(**kwargs)

1. See GetBucketsAggregationRequestTypeDef

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

1. See GetCardinalityResponseTypeDef

# get_cardinality method usage example with argument unpacking

kwargs: GetCardinalityRequestTypeDef = {  # (1)
    "queryString": ...,
}

parent.get_cardinality(**kwargs)

1. See GetCardinalityRequestTypeDef

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

1. See GetCommandResponseTypeDef

# get_command method usage example with argument unpacking

kwargs: GetCommandRequestTypeDef = {  # (1)
    "commandId": ...,
}

parent.get_command(**kwargs)

1. See GetCommandRequestTypeDef

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

1. See GetCommandExecutionResponseTypeDef

# get_command_execution method usage example with argument unpacking

kwargs: GetCommandExecutionRequestTypeDef = {  # (1)
    "executionId": ...,
    "targetArn": ...,
}

parent.get_command_execution(**kwargs)

1. See GetCommandExecutionRequestTypeDef

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

1. See GetEffectivePoliciesResponseTypeDef

# get_effective_policies method usage example with argument unpacking

kwargs: GetEffectivePoliciesRequestTypeDef = {  # (1)
    "principal": ...,
}

parent.get_effective_policies(**kwargs)

1. See GetEffectivePoliciesRequestTypeDef

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

1. See GetIndexingConfigurationResponseTypeDef

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

1. See GetJobDocumentResponseTypeDef

# get_job_document method usage example with argument unpacking

kwargs: GetJobDocumentRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.get_job_document(**kwargs)

1. See GetJobDocumentRequestTypeDef

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

1. See GetLoggingOptionsResponseTypeDef

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

1. See GetOTAUpdateResponseTypeDef

# get_ota_update method usage example with argument unpacking

kwargs: GetOTAUpdateRequestTypeDef = {  # (1)
    "otaUpdateId": ...,
}

parent.get_ota_update(**kwargs)

1. See GetOTAUpdateRequestTypeDef

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

1. See GetPackageResponseTypeDef

# get_package method usage example with argument unpacking

kwargs: GetPackageRequestTypeDef = {  # (1)
    "packageName": ...,
}

parent.get_package(**kwargs)

1. See GetPackageRequestTypeDef

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

1. See GetPackageConfigurationResponseTypeDef

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

1. See GetPackageVersionResponseTypeDef

# get_package_version method usage example with argument unpacking

kwargs: GetPackageVersionRequestTypeDef = {  # (1)
    "packageName": ...,
    "versionName": ...,
}

parent.get_package_version(**kwargs)

1. See GetPackageVersionRequestTypeDef

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

1. See GetPercentilesResponseTypeDef

# get_percentiles method usage example with argument unpacking

kwargs: GetPercentilesRequestTypeDef = {  # (1)
    "queryString": ...,
}

parent.get_percentiles(**kwargs)

1. See GetPercentilesRequestTypeDef

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

1. See GetPolicyResponseTypeDef

# get_policy method usage example with argument unpacking

kwargs: GetPolicyRequestTypeDef = {  # (1)
    "policyName": ...,
}

parent.get_policy(**kwargs)

1. See GetPolicyRequestTypeDef

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

1. See GetPolicyVersionResponseTypeDef

# get_policy_version method usage example with argument unpacking

kwargs: GetPolicyVersionRequestTypeDef = {  # (1)
    "policyName": ...,
    "policyVersionId": ...,
}

parent.get_policy_version(**kwargs)

1. See GetPolicyVersionRequestTypeDef

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

1. See GetRegistrationCodeResponseTypeDef

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

1. See GetStatisticsResponseTypeDef

# get_statistics method usage example with argument unpacking

kwargs: GetStatisticsRequestTypeDef = {  # (1)
    "queryString": ...,
}

parent.get_statistics(**kwargs)

1. See GetStatisticsRequestTypeDef

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

1. See GetThingConnectivityDataResponseTypeDef

# get_thing_connectivity_data method usage example with argument unpacking

kwargs: GetThingConnectivityDataRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.get_thing_connectivity_data(**kwargs)

1. See GetThingConnectivityDataRequestTypeDef

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

1. See GetTopicRuleResponseTypeDef

# get_topic_rule method usage example with argument unpacking

kwargs: GetTopicRuleRequestTypeDef = {  # (1)
    "ruleName": ...,
}

parent.get_topic_rule(**kwargs)

1. See GetTopicRuleRequestTypeDef

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

1. See GetTopicRuleDestinationResponseTypeDef

# get_topic_rule_destination method usage example with argument unpacking

kwargs: GetTopicRuleDestinationRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_topic_rule_destination(**kwargs)

1. See GetTopicRuleDestinationRequestTypeDef

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

1. See GetV2LoggingOptionsResponseTypeDef

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

1. See BehaviorCriteriaTypeType
2. See VerificationStateType
3. See ListActiveViolationsResponseTypeDef

# list_active_violations method usage example with argument unpacking

kwargs: ListActiveViolationsRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.list_active_violations(**kwargs)

1. See ListActiveViolationsRequestTypeDef

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

1. See ListAttachedPoliciesResponseTypeDef

# list_attached_policies method usage example with argument unpacking

kwargs: ListAttachedPoliciesRequestTypeDef = {  # (1)
    "target": ...,
}

parent.list_attached_policies(**kwargs)

1. See ListAttachedPoliciesRequestTypeDef

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

1. See ResourceIdentifierTypeDef
2. See ListAuditFindingsResponseTypeDef

# list_audit_findings method usage example with argument unpacking

kwargs: ListAuditFindingsRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.list_audit_findings(**kwargs)

1. See ListAuditFindingsRequestTypeDef

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

1. See AuditMitigationActionsExecutionStatusType
2. See ListAuditMitigationActionsExecutionsResponseTypeDef

# list_audit_mitigation_actions_executions method usage example with argument unpacking

kwargs: ListAuditMitigationActionsExecutionsRequestTypeDef = {  # (1)
    "taskId": ...,
    "findingId": ...,
}

parent.list_audit_mitigation_actions_executions(**kwargs)

1. See ListAuditMitigationActionsExecutionsRequestTypeDef

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

1. See AuditMitigationActionsTaskStatusType
2. See ListAuditMitigationActionsTasksResponseTypeDef

# list_audit_mitigation_actions_tasks method usage example with argument unpacking

kwargs: ListAuditMitigationActionsTasksRequestTypeDef = {  # (1)
    "startTime": ...,
    "endTime": ...,
}

parent.list_audit_mitigation_actions_tasks(**kwargs)

1. See ListAuditMitigationActionsTasksRequestTypeDef

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

1. See ResourceIdentifierTypeDef
2. See ListAuditSuppressionsResponseTypeDef

# list_audit_suppressions method usage example with argument unpacking

kwargs: ListAuditSuppressionsRequestTypeDef = {  # (1)
    "checkName": ...,
}

parent.list_audit_suppressions(**kwargs)

1. See ListAuditSuppressionsRequestTypeDef

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

1. See AuditTaskTypeType
2. See AuditTaskStatusType
3. See ListAuditTasksResponseTypeDef

# list_audit_tasks method usage example with argument unpacking

kwargs: ListAuditTasksRequestTypeDef = {  # (1)
    "startTime": ...,
    "endTime": ...,
}

parent.list_audit_tasks(**kwargs)

1. See ListAuditTasksRequestTypeDef

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

1. See AuthorizerStatusType
2. See ListAuthorizersResponseTypeDef

# list_authorizers method usage example with argument unpacking

kwargs: ListAuthorizersRequestTypeDef = {  # (1)
    "pageSize": ...,
}

parent.list_authorizers(**kwargs)

1. See ListAuthorizersRequestTypeDef

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

1. See ListBillingGroupsResponseTypeDef

# list_billing_groups method usage example with argument unpacking

kwargs: ListBillingGroupsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_billing_groups(**kwargs)

1. See ListBillingGroupsRequestTypeDef

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

1. See ListCACertificatesResponseTypeDef

# list_ca_certificates method usage example with argument unpacking

kwargs: ListCACertificatesRequestTypeDef = {  # (1)
    "pageSize": ...,
}

parent.list_ca_certificates(**kwargs)

1. See ListCACertificatesRequestTypeDef

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

1. See ListCertificateProvidersResponseTypeDef

# list_certificate_providers method usage example with argument unpacking

kwargs: ListCertificateProvidersRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_certificate_providers(**kwargs)

1. See ListCertificateProvidersRequestTypeDef

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

1. See ListCertificatesResponseTypeDef

# list_certificates method usage example with argument unpacking

kwargs: ListCertificatesRequestTypeDef = {  # (1)
    "pageSize": ...,
}

parent.list_certificates(**kwargs)

1. See ListCertificatesRequestTypeDef

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

1. See ListCertificatesByCAResponseTypeDef

# list_certificates_by_ca method usage example with argument unpacking

kwargs: ListCertificatesByCARequestTypeDef = {  # (1)
    "caCertificateId": ...,
}

parent.list_certificates_by_ca(**kwargs)

1. See ListCertificatesByCARequestTypeDef

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

1. See CommandNamespaceType
2. See CommandExecutionStatusType
3. See SortOrderType
4. See TimeFilterTypeDef
5. See TimeFilterTypeDef
6. See ListCommandExecutionsResponseTypeDef

# list_command_executions method usage example with argument unpacking

kwargs: ListCommandExecutionsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_command_executions(**kwargs)

1. See ListCommandExecutionsRequestTypeDef

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

1. See CommandNamespaceType
2. See SortOrderType
3. See ListCommandsResponseTypeDef

# list_commands method usage example with argument unpacking

kwargs: ListCommandsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_commands(**kwargs)

1. See ListCommandsRequestTypeDef

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

1. See ListCustomMetricsResponseTypeDef

# list_custom_metrics method usage example with argument unpacking

kwargs: ListCustomMetricsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_custom_metrics(**kwargs)

1. See ListCustomMetricsRequestTypeDef

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

1. See ListDetectMitigationActionsExecutionsResponseTypeDef

# list_detect_mitigation_actions_executions method usage example with argument unpacking

kwargs: ListDetectMitigationActionsExecutionsRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.list_detect_mitigation_actions_executions(**kwargs)

1. See ListDetectMitigationActionsExecutionsRequestTypeDef

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

1. See ListDetectMitigationActionsTasksResponseTypeDef

# list_detect_mitigation_actions_tasks method usage example with argument unpacking

kwargs: ListDetectMitigationActionsTasksRequestTypeDef = {  # (1)
    "startTime": ...,
    "endTime": ...,
}

parent.list_detect_mitigation_actions_tasks(**kwargs)

1. See ListDetectMitigationActionsTasksRequestTypeDef

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

1. See ListDimensionsResponseTypeDef

# list_dimensions method usage example with argument unpacking

kwargs: ListDimensionsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_dimensions(**kwargs)

1. See ListDimensionsRequestTypeDef

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

1. See ServiceTypeType
2. See ListDomainConfigurationsResponseTypeDef

# list_domain_configurations method usage example with argument unpacking

kwargs: ListDomainConfigurationsRequestTypeDef = {  # (1)
    "marker": ...,
}

parent.list_domain_configurations(**kwargs)

1. See ListDomainConfigurationsRequestTypeDef

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

1. See ListFleetMetricsResponseTypeDef

# list_fleet_metrics method usage example with argument unpacking

kwargs: ListFleetMetricsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_fleet_metrics(**kwargs)

1. See ListFleetMetricsRequestTypeDef

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

1. See ListIndicesResponseTypeDef

# list_indices method usage example with argument unpacking

kwargs: ListIndicesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_indices(**kwargs)

1. See ListIndicesRequestTypeDef

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

1. See JobExecutionStatusType
2. See ListJobExecutionsForJobResponseTypeDef

# list_job_executions_for_job method usage example with argument unpacking

kwargs: ListJobExecutionsForJobRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.list_job_executions_for_job(**kwargs)

1. See ListJobExecutionsForJobRequestTypeDef

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

1. See JobExecutionStatusType
2. See ListJobExecutionsForThingResponseTypeDef

# list_job_executions_for_thing method usage example with argument unpacking

kwargs: ListJobExecutionsForThingRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.list_job_executions_for_thing(**kwargs)

1. See ListJobExecutionsForThingRequestTypeDef

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

1. See ListJobTemplatesResponseTypeDef

# list_job_templates method usage example with argument unpacking

kwargs: ListJobTemplatesRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_job_templates(**kwargs)

1. See ListJobTemplatesRequestTypeDef

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

1. See JobStatusType
2. See TargetSelectionType
3. See ListJobsResponseTypeDef

# list_jobs method usage example with argument unpacking

kwargs: ListJobsRequestTypeDef = {  # (1)
    "status": ...,
}

parent.list_jobs(**kwargs)

1. See ListJobsRequestTypeDef

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

1. See ListManagedJobTemplatesResponseTypeDef

# list_managed_job_templates method usage example with argument unpacking

kwargs: ListManagedJobTemplatesRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.list_managed_job_templates(**kwargs)

1. See ListManagedJobTemplatesRequestTypeDef

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

1. See DimensionValueOperatorType
2. See ListMetricValuesResponseTypeDef

# list_metric_values method usage example with argument unpacking

kwargs: ListMetricValuesRequestTypeDef = {  # (1)
    "thingName": ...,
    "metricName": ...,
    "startTime": ...,
    "endTime": ...,
}

parent.list_metric_values(**kwargs)

1. See ListMetricValuesRequestTypeDef

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

1. See MitigationActionTypeType
2. See ListMitigationActionsResponseTypeDef

# list_mitigation_actions method usage example with argument unpacking

kwargs: ListMitigationActionsRequestTypeDef = {  # (1)
    "actionType": ...,
}

parent.list_mitigation_actions(**kwargs)

1. See ListMitigationActionsRequestTypeDef

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

1. See OTAUpdateStatusType
2. See ListOTAUpdatesResponseTypeDef

# list_ota_updates method usage example with argument unpacking

kwargs: ListOTAUpdatesRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_ota_updates(**kwargs)

1. See ListOTAUpdatesRequestTypeDef

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

1. See ListOutgoingCertificatesResponseTypeDef

# list_outgoing_certificates method usage example with argument unpacking

kwargs: ListOutgoingCertificatesRequestTypeDef = {  # (1)
    "pageSize": ...,
}

parent.list_outgoing_certificates(**kwargs)

1. See ListOutgoingCertificatesRequestTypeDef

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

1. See PackageVersionStatusType
2. See ListPackageVersionsResponseTypeDef

# list_package_versions method usage example with argument unpacking

kwargs: ListPackageVersionsRequestTypeDef = {  # (1)
    "packageName": ...,
}

parent.list_package_versions(**kwargs)

1. See ListPackageVersionsRequestTypeDef

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

1. See ListPackagesResponseTypeDef

# list_packages method usage example with argument unpacking

kwargs: ListPackagesRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_packages(**kwargs)

1. See ListPackagesRequestTypeDef

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

1. See ListPoliciesResponseTypeDef

# list_policies method usage example with argument unpacking

kwargs: ListPoliciesRequestTypeDef = {  # (1)
    "marker": ...,
}

parent.list_policies(**kwargs)

1. See ListPoliciesRequestTypeDef

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

1. See ListPolicyPrincipalsResponseTypeDef

# list_policy_principals method usage example with argument unpacking

kwargs: ListPolicyPrincipalsRequestTypeDef = {  # (1)
    "policyName": ...,
}

parent.list_policy_principals(**kwargs)

1. See ListPolicyPrincipalsRequestTypeDef

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

1. See ListPolicyVersionsResponseTypeDef

# list_policy_versions method usage example with argument unpacking

kwargs: ListPolicyVersionsRequestTypeDef = {  # (1)
    "policyName": ...,
}

parent.list_policy_versions(**kwargs)

1. See ListPolicyVersionsRequestTypeDef

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

1. See ListPrincipalPoliciesResponseTypeDef

# list_principal_policies method usage example with argument unpacking

kwargs: ListPrincipalPoliciesRequestTypeDef = {  # (1)
    "principal": ...,
}

parent.list_principal_policies(**kwargs)

1. See ListPrincipalPoliciesRequestTypeDef

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

1. See ListPrincipalThingsResponseTypeDef

# list_principal_things method usage example with argument unpacking

kwargs: ListPrincipalThingsRequestTypeDef = {  # (1)
    "principal": ...,
}

parent.list_principal_things(**kwargs)

1. See ListPrincipalThingsRequestTypeDef

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

1. See ThingPrincipalTypeType
2. See ListPrincipalThingsV2ResponseTypeDef

# list_principal_things_v2 method usage example with argument unpacking

kwargs: ListPrincipalThingsV2RequestTypeDef = {  # (1)
    "principal": ...,
}

parent.list_principal_things_v2(**kwargs)

1. See ListPrincipalThingsV2RequestTypeDef

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

1. See ListProvisioningTemplateVersionsResponseTypeDef

# list_provisioning_template_versions method usage example with argument unpacking

kwargs: ListProvisioningTemplateVersionsRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.list_provisioning_template_versions(**kwargs)

1. See ListProvisioningTemplateVersionsRequestTypeDef

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

1. See ListProvisioningTemplatesResponseTypeDef

# list_provisioning_templates method usage example with argument unpacking

kwargs: ListProvisioningTemplatesRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_provisioning_templates(**kwargs)

1. See ListProvisioningTemplatesRequestTypeDef

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

1. See ListRelatedResourcesForAuditFindingResponseTypeDef

# list_related_resources_for_audit_finding method usage example with argument unpacking

kwargs: ListRelatedResourcesForAuditFindingRequestTypeDef = {  # (1)
    "findingId": ...,
}

parent.list_related_resources_for_audit_finding(**kwargs)

1. See ListRelatedResourcesForAuditFindingRequestTypeDef

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

1. See ListRoleAliasesResponseTypeDef

# list_role_aliases method usage example with argument unpacking

kwargs: ListRoleAliasesRequestTypeDef = {  # (1)
    "pageSize": ...,
}

parent.list_role_aliases(**kwargs)

1. See ListRoleAliasesRequestTypeDef

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

1. See SbomValidationResultType
2. See ListSbomValidationResultsResponseTypeDef

# list_sbom_validation_results method usage example with argument unpacking

kwargs: ListSbomValidationResultsRequestTypeDef = {  # (1)
    "packageName": ...,
    "versionName": ...,
}

parent.list_sbom_validation_results(**kwargs)

1. See ListSbomValidationResultsRequestTypeDef

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

1. See ListScheduledAuditsResponseTypeDef

# list_scheduled_audits method usage example with argument unpacking

kwargs: ListScheduledAuditsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_scheduled_audits(**kwargs)

1. See ListScheduledAuditsRequestTypeDef

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

1. See ListSecurityProfilesResponseTypeDef

# list_security_profiles method usage example with argument unpacking

kwargs: ListSecurityProfilesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_security_profiles(**kwargs)

1. See ListSecurityProfilesRequestTypeDef

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

1. See ListSecurityProfilesForTargetResponseTypeDef

# list_security_profiles_for_target method usage example with argument unpacking

kwargs: ListSecurityProfilesForTargetRequestTypeDef = {  # (1)
    "securityProfileTargetArn": ...,
}

parent.list_security_profiles_for_target(**kwargs)

1. See ListSecurityProfilesForTargetRequestTypeDef

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

1. See ListStreamsResponseTypeDef

# list_streams method usage example with argument unpacking

kwargs: ListStreamsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_streams(**kwargs)

1. See ListStreamsRequestTypeDef

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

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

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

1. See ListTargetsForPolicyResponseTypeDef

# list_targets_for_policy method usage example with argument unpacking

kwargs: ListTargetsForPolicyRequestTypeDef = {  # (1)
    "policyName": ...,
}

parent.list_targets_for_policy(**kwargs)

1. See ListTargetsForPolicyRequestTypeDef

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

1. See ListTargetsForSecurityProfileResponseTypeDef

# list_targets_for_security_profile method usage example with argument unpacking

kwargs: ListTargetsForSecurityProfileRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.list_targets_for_security_profile(**kwargs)

1. See ListTargetsForSecurityProfileRequestTypeDef

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

1. See ListThingGroupsResponseTypeDef

# list_thing_groups method usage example with argument unpacking

kwargs: ListThingGroupsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_thing_groups(**kwargs)

1. See ListThingGroupsRequestTypeDef

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

1. See ListThingGroupsForThingResponseTypeDef

# list_thing_groups_for_thing method usage example with argument unpacking

kwargs: ListThingGroupsForThingRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.list_thing_groups_for_thing(**kwargs)

1. See ListThingGroupsForThingRequestTypeDef

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

1. See ListThingPrincipalsResponseTypeDef

# list_thing_principals method usage example with argument unpacking

kwargs: ListThingPrincipalsRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.list_thing_principals(**kwargs)

1. See ListThingPrincipalsRequestTypeDef

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

1. See ThingPrincipalTypeType
2. See ListThingPrincipalsV2ResponseTypeDef

# list_thing_principals_v2 method usage example with argument unpacking

kwargs: ListThingPrincipalsV2RequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.list_thing_principals_v2(**kwargs)

1. See ListThingPrincipalsV2RequestTypeDef

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

1. See ReportTypeType
2. See ListThingRegistrationTaskReportsResponseTypeDef

# list_thing_registration_task_reports method usage example with argument unpacking

kwargs: ListThingRegistrationTaskReportsRequestTypeDef = {  # (1)
    "taskId": ...,
    "reportType": ...,
}

parent.list_thing_registration_task_reports(**kwargs)

1. See ListThingRegistrationTaskReportsRequestTypeDef

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

1. See StatusType
2. See ListThingRegistrationTasksResponseTypeDef

# list_thing_registration_tasks method usage example with argument unpacking

kwargs: ListThingRegistrationTasksRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_thing_registration_tasks(**kwargs)

1. See ListThingRegistrationTasksRequestTypeDef

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

1. See ListThingTypesResponseTypeDef

# list_thing_types method usage example with argument unpacking

kwargs: ListThingTypesRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_thing_types(**kwargs)

1. See ListThingTypesRequestTypeDef

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

1. See ListThingsResponseTypeDef

# list_things method usage example with argument unpacking

kwargs: ListThingsRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_things(**kwargs)

1. See ListThingsRequestTypeDef

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

1. See ListThingsInBillingGroupResponseTypeDef

# list_things_in_billing_group method usage example with argument unpacking

kwargs: ListThingsInBillingGroupRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.list_things_in_billing_group(**kwargs)

1. See ListThingsInBillingGroupRequestTypeDef

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

1. See ListThingsInThingGroupResponseTypeDef

# list_things_in_thing_group method usage example with argument unpacking

kwargs: ListThingsInThingGroupRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.list_things_in_thing_group(**kwargs)

1. See ListThingsInThingGroupRequestTypeDef

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

1. See ListTopicRuleDestinationsResponseTypeDef

# list_topic_rule_destinations method usage example with argument unpacking

kwargs: ListTopicRuleDestinationsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_topic_rule_destinations(**kwargs)

1. See ListTopicRuleDestinationsRequestTypeDef

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

1. See ListTopicRulesResponseTypeDef

# list_topic_rules method usage example with argument unpacking

kwargs: ListTopicRulesRequestTypeDef = {  # (1)
    "topic": ...,
}

parent.list_topic_rules(**kwargs)

1. See ListTopicRulesRequestTypeDef

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

1. See LogTargetTypeType
2. See ListV2LoggingLevelsResponseTypeDef

# list_v2_logging_levels method usage example with argument unpacking

kwargs: ListV2LoggingLevelsRequestTypeDef = {  # (1)
    "targetType": ...,
}

parent.list_v2_logging_levels(**kwargs)

1. See ListV2LoggingLevelsRequestTypeDef

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

1. See BehaviorCriteriaTypeType
2. See VerificationStateType
3. See ListViolationEventsResponseTypeDef

# list_violation_events method usage example with argument unpacking

kwargs: ListViolationEventsRequestTypeDef = {  # (1)
    "startTime": ...,
    "endTime": ...,
}

parent.list_violation_events(**kwargs)

1. See ListViolationEventsRequestTypeDef

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]:
    ...

1. See VerificationStateType

# put_verification_state_on_violation method usage example with argument unpacking

kwargs: PutVerificationStateOnViolationRequestTypeDef = {  # (1)
    "violationId": ...,
    "verificationState": ...,
}

parent.put_verification_state_on_violation(**kwargs)

1. See PutVerificationStateOnViolationRequestTypeDef

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

1. See RegistrationConfigTypeDef
2. See Sequence[TagTypeDef]
3. See CertificateModeType
4. See RegisterCACertificateResponseTypeDef

# register_ca_certificate method usage example with argument unpacking

kwargs: RegisterCACertificateRequestTypeDef = {  # (1)
    "caCertificate": ...,
}

parent.register_ca_certificate(**kwargs)

1. See RegisterCACertificateRequestTypeDef

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

1. See CertificateStatusType
2. See RegisterCertificateResponseTypeDef

# register_certificate method usage example with argument unpacking

kwargs: RegisterCertificateRequestTypeDef = {  # (1)
    "certificatePem": ...,
}

parent.register_certificate(**kwargs)

1. See RegisterCertificateRequestTypeDef

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

1. See CertificateStatusType
2. See RegisterCertificateWithoutCAResponseTypeDef

# register_certificate_without_ca method usage example with argument unpacking

kwargs: RegisterCertificateWithoutCARequestTypeDef = {  # (1)
    "certificatePem": ...,
}

parent.register_certificate_without_ca(**kwargs)

1. See RegisterCertificateWithoutCARequestTypeDef

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

1. See RegisterThingResponseTypeDef

# register_thing method usage example with argument unpacking

kwargs: RegisterThingRequestTypeDef = {  # (1)
    "templateBody": ...,
}

parent.register_thing(**kwargs)

1. See RegisterThingRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# reject_certificate_transfer method usage example with argument unpacking

kwargs: RejectCertificateTransferRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.reject_certificate_transfer(**kwargs)

1. See RejectCertificateTransferRequestTypeDef

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: RemoveThingFromBillingGroupRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.remove_thing_from_billing_group(**kwargs)

1. See RemoveThingFromBillingGroupRequestTypeDef

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: RemoveThingFromThingGroupRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.remove_thing_from_thing_group(**kwargs)

1. See RemoveThingFromThingGroupRequestTypeDef

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

1. See TopicRulePayloadTypeDef
2. See EmptyResponseMetadataTypeDef

# replace_topic_rule method usage example with argument unpacking

kwargs: ReplaceTopicRuleRequestTypeDef = {  # (1)
    "ruleName": ...,
    "topicRulePayload": ...,
}

parent.replace_topic_rule(**kwargs)

1. See ReplaceTopicRuleRequestTypeDef

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

1. See SearchIndexResponseTypeDef

# search_index method usage example with argument unpacking

kwargs: SearchIndexRequestTypeDef = {  # (1)
    "queryString": ...,
}

parent.search_index(**kwargs)

1. See SearchIndexRequestTypeDef

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

1. See SetDefaultAuthorizerResponseTypeDef

# set_default_authorizer method usage example with argument unpacking

kwargs: SetDefaultAuthorizerRequestTypeDef = {  # (1)
    "authorizerName": ...,
}

parent.set_default_authorizer(**kwargs)

1. See SetDefaultAuthorizerRequestTypeDef

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

1. See EmptyResponseMetadataTypeDef

# set_default_policy_version method usage example with argument unpacking

kwargs: SetDefaultPolicyVersionRequestTypeDef = {  # (1)
    "policyName": ...,
    "policyVersionId": ...,
}

parent.set_default_policy_version(**kwargs)

1. See SetDefaultPolicyVersionRequestTypeDef

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

1. See LoggingOptionsPayloadTypeDef
2. See EmptyResponseMetadataTypeDef

# set_logging_options method usage example with argument unpacking

kwargs: SetLoggingOptionsRequestTypeDef = {  # (1)
    "loggingOptionsPayload": ...,
}

parent.set_logging_options(**kwargs)

1. See SetLoggingOptionsRequestTypeDef

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

1. See LogTargetTypeDef
2. See LogLevelType
3. See EmptyResponseMetadataTypeDef

# set_v2_logging_level method usage example with argument unpacking

kwargs: SetV2LoggingLevelRequestTypeDef = {  # (1)
    "logTarget": ...,
    "logLevel": ...,
}

parent.set_v2_logging_level(**kwargs)

1. See SetV2LoggingLevelRequestTypeDef

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

1. See LogLevelType
2. See EmptyResponseMetadataTypeDef

# set_v2_logging_options method usage example with argument unpacking

kwargs: SetV2LoggingOptionsRequestTypeDef = {  # (1)
    "roleArn": ...,
}

parent.set_v2_logging_options(**kwargs)

1. See SetV2LoggingOptionsRequestTypeDef

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: AuditMitigationActionsTaskTargetUnionTypeDef,  # (1)
    auditCheckToActionsMapping: Mapping[str, Sequence[str]],
    clientRequestToken: str,
) -> StartAuditMitigationActionsTaskResponseTypeDef:  # (2)
    ...

1. See AuditMitigationActionsTaskTargetUnionTypeDef
2. See StartAuditMitigationActionsTaskResponseTypeDef

# start_audit_mitigation_actions_task method usage example with argument unpacking

kwargs: StartAuditMitigationActionsTaskRequestTypeDef = {  # (1)
    "taskId": ...,
    "target": ...,
    "auditCheckToActionsMapping": ...,
    "clientRequestToken": ...,
}

parent.start_audit_mitigation_actions_task(**kwargs)

1. See StartAuditMitigationActionsTaskRequestTypeDef

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: DetectMitigationActionsTaskTargetUnionTypeDef,  # (1)
    actions: Sequence[str],
    clientRequestToken: str,
    violationEventOccurrenceRange: ViolationEventOccurrenceRangeUnionTypeDef = ...,  # (2)
    includeOnlyActiveViolations: bool = ...,
    includeSuppressedAlerts: bool = ...,
) -> StartDetectMitigationActionsTaskResponseTypeDef:  # (3)
    ...

1. See DetectMitigationActionsTaskTargetUnionTypeDef
2. See ViolationEventOccurrenceRangeUnionTypeDef
3. See StartDetectMitigationActionsTaskResponseTypeDef

# start_detect_mitigation_actions_task method usage example with argument unpacking

kwargs: StartDetectMitigationActionsTaskRequestTypeDef = {  # (1)
    "taskId": ...,
    "target": ...,
    "actions": ...,
    "clientRequestToken": ...,
}

parent.start_detect_mitigation_actions_task(**kwargs)

1. See StartDetectMitigationActionsTaskRequestTypeDef

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

1. See StartOnDemandAuditTaskResponseTypeDef

# start_on_demand_audit_task method usage example with argument unpacking

kwargs: StartOnDemandAuditTaskRequestTypeDef = {  # (1)
    "targetCheckNames": ...,
}

parent.start_on_demand_audit_task(**kwargs)

1. See StartOnDemandAuditTaskRequestTypeDef

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

1. See StartThingRegistrationTaskResponseTypeDef

# start_thing_registration_task method usage example with argument unpacking

kwargs: StartThingRegistrationTaskRequestTypeDef = {  # (1)
    "templateBody": ...,
    "inputFileBucket": ...,
    "inputFileKey": ...,
    "roleArn": ...,
}

parent.start_thing_registration_task(**kwargs)

1. See StartThingRegistrationTaskRequestTypeDef

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: StopThingRegistrationTaskRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.stop_thing_registration_task(**kwargs)

1. See StopThingRegistrationTaskRequestTypeDef

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]:
    ...

1. See Sequence[TagTypeDef]

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

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

1. See Sequence[AuthInfoUnionTypeDef]
2. See TestAuthorizationResponseTypeDef

# test_authorization method usage example with argument unpacking

kwargs: TestAuthorizationRequestTypeDef = {  # (1)
    "authInfos": ...,
}

parent.test_authorization(**kwargs)

1. See TestAuthorizationRequestTypeDef

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

1. See HttpContextTypeDef
2. See MqttContextTypeDef
3. See TlsContextTypeDef
4. See TestInvokeAuthorizerResponseTypeDef

# test_invoke_authorizer method usage example with argument unpacking

kwargs: TestInvokeAuthorizerRequestTypeDef = {  # (1)
    "authorizerName": ...,
}

parent.test_invoke_authorizer(**kwargs)

1. See TestInvokeAuthorizerRequestTypeDef

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

1. See TransferCertificateResponseTypeDef

# transfer_certificate method usage example with argument unpacking

kwargs: TransferCertificateRequestTypeDef = {  # (1)
    "certificateId": ...,
    "targetAwsAccount": ...,
}

parent.transfer_certificate(**kwargs)

1. See TransferCertificateRequestTypeDef

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: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

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, AuditCheckConfigurationUnionTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See Mapping[Literal['SNS'], AuditNotificationTargetTypeDef]
2. See Mapping[str, AuditCheckConfigurationUnionTypeDef]

# update_account_audit_configuration method usage example with argument unpacking

kwargs: UpdateAccountAuditConfigurationRequestTypeDef = {  # (1)
    "roleArn": ...,
}

parent.update_account_audit_configuration(**kwargs)

1. See UpdateAccountAuditConfigurationRequestTypeDef

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]:
    ...

1. See ResourceIdentifierTypeDef

# update_audit_suppression method usage example with argument unpacking

kwargs: UpdateAuditSuppressionRequestTypeDef = {  # (1)
    "checkName": ...,
    "resourceIdentifier": ...,
}

parent.update_audit_suppression(**kwargs)

1. See UpdateAuditSuppressionRequestTypeDef

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

1. See AuthorizerStatusType
2. See UpdateAuthorizerResponseTypeDef

# update_authorizer method usage example with argument unpacking

kwargs: UpdateAuthorizerRequestTypeDef = {  # (1)
    "authorizerName": ...,
}

parent.update_authorizer(**kwargs)

1. See UpdateAuthorizerRequestTypeDef

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

1. See BillingGroupPropertiesTypeDef
2. See UpdateBillingGroupResponseTypeDef

# update_billing_group method usage example with argument unpacking

kwargs: UpdateBillingGroupRequestTypeDef = {  # (1)
    "billingGroupName": ...,
    "billingGroupProperties": ...,
}

parent.update_billing_group(**kwargs)

1. See UpdateBillingGroupRequestTypeDef

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

1. See CACertificateStatusType
2. See AutoRegistrationStatusType
3. See RegistrationConfigTypeDef
4. See EmptyResponseMetadataTypeDef

# update_ca_certificate method usage example with argument unpacking

kwargs: UpdateCACertificateRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.update_ca_certificate(**kwargs)

1. See UpdateCACertificateRequestTypeDef

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

1. See CertificateStatusType
2. See EmptyResponseMetadataTypeDef

# update_certificate method usage example with argument unpacking

kwargs: UpdateCertificateRequestTypeDef = {  # (1)
    "certificateId": ...,
    "newStatus": ...,
}

parent.update_certificate(**kwargs)

1. See UpdateCertificateRequestTypeDef

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

1. See Sequence[Literal['CreateCertificateFromCsr']]
2. See UpdateCertificateProviderResponseTypeDef

# update_certificate_provider method usage example with argument unpacking

kwargs: UpdateCertificateProviderRequestTypeDef = {  # (1)
    "certificateProviderName": ...,
}

parent.update_certificate_provider(**kwargs)

1. See UpdateCertificateProviderRequestTypeDef

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

1. See UpdateCommandResponseTypeDef

# update_command method usage example with argument unpacking

kwargs: UpdateCommandRequestTypeDef = {  # (1)
    "commandId": ...,
}

parent.update_command(**kwargs)

1. See UpdateCommandRequestTypeDef

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

1. See UpdateCustomMetricResponseTypeDef

# update_custom_metric method usage example with argument unpacking

kwargs: UpdateCustomMetricRequestTypeDef = {  # (1)
    "metricName": ...,
    "displayName": ...,
}

parent.update_custom_metric(**kwargs)

1. See UpdateCustomMetricRequestTypeDef

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

1. See UpdateDimensionResponseTypeDef

# update_dimension method usage example with argument unpacking

kwargs: UpdateDimensionRequestTypeDef = {  # (1)
    "name": ...,
    "stringValues": ...,
}

parent.update_dimension(**kwargs)

1. See UpdateDimensionRequestTypeDef

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

1. See AuthorizerConfigTypeDef
2. See DomainConfigurationStatusType
3. See TlsConfigTypeDef
4. See ServerCertificateConfigTypeDef
5. See AuthenticationTypeType
6. See ApplicationProtocolType
7. See ClientCertificateConfigTypeDef
8. See UpdateDomainConfigurationResponseTypeDef

# update_domain_configuration method usage example with argument unpacking

kwargs: UpdateDomainConfigurationRequestTypeDef = {  # (1)
    "domainConfigurationName": ...,
}

parent.update_domain_configuration(**kwargs)

1. See UpdateDomainConfigurationRequestTypeDef

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: ThingGroupPropertiesUnionTypeDef,  # (1)
    expectedVersion: int = ...,
    indexName: str = ...,
    queryString: str = ...,
    queryVersion: str = ...,
) -> UpdateDynamicThingGroupResponseTypeDef:  # (2)
    ...

1. See ThingGroupPropertiesUnionTypeDef
2. See UpdateDynamicThingGroupResponseTypeDef

# update_dynamic_thing_group method usage example with argument unpacking

kwargs: UpdateDynamicThingGroupRequestTypeDef = {  # (1)
    "thingGroupName": ...,
    "thingGroupProperties": ...,
}

parent.update_dynamic_thing_group(**kwargs)

1. See UpdateDynamicThingGroupRequestTypeDef

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]:
    ...

1. See Mapping[EventTypeType, ConfigurationTypeDef]

# update_event_configurations method usage example with argument unpacking

kwargs: UpdateEventConfigurationsRequestTypeDef = {  # (1)
    "eventConfigurations": ...,
}

parent.update_event_configurations(**kwargs)

1. See UpdateEventConfigurationsRequestTypeDef

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: AggregationTypeUnionTypeDef = ...,  # (1)
    period: int = ...,
    aggregationField: str = ...,
    description: str = ...,
    queryVersion: str = ...,
    unit: FleetMetricUnitType = ...,  # (2)
    expectedVersion: int = ...,
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...

1. See AggregationTypeUnionTypeDef
2. See FleetMetricUnitType
3. See EmptyResponseMetadataTypeDef

# update_fleet_metric method usage example with argument unpacking

kwargs: UpdateFleetMetricRequestTypeDef = {  # (1)
    "metricName": ...,
    "indexName": ...,
}

parent.update_fleet_metric(**kwargs)

1. See UpdateFleetMetricRequestTypeDef

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: ThingIndexingConfigurationUnionTypeDef = ...,  # (1)
    thingGroupIndexingConfiguration: ThingGroupIndexingConfigurationUnionTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...

1. See ThingIndexingConfigurationUnionTypeDef
2. See ThingGroupIndexingConfigurationUnionTypeDef

# update_indexing_configuration method usage example with argument unpacking

kwargs: UpdateIndexingConfigurationRequestTypeDef = {  # (1)
    "thingIndexingConfiguration": ...,
}

parent.update_indexing_configuration(**kwargs)

1. See UpdateIndexingConfigurationRequestTypeDef

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: AbortConfigUnionTypeDef = ...,  # (3)
    timeoutConfig: TimeoutConfigTypeDef = ...,  # (4)
    namespaceId: str = ...,
    jobExecutionsRetryConfig: JobExecutionsRetryConfigUnionTypeDef = ...,  # (5)
) -> EmptyResponseMetadataTypeDef:  # (6)
    ...

1. See PresignedUrlConfigTypeDef
2. See JobExecutionsRolloutConfigTypeDef
3. See AbortConfigUnionTypeDef
4. See TimeoutConfigTypeDef
5. See JobExecutionsRetryConfigUnionTypeDef
6. See EmptyResponseMetadataTypeDef

# update_job method usage example with argument unpacking

kwargs: UpdateJobRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.update_job(**kwargs)

1. See UpdateJobRequestTypeDef

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: MitigationActionParamsUnionTypeDef = ...,  # (1)
) -> UpdateMitigationActionResponseTypeDef:  # (2)
    ...

1. See MitigationActionParamsUnionTypeDef
2. See UpdateMitigationActionResponseTypeDef

# update_mitigation_action method usage example with argument unpacking

kwargs: UpdateMitigationActionRequestTypeDef = {  # (1)
    "actionName": ...,
}

parent.update_mitigation_action(**kwargs)

1. See UpdateMitigationActionRequestTypeDef

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: UpdatePackageRequestTypeDef = {  # (1)
    "packageName": ...,
}

parent.update_package(**kwargs)

1. See UpdatePackageRequestTypeDef

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]:
    ...

1. See VersionUpdateByJobsConfigTypeDef

# update_package_configuration method usage example with argument unpacking

kwargs: UpdatePackageConfigurationRequestTypeDef = {  # (1)
    "versionUpdateByJobsConfig": ...,
}

parent.update_package_configuration(**kwargs)

1. See UpdatePackageConfigurationRequestTypeDef

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]:
    ...

1. See PackageVersionArtifactTypeDef
2. See PackageVersionActionType

# update_package_version method usage example with argument unpacking

kwargs: UpdatePackageVersionRequestTypeDef = {  # (1)
    "packageName": ...,
    "versionName": ...,
}

parent.update_package_version(**kwargs)

1. See UpdatePackageVersionRequestTypeDef

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]:
    ...

1. See ProvisioningHookTypeDef

# update_provisioning_template method usage example with argument unpacking

kwargs: UpdateProvisioningTemplateRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.update_provisioning_template(**kwargs)

1. See UpdateProvisioningTemplateRequestTypeDef

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

1. See UpdateRoleAliasResponseTypeDef

# update_role_alias method usage example with argument unpacking

kwargs: UpdateRoleAliasRequestTypeDef = {  # (1)
    "roleAlias": ...,
}

parent.update_role_alias(**kwargs)

1. See UpdateRoleAliasRequestTypeDef

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

1. See AuditFrequencyType
2. See DayOfWeekType
3. See UpdateScheduledAuditResponseTypeDef

# update_scheduled_audit method usage example with argument unpacking

kwargs: UpdateScheduledAuditRequestTypeDef = {  # (1)
    "scheduledAuditName": ...,
}

parent.update_scheduled_audit(**kwargs)

1. See UpdateScheduledAuditRequestTypeDef

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[BehaviorUnionTypeDef] = ...,  # (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)
    ...

1. See Sequence[BehaviorUnionTypeDef]
2. See Mapping[Literal['SNS'], AlertTargetTypeDef]
3. See Sequence[MetricToRetainTypeDef]
4. See MetricsExportConfigTypeDef
5. See UpdateSecurityProfileResponseTypeDef

# update_security_profile method usage example with argument unpacking

kwargs: UpdateSecurityProfileRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.update_security_profile(**kwargs)

1. See UpdateSecurityProfileRequestTypeDef

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

1. See Sequence[StreamFileTypeDef]
2. See UpdateStreamResponseTypeDef

# update_stream method usage example with argument unpacking

kwargs: UpdateStreamRequestTypeDef = {  # (1)
    "streamId": ...,
}

parent.update_stream(**kwargs)

1. See UpdateStreamRequestTypeDef

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: AttributePayloadUnionTypeDef = ...,  # (1)
    expectedVersion: int = ...,
    removeThingType: bool = ...,
) -> Dict[str, Any]:
    ...

1. See AttributePayloadUnionTypeDef

# update_thing method usage example with argument unpacking

kwargs: UpdateThingRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.update_thing(**kwargs)

1. See UpdateThingRequestTypeDef

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: ThingGroupPropertiesUnionTypeDef,  # (1)
    expectedVersion: int = ...,
) -> UpdateThingGroupResponseTypeDef:  # (2)
    ...

1. See ThingGroupPropertiesUnionTypeDef
2. See UpdateThingGroupResponseTypeDef

# update_thing_group method usage example with argument unpacking

kwargs: UpdateThingGroupRequestTypeDef = {  # (1)
    "thingGroupName": ...,
    "thingGroupProperties": ...,
}

parent.update_thing_group(**kwargs)

1. See UpdateThingGroupRequestTypeDef

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: UpdateThingGroupsForThingRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.update_thing_groups_for_thing(**kwargs)

1. See UpdateThingGroupsForThingRequestTypeDef

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: ThingTypePropertiesUnionTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See ThingTypePropertiesUnionTypeDef

# update_thing_type method usage example with argument unpacking

kwargs: UpdateThingTypeRequestTypeDef = {  # (1)
    "thingTypeName": ...,
}

parent.update_thing_type(**kwargs)

1. See UpdateThingTypeRequestTypeDef

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]:
    ...

1. See TopicRuleDestinationStatusType

# update_topic_rule_destination method usage example with argument unpacking

kwargs: UpdateTopicRuleDestinationRequestTypeDef = {  # (1)
    "arn": ...,
    "status": ...,
}

parent.update_topic_rule_destination(**kwargs)

1. See UpdateTopicRuleDestinationRequestTypeDef

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[BehaviorUnionTypeDef],  # (1)
) -> ValidateSecurityProfileBehaviorsResponseTypeDef:  # (2)
    ...

1. See Sequence[BehaviorUnionTypeDef]
2. See ValidateSecurityProfileBehaviorsResponseTypeDef

# validate_security_profile_behaviors method usage example with argument unpacking

kwargs: ValidateSecurityProfileBehaviorsRequestTypeDef = {  # (1)
    "behaviors": ...,
}

parent.validate_security_profile_behaviors(**kwargs)

1. See ValidateSecurityProfileBehaviorsRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("iot").get_paginator method with overloads.

• client.get_paginator("get_behavior_model_training_summaries") -> GetBehaviorModelTrainingSummariesPaginator
• client.get_paginator("list_active_violations") -> ListActiveViolationsPaginator
• client.get_paginator("list_attached_policies") -> ListAttachedPoliciesPaginator
• client.get_paginator("list_audit_findings") -> ListAuditFindingsPaginator
• client.get_paginator("list_audit_mitigation_actions_executions") -> ListAuditMitigationActionsExecutionsPaginator
• client.get_paginator("list_audit_mitigation_actions_tasks") -> ListAuditMitigationActionsTasksPaginator
• client.get_paginator("list_audit_suppressions") -> ListAuditSuppressionsPaginator
• client.get_paginator("list_audit_tasks") -> ListAuditTasksPaginator
• client.get_paginator("list_authorizers") -> ListAuthorizersPaginator
• client.get_paginator("list_billing_groups") -> ListBillingGroupsPaginator
• client.get_paginator("list_ca_certificates") -> ListCACertificatesPaginator
• client.get_paginator("list_certificates_by_ca") -> ListCertificatesByCAPaginator
• client.get_paginator("list_certificates") -> ListCertificatesPaginator
• client.get_paginator("list_command_executions") -> ListCommandExecutionsPaginator
• client.get_paginator("list_commands") -> ListCommandsPaginator
• client.get_paginator("list_custom_metrics") -> ListCustomMetricsPaginator
• client.get_paginator("list_detect_mitigation_actions_executions") -> ListDetectMitigationActionsExecutionsPaginator
• client.get_paginator("list_detect_mitigation_actions_tasks") -> ListDetectMitigationActionsTasksPaginator
• client.get_paginator("list_dimensions") -> ListDimensionsPaginator
• client.get_paginator("list_domain_configurations") -> ListDomainConfigurationsPaginator
• client.get_paginator("list_fleet_metrics") -> ListFleetMetricsPaginator
• client.get_paginator("list_indices") -> ListIndicesPaginator
• client.get_paginator("list_job_executions_for_job") -> ListJobExecutionsForJobPaginator
• client.get_paginator("list_job_executions_for_thing") -> ListJobExecutionsForThingPaginator
• client.get_paginator("list_job_templates") -> ListJobTemplatesPaginator
• client.get_paginator("list_jobs") -> ListJobsPaginator
• client.get_paginator("list_managed_job_templates") -> ListManagedJobTemplatesPaginator
• client.get_paginator("list_metric_values") -> ListMetricValuesPaginator
• client.get_paginator("list_mitigation_actions") -> ListMitigationActionsPaginator
• client.get_paginator("list_ota_updates") -> ListOTAUpdatesPaginator
• client.get_paginator("list_outgoing_certificates") -> ListOutgoingCertificatesPaginator
• client.get_paginator("list_package_versions") -> ListPackageVersionsPaginator
• client.get_paginator("list_packages") -> ListPackagesPaginator
• client.get_paginator("list_policies") -> ListPoliciesPaginator
• client.get_paginator("list_policy_principals") -> ListPolicyPrincipalsPaginator
• client.get_paginator("list_principal_policies") -> ListPrincipalPoliciesPaginator
• client.get_paginator("list_principal_things") -> ListPrincipalThingsPaginator
• client.get_paginator("list_principal_things_v2") -> ListPrincipalThingsV2Paginator
• client.get_paginator("list_provisioning_template_versions") -> ListProvisioningTemplateVersionsPaginator
• client.get_paginator("list_provisioning_templates") -> ListProvisioningTemplatesPaginator
• client.get_paginator("list_related_resources_for_audit_finding") -> ListRelatedResourcesForAuditFindingPaginator
• client.get_paginator("list_role_aliases") -> ListRoleAliasesPaginator
• client.get_paginator("list_sbom_validation_results") -> ListSbomValidationResultsPaginator
• client.get_paginator("list_scheduled_audits") -> ListScheduledAuditsPaginator
• client.get_paginator("list_security_profiles_for_target") -> ListSecurityProfilesForTargetPaginator
• client.get_paginator("list_security_profiles") -> ListSecurityProfilesPaginator
• client.get_paginator("list_streams") -> ListStreamsPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator
• client.get_paginator("list_targets_for_policy") -> ListTargetsForPolicyPaginator
• client.get_paginator("list_targets_for_security_profile") -> ListTargetsForSecurityProfilePaginator
• client.get_paginator("list_thing_groups_for_thing") -> ListThingGroupsForThingPaginator
• client.get_paginator("list_thing_groups") -> ListThingGroupsPaginator
• client.get_paginator("list_thing_principals") -> ListThingPrincipalsPaginator
• client.get_paginator("list_thing_principals_v2") -> ListThingPrincipalsV2Paginator
• client.get_paginator("list_thing_registration_task_reports") -> ListThingRegistrationTaskReportsPaginator
• client.get_paginator("list_thing_registration_tasks") -> ListThingRegistrationTasksPaginator
• client.get_paginator("list_thing_types") -> ListThingTypesPaginator
• client.get_paginator("list_things_in_billing_group") -> ListThingsInBillingGroupPaginator
• client.get_paginator("list_things_in_thing_group") -> ListThingsInThingGroupPaginator
• client.get_paginator("list_things") -> ListThingsPaginator
• client.get_paginator("list_topic_rule_destinations") -> ListTopicRuleDestinationsPaginator
• client.get_paginator("list_topic_rules") -> ListTopicRulesPaginator
• client.get_paginator("list_v2_logging_levels") -> ListV2LoggingLevelsPaginator
• client.get_paginator("list_violation_events") -> ListViolationEventsPaginator