Skip to content

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

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.

Usage example
client = boto3.client("iot")

try:
    do_something(client)
except (
    client.CertificateConflictException,
    client.CertificateStateException,
    client.CertificateValidationException,
    client.ClientError,
    client.ConflictException,
    client.ConflictingResourceUpdateException,
    client.DeleteConflictException,
    client.IndexNotReadyException,
    client.InternalException,
    client.InternalFailureException,
    client.InternalServerException,
    client.InvalidAggregationException,
    client.InvalidQueryException,
    client.InvalidRequestException,
    client.InvalidResponseException,
    client.InvalidStateTransitionException,
    client.LimitExceededException,
    client.MalformedPolicyException,
    client.NotConfiguredException,
    client.RegistrationCodeValidationException,
    client.ResourceAlreadyExistsException,
    client.ResourceNotFoundException,
    client.ResourceRegistrationFailureException,
    client.ServiceUnavailableException,
    client.SqlParseException,
    client.TaskAlreadyExistsException,
    client.ThrottlingException,
    client.TransferAlreadyCompletedException,
    client.TransferConflictException,
    client.UnauthorizedException,
    client.VersionConflictException,
    client.VersionsLimitExceededException,
) as e:
    print(e)
Type checking example
from mypy_boto3_iot.client import Exceptions

def handle_error(exc: Exceptions.CertificateConflictException) -> None:
    ...

Methods

accept_certificate_transfer

Accepts a pending certificate transfer.

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

Method definition
def accept_certificate_transfer(
    self,
    *,
    certificateId: str,
    setAsActive: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AcceptCertificateTransferRequestRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.accept_certificate_transfer(**kwargs)
  1. See AcceptCertificateTransferRequestRequestTypeDef

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

Method definition
def add_thing_to_billing_group(
    self,
    *,
    billingGroupName: str = ...,
    billingGroupArn: str = ...,
    thingName: str = ...,
    thingArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AddThingToBillingGroupRequestRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.add_thing_to_billing_group(**kwargs)
  1. See AddThingToBillingGroupRequestRequestTypeDef

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

Method definition
def add_thing_to_thing_group(
    self,
    *,
    thingGroupName: str = ...,
    thingGroupArn: str = ...,
    thingName: str = ...,
    thingArn: str = ...,
    overrideDynamicGroups: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AddThingToThingGroupRequestRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.add_thing_to_thing_group(**kwargs)
  1. See AddThingToThingGroupRequestRequestTypeDef

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

Method definition
def associate_targets_with_job(
    self,
    *,
    targets: Sequence[str],
    jobId: str,
    comment: str = ...,
    namespaceId: str = ...,
) -> AssociateTargetsWithJobResponseTypeDef:  # (1)
    ...
  1. See AssociateTargetsWithJobResponseTypeDef
Usage example with kwargs
kwargs: AssociateTargetsWithJobRequestRequestTypeDef = {  # (1)
    "targets": ...,
    "jobId": ...,
}

parent.associate_targets_with_job(**kwargs)
  1. See AssociateTargetsWithJobRequestRequestTypeDef

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

Method definition
def attach_policy(
    self,
    *,
    policyName: str,
    target: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AttachPolicyRequestRequestTypeDef = {  # (1)
    "policyName": ...,
    "target": ...,
}

parent.attach_policy(**kwargs)
  1. See AttachPolicyRequestRequestTypeDef

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

Method definition
def attach_principal_policy(
    self,
    *,
    policyName: str,
    principal: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AttachPrincipalPolicyRequestRequestTypeDef = {  # (1)
    "policyName": ...,
    "principal": ...,
}

parent.attach_principal_policy(**kwargs)
  1. See AttachPrincipalPolicyRequestRequestTypeDef

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

Method definition
def attach_security_profile(
    self,
    *,
    securityProfileName: str,
    securityProfileTargetArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AttachSecurityProfileRequestRequestTypeDef = {  # (1)
    "securityProfileName": ...,
    "securityProfileTargetArn": ...,
}

parent.attach_security_profile(**kwargs)
  1. See AttachSecurityProfileRequestRequestTypeDef

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

Method definition
def attach_thing_principal(
    self,
    *,
    thingName: str,
    principal: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: AttachThingPrincipalRequestRequestTypeDef = {  # (1)
    "thingName": ...,
    "principal": ...,
}

parent.attach_thing_principal(**kwargs)
  1. See AttachThingPrincipalRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

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

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

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

Method definition
def cancel_audit_mitigation_actions_task(
    self,
    *,
    taskId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CancelAuditMitigationActionsTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.cancel_audit_mitigation_actions_task(**kwargs)
  1. See CancelAuditMitigationActionsTaskRequestRequestTypeDef

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

Method definition
def cancel_audit_task(
    self,
    *,
    taskId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CancelAuditTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.cancel_audit_task(**kwargs)
  1. See CancelAuditTaskRequestRequestTypeDef

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

Method definition
def cancel_certificate_transfer(
    self,
    *,
    certificateId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: CancelCertificateTransferRequestRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.cancel_certificate_transfer(**kwargs)
  1. See CancelCertificateTransferRequestRequestTypeDef

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

Method definition
def cancel_detect_mitigation_actions_task(
    self,
    *,
    taskId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CancelDetectMitigationActionsTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.cancel_detect_mitigation_actions_task(**kwargs)
  1. See CancelDetectMitigationActionsTaskRequestRequestTypeDef

cancel_job

Cancels a job.

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

Method definition
def cancel_job(
    self,
    *,
    jobId: str,
    reasonCode: str = ...,
    comment: str = ...,
    force: bool = ...,
) -> CancelJobResponseTypeDef:  # (1)
    ...
  1. See CancelJobResponseTypeDef
Usage example with kwargs
kwargs: CancelJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.cancel_job(**kwargs)
  1. See CancelJobRequestRequestTypeDef

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

Method definition
def cancel_job_execution(
    self,
    *,
    jobId: str,
    thingName: str,
    force: bool = ...,
    expectedVersion: int = ...,
    statusDetails: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: CancelJobExecutionRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "thingName": ...,
}

parent.cancel_job_execution(**kwargs)
  1. See CancelJobExecutionRequestRequestTypeDef

clear_default_authorizer

Clears the default authorizer.

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

Method definition
def clear_default_authorizer(
    self,
) -> Dict[str, Any]:
    ...

close

Closes underlying endpoint connections.

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

Method definition
def close(
    self,
) -> None:
    ...

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

Method definition
def confirm_topic_rule_destination(
    self,
    *,
    confirmationToken: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: ConfirmTopicRuleDestinationRequestRequestTypeDef = {  # (1)
    "confirmationToken": ...,
}

parent.confirm_topic_rule_destination(**kwargs)
  1. See ConfirmTopicRuleDestinationRequestRequestTypeDef

create_audit_suppression

Creates a Device Defender audit suppression.

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

Method definition
def create_audit_suppression(
    self,
    *,
    checkName: str,
    resourceIdentifier: ResourceIdentifierTypeDef,  # (1)
    clientRequestToken: str,
    expirationDate: Union[datetime, str] = ...,
    suppressIndefinitely: bool = ...,
    description: str = ...,
) -> Dict[str, Any]:
    ...
  1. See ResourceIdentifierTypeDef
Usage example with kwargs
kwargs: CreateAuditSuppressionRequestRequestTypeDef = {  # (1)
    "checkName": ...,
    "resourceIdentifier": ...,
    "clientRequestToken": ...,
}

parent.create_audit_suppression(**kwargs)
  1. See CreateAuditSuppressionRequestRequestTypeDef

create_authorizer

Creates an authorizer.

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

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 TagTypeDef
  3. See CreateAuthorizerResponseTypeDef
Usage example with kwargs
kwargs: CreateAuthorizerRequestRequestTypeDef = {  # (1)
    "authorizerName": ...,
    "authorizerFunctionArn": ...,
}

parent.create_authorizer(**kwargs)
  1. See CreateAuthorizerRequestRequestTypeDef

create_billing_group

Creates a billing group.

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

Method definition
def create_billing_group(
    self,
    *,
    billingGroupName: str,
    billingGroupProperties: BillingGroupPropertiesTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateBillingGroupResponseTypeDef:  # (3)
    ...
  1. See BillingGroupPropertiesTypeDef
  2. See TagTypeDef
  3. See CreateBillingGroupResponseTypeDef
Usage example with kwargs
kwargs: CreateBillingGroupRequestRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.create_billing_group(**kwargs)
  1. See CreateBillingGroupRequestRequestTypeDef

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

Method definition
def create_certificate_from_csr(
    self,
    *,
    certificateSigningRequest: str,
    setAsActive: bool = ...,
) -> CreateCertificateFromCsrResponseTypeDef:  # (1)
    ...
  1. See CreateCertificateFromCsrResponseTypeDef
Usage example with kwargs
kwargs: CreateCertificateFromCsrRequestRequestTypeDef = {  # (1)
    "certificateSigningRequest": ...,
}

parent.create_certificate_from_csr(**kwargs)
  1. See CreateCertificateFromCsrRequestRequestTypeDef

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

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 TagTypeDef
  3. See CreateCustomMetricResponseTypeDef
Usage example with kwargs
kwargs: CreateCustomMetricRequestRequestTypeDef = {  # (1)
    "metricName": ...,
    "metricType": ...,
    "clientRequestToken": ...,
}

parent.create_custom_metric(**kwargs)
  1. See CreateCustomMetricRequestRequestTypeDef

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

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 TagTypeDef
  3. See CreateDimensionResponseTypeDef
Usage example with kwargs
kwargs: CreateDimensionRequestRequestTypeDef = {  # (1)
    "name": ...,
    "type": ...,
    "stringValues": ...,
    "clientRequestToken": ...,
}

parent.create_dimension(**kwargs)
  1. See CreateDimensionRequestRequestTypeDef

create_domain_configuration

Creates a domain configuration.

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

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)
) -> CreateDomainConfigurationResponseTypeDef:  # (4)
    ...
  1. See AuthorizerConfigTypeDef
  2. See ServiceTypeType
  3. See TagTypeDef
  4. See CreateDomainConfigurationResponseTypeDef
Usage example with kwargs
kwargs: CreateDomainConfigurationRequestRequestTypeDef = {  # (1)
    "domainConfigurationName": ...,
}

parent.create_domain_configuration(**kwargs)
  1. See CreateDomainConfigurationRequestRequestTypeDef

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

Method definition
def create_dynamic_thing_group(
    self,
    *,
    thingGroupName: str,
    queryString: str,
    thingGroupProperties: ThingGroupPropertiesTypeDef = ...,  # (1)
    indexName: str = ...,
    queryVersion: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateDynamicThingGroupResponseTypeDef:  # (3)
    ...
  1. See ThingGroupPropertiesTypeDef
  2. See TagTypeDef
  3. See CreateDynamicThingGroupResponseTypeDef
Usage example with kwargs
kwargs: CreateDynamicThingGroupRequestRequestTypeDef = {  # (1)
    "thingGroupName": ...,
    "queryString": ...,
}

parent.create_dynamic_thing_group(**kwargs)
  1. See CreateDynamicThingGroupRequestRequestTypeDef

create_fleet_metric

Creates a fleet metric.

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

Method definition
def create_fleet_metric(
    self,
    *,
    metricName: str,
    queryString: str,
    aggregationType: AggregationTypeTypeDef,  # (1)
    period: int,
    aggregationField: str,
    description: str = ...,
    queryVersion: str = ...,
    indexName: str = ...,
    unit: FleetMetricUnitType = ...,  # (2)
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateFleetMetricResponseTypeDef:  # (4)
    ...
  1. See AggregationTypeTypeDef
  2. See FleetMetricUnitType
  3. See TagTypeDef
  4. See CreateFleetMetricResponseTypeDef
Usage example with kwargs
kwargs: CreateFleetMetricRequestRequestTypeDef = {  # (1)
    "metricName": ...,
    "queryString": ...,
    "aggregationType": ...,
    "period": ...,
    "aggregationField": ...,
}

parent.create_fleet_metric(**kwargs)
  1. See CreateFleetMetricRequestRequestTypeDef

create_job

Creates a job.

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

Method definition
def create_job(
    self,
    *,
    jobId: str,
    targets: Sequence[str],
    documentSource: str = ...,
    document: str = ...,
    description: str = ...,
    presignedUrlConfig: PresignedUrlConfigTypeDef = ...,  # (1)
    targetSelection: TargetSelectionType = ...,  # (2)
    jobExecutionsRolloutConfig: JobExecutionsRolloutConfigTypeDef = ...,  # (3)
    abortConfig: AbortConfigTypeDef = ...,  # (4)
    timeoutConfig: TimeoutConfigTypeDef = ...,  # (5)
    tags: Sequence[TagTypeDef] = ...,  # (6)
    namespaceId: str = ...,
    jobTemplateArn: str = ...,
    jobExecutionsRetryConfig: JobExecutionsRetryConfigTypeDef = ...,  # (7)
    documentParameters: Mapping[str, str] = ...,
    schedulingConfig: SchedulingConfigTypeDef = ...,  # (8)
) -> CreateJobResponseTypeDef:  # (9)
    ...
  1. See PresignedUrlConfigTypeDef
  2. See TargetSelectionType
  3. See JobExecutionsRolloutConfigTypeDef
  4. See AbortConfigTypeDef
  5. See TimeoutConfigTypeDef
  6. See TagTypeDef
  7. See JobExecutionsRetryConfigTypeDef
  8. See SchedulingConfigTypeDef
  9. See CreateJobResponseTypeDef
Usage example with kwargs
kwargs: CreateJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "targets": ...,
}

parent.create_job(**kwargs)
  1. See CreateJobRequestRequestTypeDef

create_job_template

Creates a job template.

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

Method definition
def create_job_template(
    self,
    *,
    jobTemplateId: str,
    description: str,
    jobArn: str = ...,
    documentSource: str = ...,
    document: str = ...,
    presignedUrlConfig: PresignedUrlConfigTypeDef = ...,  # (1)
    jobExecutionsRolloutConfig: JobExecutionsRolloutConfigTypeDef = ...,  # (2)
    abortConfig: AbortConfigTypeDef = ...,  # (3)
    timeoutConfig: TimeoutConfigTypeDef = ...,  # (4)
    tags: Sequence[TagTypeDef] = ...,  # (5)
    jobExecutionsRetryConfig: JobExecutionsRetryConfigTypeDef = ...,  # (6)
    maintenanceWindows: Sequence[MaintenanceWindowTypeDef] = ...,  # (7)
) -> CreateJobTemplateResponseTypeDef:  # (8)
    ...
  1. See PresignedUrlConfigTypeDef
  2. See JobExecutionsRolloutConfigTypeDef
  3. See AbortConfigTypeDef
  4. See TimeoutConfigTypeDef
  5. See TagTypeDef
  6. See JobExecutionsRetryConfigTypeDef
  7. See MaintenanceWindowTypeDef
  8. See CreateJobTemplateResponseTypeDef
Usage example with kwargs
kwargs: CreateJobTemplateRequestRequestTypeDef = {  # (1)
    "jobTemplateId": ...,
    "description": ...,
}

parent.create_job_template(**kwargs)
  1. See CreateJobTemplateRequestRequestTypeDef

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

Method definition
def create_keys_and_certificate(
    self,
    *,
    setAsActive: bool = ...,
) -> CreateKeysAndCertificateResponseTypeDef:  # (1)
    ...
  1. See CreateKeysAndCertificateResponseTypeDef
Usage example with kwargs
kwargs: CreateKeysAndCertificateRequestRequestTypeDef = {  # (1)
    "setAsActive": ...,
}

parent.create_keys_and_certificate(**kwargs)
  1. See CreateKeysAndCertificateRequestRequestTypeDef

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

Method definition
def create_mitigation_action(
    self,
    *,
    actionName: str,
    roleArn: str,
    actionParams: MitigationActionParamsTypeDef,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateMitigationActionResponseTypeDef:  # (3)
    ...
  1. See MitigationActionParamsTypeDef
  2. See TagTypeDef
  3. See CreateMitigationActionResponseTypeDef
Usage example with kwargs
kwargs: CreateMitigationActionRequestRequestTypeDef = {  # (1)
    "actionName": ...,
    "roleArn": ...,
    "actionParams": ...,
}

parent.create_mitigation_action(**kwargs)
  1. See CreateMitigationActionRequestRequestTypeDef

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

Method definition
def create_ota_update(
    self,
    *,
    otaUpdateId: str,
    targets: Sequence[str],
    files: Sequence[OTAUpdateFileTypeDef],  # (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 OTAUpdateFileTypeDef
  2. See ProtocolType
  3. See TargetSelectionType
  4. See AwsJobExecutionsRolloutConfigTypeDef
  5. See AwsJobPresignedUrlConfigTypeDef
  6. See AwsJobAbortConfigTypeDef
  7. See AwsJobTimeoutConfigTypeDef
  8. See TagTypeDef
  9. See CreateOTAUpdateResponseTypeDef
Usage example with kwargs
kwargs: CreateOTAUpdateRequestRequestTypeDef = {  # (1)
    "otaUpdateId": ...,
    "targets": ...,
    "files": ...,
    "roleArn": ...,
}

parent.create_ota_update(**kwargs)
  1. See CreateOTAUpdateRequestRequestTypeDef

create_policy

Creates an IoT policy.

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

Method definition
def create_policy(
    self,
    *,
    policyName: str,
    policyDocument: str,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreatePolicyResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreatePolicyResponseTypeDef
Usage example with kwargs
kwargs: CreatePolicyRequestRequestTypeDef = {  # (1)
    "policyName": ...,
    "policyDocument": ...,
}

parent.create_policy(**kwargs)
  1. See CreatePolicyRequestRequestTypeDef

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

Method definition
def create_policy_version(
    self,
    *,
    policyName: str,
    policyDocument: str,
    setAsDefault: bool = ...,
) -> CreatePolicyVersionResponseTypeDef:  # (1)
    ...
  1. See CreatePolicyVersionResponseTypeDef
Usage example with kwargs
kwargs: CreatePolicyVersionRequestRequestTypeDef = {  # (1)
    "policyName": ...,
    "policyDocument": ...,
}

parent.create_policy_version(**kwargs)
  1. See CreatePolicyVersionRequestRequestTypeDef

create_provisioning_claim

Creates a provisioning claim.

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

Method definition
def create_provisioning_claim(
    self,
    *,
    templateName: str,
) -> CreateProvisioningClaimResponseTypeDef:  # (1)
    ...
  1. See CreateProvisioningClaimResponseTypeDef
Usage example with kwargs
kwargs: CreateProvisioningClaimRequestRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.create_provisioning_claim(**kwargs)
  1. See CreateProvisioningClaimRequestRequestTypeDef

create_provisioning_template

Creates a provisioning template.

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

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 TagTypeDef
  3. See TemplateTypeType
  4. See CreateProvisioningTemplateResponseTypeDef
Usage example with kwargs
kwargs: CreateProvisioningTemplateRequestRequestTypeDef = {  # (1)
    "templateName": ...,
    "templateBody": ...,
    "provisioningRoleArn": ...,
}

parent.create_provisioning_template(**kwargs)
  1. See CreateProvisioningTemplateRequestRequestTypeDef

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

Method definition
def create_provisioning_template_version(
    self,
    *,
    templateName: str,
    templateBody: str,
    setAsDefault: bool = ...,
) -> CreateProvisioningTemplateVersionResponseTypeDef:  # (1)
    ...
  1. See CreateProvisioningTemplateVersionResponseTypeDef
Usage example with kwargs
kwargs: CreateProvisioningTemplateVersionRequestRequestTypeDef = {  # (1)
    "templateName": ...,
    "templateBody": ...,
}

parent.create_provisioning_template_version(**kwargs)
  1. See CreateProvisioningTemplateVersionRequestRequestTypeDef

create_role_alias

Creates a role alias.

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

Method definition
def create_role_alias(
    self,
    *,
    roleAlias: str,
    roleArn: str,
    credentialDurationSeconds: int = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateRoleAliasResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateRoleAliasResponseTypeDef
Usage example with kwargs
kwargs: CreateRoleAliasRequestRequestTypeDef = {  # (1)
    "roleAlias": ...,
    "roleArn": ...,
}

parent.create_role_alias(**kwargs)
  1. See CreateRoleAliasRequestRequestTypeDef

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

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 TagTypeDef
  4. See CreateScheduledAuditResponseTypeDef
Usage example with kwargs
kwargs: CreateScheduledAuditRequestRequestTypeDef = {  # (1)
    "frequency": ...,
    "targetCheckNames": ...,
    "scheduledAuditName": ...,
}

parent.create_scheduled_audit(**kwargs)
  1. See CreateScheduledAuditRequestRequestTypeDef

create_security_profile

Creates a Device Defender security profile.

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

Method definition
def create_security_profile(
    self,
    *,
    securityProfileName: str,
    securityProfileDescription: str = ...,
    behaviors: Sequence[BehaviorTypeDef] = ...,  # (1)
    alertTargets: Mapping[AlertTargetTypeType, AlertTargetTypeDef] = ...,  # (2)
    additionalMetricsToRetain: Sequence[str] = ...,
    additionalMetricsToRetainV2: Sequence[MetricToRetainTypeDef] = ...,  # (3)
    tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateSecurityProfileResponseTypeDef:  # (5)
    ...
  1. See BehaviorTypeDef
  2. See AlertTargetTypeType AlertTargetTypeDef
  3. See MetricToRetainTypeDef
  4. See TagTypeDef
  5. See CreateSecurityProfileResponseTypeDef
Usage example with kwargs
kwargs: CreateSecurityProfileRequestRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.create_security_profile(**kwargs)
  1. See CreateSecurityProfileRequestRequestTypeDef

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

Method definition
def create_stream(
    self,
    *,
    streamId: str,
    files: Sequence[StreamFileTypeDef],  # (1)
    roleArn: str,
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateStreamResponseTypeDef:  # (3)
    ...
  1. See StreamFileTypeDef
  2. See TagTypeDef
  3. See CreateStreamResponseTypeDef
Usage example with kwargs
kwargs: CreateStreamRequestRequestTypeDef = {  # (1)
    "streamId": ...,
    "files": ...,
    "roleArn": ...,
}

parent.create_stream(**kwargs)
  1. See CreateStreamRequestRequestTypeDef

create_thing

Creates a thing record in the registry.

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

Method definition
def create_thing(
    self,
    *,
    thingName: str,
    thingTypeName: str = ...,
    attributePayload: AttributePayloadTypeDef = ...,  # (1)
    billingGroupName: str = ...,
) -> CreateThingResponseTypeDef:  # (2)
    ...
  1. See AttributePayloadTypeDef
  2. See CreateThingResponseTypeDef
Usage example with kwargs
kwargs: CreateThingRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.create_thing(**kwargs)
  1. See CreateThingRequestRequestTypeDef

create_thing_group

Create a thing group.

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

Method definition
def create_thing_group(
    self,
    *,
    thingGroupName: str,
    parentGroupName: str = ...,
    thingGroupProperties: ThingGroupPropertiesTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateThingGroupResponseTypeDef:  # (3)
    ...
  1. See ThingGroupPropertiesTypeDef
  2. See TagTypeDef
  3. See CreateThingGroupResponseTypeDef
Usage example with kwargs
kwargs: CreateThingGroupRequestRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.create_thing_group(**kwargs)
  1. See CreateThingGroupRequestRequestTypeDef

create_thing_type

Creates a new thing type.

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

Method definition
def create_thing_type(
    self,
    *,
    thingTypeName: str,
    thingTypeProperties: ThingTypePropertiesTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateThingTypeResponseTypeDef:  # (3)
    ...
  1. See ThingTypePropertiesTypeDef
  2. See TagTypeDef
  3. See CreateThingTypeResponseTypeDef
Usage example with kwargs
kwargs: CreateThingTypeRequestRequestTypeDef = {  # (1)
    "thingTypeName": ...,
}

parent.create_thing_type(**kwargs)
  1. See CreateThingTypeRequestRequestTypeDef

create_topic_rule

Creates a rule.

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

Method definition
def create_topic_rule(
    self,
    *,
    ruleName: str,
    topicRulePayload: TopicRulePayloadTypeDef,  # (1)
    tags: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TopicRulePayloadTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: CreateTopicRuleRequestRequestTypeDef = {  # (1)
    "ruleName": ...,
    "topicRulePayload": ...,
}

parent.create_topic_rule(**kwargs)
  1. See CreateTopicRuleRequestRequestTypeDef

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

Method definition
def create_topic_rule_destination(
    self,
    *,
    destinationConfiguration: TopicRuleDestinationConfigurationTypeDef,  # (1)
) -> CreateTopicRuleDestinationResponseTypeDef:  # (2)
    ...
  1. See TopicRuleDestinationConfigurationTypeDef
  2. See CreateTopicRuleDestinationResponseTypeDef
Usage example with kwargs
kwargs: CreateTopicRuleDestinationRequestRequestTypeDef = {  # (1)
    "destinationConfiguration": ...,
}

parent.create_topic_rule_destination(**kwargs)
  1. See CreateTopicRuleDestinationRequestRequestTypeDef

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

Method definition
def delete_account_audit_configuration(
    self,
    *,
    deleteScheduledAudits: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAccountAuditConfigurationRequestRequestTypeDef = {  # (1)
    "deleteScheduledAudits": ...,
}

parent.delete_account_audit_configuration(**kwargs)
  1. See DeleteAccountAuditConfigurationRequestRequestTypeDef

delete_audit_suppression

Deletes a Device Defender audit suppression.

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

Method definition
def delete_audit_suppression(
    self,
    *,
    checkName: str,
    resourceIdentifier: ResourceIdentifierTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ResourceIdentifierTypeDef
Usage example with kwargs
kwargs: DeleteAuditSuppressionRequestRequestTypeDef = {  # (1)
    "checkName": ...,
    "resourceIdentifier": ...,
}

parent.delete_audit_suppression(**kwargs)
  1. See DeleteAuditSuppressionRequestRequestTypeDef

delete_authorizer

Deletes an authorizer.

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

Method definition
def delete_authorizer(
    self,
    *,
    authorizerName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAuthorizerRequestRequestTypeDef = {  # (1)
    "authorizerName": ...,
}

parent.delete_authorizer(**kwargs)
  1. See DeleteAuthorizerRequestRequestTypeDef

delete_billing_group

Deletes the billing group.

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

Method definition
def delete_billing_group(
    self,
    *,
    billingGroupName: str,
    expectedVersion: int = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteBillingGroupRequestRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.delete_billing_group(**kwargs)
  1. See DeleteBillingGroupRequestRequestTypeDef

delete_ca_certificate

Deletes a registered CA certificate.

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

Method definition
def delete_ca_certificate(
    self,
    *,
    certificateId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteCACertificateRequestRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.delete_ca_certificate(**kwargs)
  1. See DeleteCACertificateRequestRequestTypeDef

delete_certificate

Deletes the specified certificate.

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

Method definition
def delete_certificate(
    self,
    *,
    certificateId: str,
    forceDelete: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteCertificateRequestRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.delete_certificate(**kwargs)
  1. See DeleteCertificateRequestRequestTypeDef

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

Method definition
def delete_custom_metric(
    self,
    *,
    metricName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteCustomMetricRequestRequestTypeDef = {  # (1)
    "metricName": ...,
}

parent.delete_custom_metric(**kwargs)
  1. See DeleteCustomMetricRequestRequestTypeDef

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

Method definition
def delete_dimension(
    self,
    *,
    name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDimensionRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.delete_dimension(**kwargs)
  1. See DeleteDimensionRequestRequestTypeDef

delete_domain_configuration

Deletes the specified domain configuration.

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

Method definition
def delete_domain_configuration(
    self,
    *,
    domainConfigurationName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDomainConfigurationRequestRequestTypeDef = {  # (1)
    "domainConfigurationName": ...,
}

parent.delete_domain_configuration(**kwargs)
  1. See DeleteDomainConfigurationRequestRequestTypeDef

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

Method definition
def delete_dynamic_thing_group(
    self,
    *,
    thingGroupName: str,
    expectedVersion: int = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDynamicThingGroupRequestRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.delete_dynamic_thing_group(**kwargs)
  1. See DeleteDynamicThingGroupRequestRequestTypeDef

delete_fleet_metric

Deletes the specified fleet metric.

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

Method definition
def delete_fleet_metric(
    self,
    *,
    metricName: str,
    expectedVersion: int = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteFleetMetricRequestRequestTypeDef = {  # (1)
    "metricName": ...,
}

parent.delete_fleet_metric(**kwargs)
  1. See DeleteFleetMetricRequestRequestTypeDef

delete_job

Deletes a job and its related job executions.

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

Method definition
def delete_job(
    self,
    *,
    jobId: str,
    force: bool = ...,
    namespaceId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.delete_job(**kwargs)
  1. See DeleteJobRequestRequestTypeDef

delete_job_execution

Deletes a job execution.

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

Method definition
def delete_job_execution(
    self,
    *,
    jobId: str,
    thingName: str,
    executionNumber: int,
    force: bool = ...,
    namespaceId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteJobExecutionRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "thingName": ...,
    "executionNumber": ...,
}

parent.delete_job_execution(**kwargs)
  1. See DeleteJobExecutionRequestRequestTypeDef

delete_job_template

Deletes the specified job template.

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

Method definition
def delete_job_template(
    self,
    *,
    jobTemplateId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteJobTemplateRequestRequestTypeDef = {  # (1)
    "jobTemplateId": ...,
}

parent.delete_job_template(**kwargs)
  1. See DeleteJobTemplateRequestRequestTypeDef

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

Method definition
def delete_mitigation_action(
    self,
    *,
    actionName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteMitigationActionRequestRequestTypeDef = {  # (1)
    "actionName": ...,
}

parent.delete_mitigation_action(**kwargs)
  1. See DeleteMitigationActionRequestRequestTypeDef

delete_ota_update

Delete an OTA update.

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

Method definition
def delete_ota_update(
    self,
    *,
    otaUpdateId: str,
    deleteStream: bool = ...,
    forceDeleteAWSJob: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteOTAUpdateRequestRequestTypeDef = {  # (1)
    "otaUpdateId": ...,
}

parent.delete_ota_update(**kwargs)
  1. See DeleteOTAUpdateRequestRequestTypeDef

delete_policy

Deletes the specified policy.

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

Method definition
def delete_policy(
    self,
    *,
    policyName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeletePolicyRequestRequestTypeDef = {  # (1)
    "policyName": ...,
}

parent.delete_policy(**kwargs)
  1. See DeletePolicyRequestRequestTypeDef

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

Method definition
def delete_policy_version(
    self,
    *,
    policyName: str,
    policyVersionId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeletePolicyVersionRequestRequestTypeDef = {  # (1)
    "policyName": ...,
    "policyVersionId": ...,
}

parent.delete_policy_version(**kwargs)
  1. See DeletePolicyVersionRequestRequestTypeDef

delete_provisioning_template

Deletes a provisioning template.

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

Method definition
def delete_provisioning_template(
    self,
    *,
    templateName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteProvisioningTemplateRequestRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.delete_provisioning_template(**kwargs)
  1. See DeleteProvisioningTemplateRequestRequestTypeDef

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

Method definition
def delete_provisioning_template_version(
    self,
    *,
    templateName: str,
    versionId: int,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteProvisioningTemplateVersionRequestRequestTypeDef = {  # (1)
    "templateName": ...,
    "versionId": ...,
}

parent.delete_provisioning_template_version(**kwargs)
  1. See DeleteProvisioningTemplateVersionRequestRequestTypeDef

delete_registration_code

Deletes a CA certificate registration code.

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

Method definition
def delete_registration_code(
    self,
) -> Dict[str, Any]:
    ...

delete_role_alias

Deletes a role alias Requires permission to access the DeleteRoleAlias_ action.

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

Method definition
def delete_role_alias(
    self,
    *,
    roleAlias: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteRoleAliasRequestRequestTypeDef = {  # (1)
    "roleAlias": ...,
}

parent.delete_role_alias(**kwargs)
  1. See DeleteRoleAliasRequestRequestTypeDef

delete_scheduled_audit

Deletes a scheduled audit.

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

Method definition
def delete_scheduled_audit(
    self,
    *,
    scheduledAuditName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteScheduledAuditRequestRequestTypeDef = {  # (1)
    "scheduledAuditName": ...,
}

parent.delete_scheduled_audit(**kwargs)
  1. See DeleteScheduledAuditRequestRequestTypeDef

delete_security_profile

Deletes a Device Defender security profile.

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

Method definition
def delete_security_profile(
    self,
    *,
    securityProfileName: str,
    expectedVersion: int = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteSecurityProfileRequestRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.delete_security_profile(**kwargs)
  1. See DeleteSecurityProfileRequestRequestTypeDef

delete_stream

Deletes a stream.

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

Method definition
def delete_stream(
    self,
    *,
    streamId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteStreamRequestRequestTypeDef = {  # (1)
    "streamId": ...,
}

parent.delete_stream(**kwargs)
  1. See DeleteStreamRequestRequestTypeDef

delete_thing

Deletes the specified thing.

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

Method definition
def delete_thing(
    self,
    *,
    thingName: str,
    expectedVersion: int = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteThingRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.delete_thing(**kwargs)
  1. See DeleteThingRequestRequestTypeDef

delete_thing_group

Deletes a thing group.

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

Method definition
def delete_thing_group(
    self,
    *,
    thingGroupName: str,
    expectedVersion: int = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteThingGroupRequestRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.delete_thing_group(**kwargs)
  1. See DeleteThingGroupRequestRequestTypeDef

delete_thing_type

Deletes the specified thing type.

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

Method definition
def delete_thing_type(
    self,
    *,
    thingTypeName: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteThingTypeRequestRequestTypeDef = {  # (1)
    "thingTypeName": ...,
}

parent.delete_thing_type(**kwargs)
  1. See DeleteThingTypeRequestRequestTypeDef

delete_topic_rule

Deletes the rule.

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

Method definition
def delete_topic_rule(
    self,
    *,
    ruleName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteTopicRuleRequestRequestTypeDef = {  # (1)
    "ruleName": ...,
}

parent.delete_topic_rule(**kwargs)
  1. See DeleteTopicRuleRequestRequestTypeDef

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

Method definition
def delete_topic_rule_destination(
    self,
    *,
    arn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteTopicRuleDestinationRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_topic_rule_destination(**kwargs)
  1. See DeleteTopicRuleDestinationRequestRequestTypeDef

delete_v2_logging_level

Deletes a logging level.

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

Method definition
def delete_v2_logging_level(
    self,
    *,
    targetType: LogTargetTypeType,  # (1)
    targetName: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See LogTargetTypeType
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteV2LoggingLevelRequestRequestTypeDef = {  # (1)
    "targetType": ...,
    "targetName": ...,
}

parent.delete_v2_logging_level(**kwargs)
  1. See DeleteV2LoggingLevelRequestRequestTypeDef

deprecate_thing_type

Deprecates a thing type.

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

Method definition
def deprecate_thing_type(
    self,
    *,
    thingTypeName: str,
    undoDeprecate: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeprecateThingTypeRequestRequestTypeDef = {  # (1)
    "thingTypeName": ...,
}

parent.deprecate_thing_type(**kwargs)
  1. See DeprecateThingTypeRequestRequestTypeDef

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

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

Method definition
def describe_audit_finding(
    self,
    *,
    findingId: str,
) -> DescribeAuditFindingResponseTypeDef:  # (1)
    ...
  1. See DescribeAuditFindingResponseTypeDef
Usage example with kwargs
kwargs: DescribeAuditFindingRequestRequestTypeDef = {  # (1)
    "findingId": ...,
}

parent.describe_audit_finding(**kwargs)
  1. See DescribeAuditFindingRequestRequestTypeDef

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

Method definition
def describe_audit_mitigation_actions_task(
    self,
    *,
    taskId: str,
) -> DescribeAuditMitigationActionsTaskResponseTypeDef:  # (1)
    ...
  1. See DescribeAuditMitigationActionsTaskResponseTypeDef
Usage example with kwargs
kwargs: DescribeAuditMitigationActionsTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.describe_audit_mitigation_actions_task(**kwargs)
  1. See DescribeAuditMitigationActionsTaskRequestRequestTypeDef

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

Method definition
def describe_audit_suppression(
    self,
    *,
    checkName: str,
    resourceIdentifier: ResourceIdentifierTypeDef,  # (1)
) -> DescribeAuditSuppressionResponseTypeDef:  # (2)
    ...
  1. See ResourceIdentifierTypeDef
  2. See DescribeAuditSuppressionResponseTypeDef
Usage example with kwargs
kwargs: DescribeAuditSuppressionRequestRequestTypeDef = {  # (1)
    "checkName": ...,
    "resourceIdentifier": ...,
}

parent.describe_audit_suppression(**kwargs)
  1. See DescribeAuditSuppressionRequestRequestTypeDef

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

Method definition
def describe_audit_task(
    self,
    *,
    taskId: str,
) -> DescribeAuditTaskResponseTypeDef:  # (1)
    ...
  1. See DescribeAuditTaskResponseTypeDef
Usage example with kwargs
kwargs: DescribeAuditTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.describe_audit_task(**kwargs)
  1. See DescribeAuditTaskRequestRequestTypeDef

describe_authorizer

Describes an authorizer.

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

Method definition
def describe_authorizer(
    self,
    *,
    authorizerName: str,
) -> DescribeAuthorizerResponseTypeDef:  # (1)
    ...
  1. See DescribeAuthorizerResponseTypeDef
Usage example with kwargs
kwargs: DescribeAuthorizerRequestRequestTypeDef = {  # (1)
    "authorizerName": ...,
}

parent.describe_authorizer(**kwargs)
  1. See DescribeAuthorizerRequestRequestTypeDef

describe_billing_group

Returns information about a billing group.

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

Method definition
def describe_billing_group(
    self,
    *,
    billingGroupName: str,
) -> DescribeBillingGroupResponseTypeDef:  # (1)
    ...
  1. See DescribeBillingGroupResponseTypeDef
Usage example with kwargs
kwargs: DescribeBillingGroupRequestRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.describe_billing_group(**kwargs)
  1. See DescribeBillingGroupRequestRequestTypeDef

describe_ca_certificate

Describes a registered CA certificate.

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

Method definition
def describe_ca_certificate(
    self,
    *,
    certificateId: str,
) -> DescribeCACertificateResponseTypeDef:  # (1)
    ...
  1. See DescribeCACertificateResponseTypeDef
Usage example with kwargs
kwargs: DescribeCACertificateRequestRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.describe_ca_certificate(**kwargs)
  1. See DescribeCACertificateRequestRequestTypeDef

describe_certificate

Gets information about the specified certificate.

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

Method definition
def describe_certificate(
    self,
    *,
    certificateId: str,
) -> DescribeCertificateResponseTypeDef:  # (1)
    ...
  1. See DescribeCertificateResponseTypeDef
Usage example with kwargs
kwargs: DescribeCertificateRequestRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.describe_certificate(**kwargs)
  1. See DescribeCertificateRequestRequestTypeDef

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

Method definition
def describe_custom_metric(
    self,
    *,
    metricName: str,
) -> DescribeCustomMetricResponseTypeDef:  # (1)
    ...
  1. See DescribeCustomMetricResponseTypeDef
Usage example with kwargs
kwargs: DescribeCustomMetricRequestRequestTypeDef = {  # (1)
    "metricName": ...,
}

parent.describe_custom_metric(**kwargs)
  1. See DescribeCustomMetricRequestRequestTypeDef

describe_default_authorizer

Describes the default authorizer.

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

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

Method definition
def describe_detect_mitigation_actions_task(
    self,
    *,
    taskId: str,
) -> DescribeDetectMitigationActionsTaskResponseTypeDef:  # (1)
    ...
  1. See DescribeDetectMitigationActionsTaskResponseTypeDef
Usage example with kwargs
kwargs: DescribeDetectMitigationActionsTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.describe_detect_mitigation_actions_task(**kwargs)
  1. See DescribeDetectMitigationActionsTaskRequestRequestTypeDef

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

Method definition
def describe_dimension(
    self,
    *,
    name: str,
) -> DescribeDimensionResponseTypeDef:  # (1)
    ...
  1. See DescribeDimensionResponseTypeDef
Usage example with kwargs
kwargs: DescribeDimensionRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.describe_dimension(**kwargs)
  1. See DescribeDimensionRequestRequestTypeDef

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

Method definition
def describe_domain_configuration(
    self,
    *,
    domainConfigurationName: str,
) -> DescribeDomainConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeDomainConfigurationResponseTypeDef
Usage example with kwargs
kwargs: DescribeDomainConfigurationRequestRequestTypeDef = {  # (1)
    "domainConfigurationName": ...,
}

parent.describe_domain_configuration(**kwargs)
  1. See DescribeDomainConfigurationRequestRequestTypeDef

describe_endpoint

Returns 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

Method definition
def describe_endpoint(
    self,
    *,
    endpointType: str = ...,
) -> DescribeEndpointResponseTypeDef:  # (1)
    ...
  1. See DescribeEndpointResponseTypeDef
Usage example with kwargs
kwargs: DescribeEndpointRequestRequestTypeDef = {  # (1)
    "endpointType": ...,
}

parent.describe_endpoint(**kwargs)
  1. See DescribeEndpointRequestRequestTypeDef

describe_event_configurations

Describes event configurations.

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

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

Method definition
def describe_fleet_metric(
    self,
    *,
    metricName: str,
) -> DescribeFleetMetricResponseTypeDef:  # (1)
    ...
  1. See DescribeFleetMetricResponseTypeDef
Usage example with kwargs
kwargs: DescribeFleetMetricRequestRequestTypeDef = {  # (1)
    "metricName": ...,
}

parent.describe_fleet_metric(**kwargs)
  1. See DescribeFleetMetricRequestRequestTypeDef

describe_index

Describes a search index.

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

Method definition
def describe_index(
    self,
    *,
    indexName: str,
) -> DescribeIndexResponseTypeDef:  # (1)
    ...
  1. See DescribeIndexResponseTypeDef
Usage example with kwargs
kwargs: DescribeIndexRequestRequestTypeDef = {  # (1)
    "indexName": ...,
}

parent.describe_index(**kwargs)
  1. See DescribeIndexRequestRequestTypeDef

describe_job

Describes a job.

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

Method definition
def describe_job(
    self,
    *,
    jobId: str,
) -> DescribeJobResponseTypeDef:  # (1)
    ...
  1. See DescribeJobResponseTypeDef
Usage example with kwargs
kwargs: DescribeJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.describe_job(**kwargs)
  1. See DescribeJobRequestRequestTypeDef

describe_job_execution

Describes a job execution.

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

Method definition
def describe_job_execution(
    self,
    *,
    jobId: str,
    thingName: str,
    executionNumber: int = ...,
) -> DescribeJobExecutionResponseTypeDef:  # (1)
    ...
  1. See DescribeJobExecutionResponseTypeDef
Usage example with kwargs
kwargs: DescribeJobExecutionRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "thingName": ...,
}

parent.describe_job_execution(**kwargs)
  1. See DescribeJobExecutionRequestRequestTypeDef

describe_job_template

Returns information about a job template.

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

Method definition
def describe_job_template(
    self,
    *,
    jobTemplateId: str,
) -> DescribeJobTemplateResponseTypeDef:  # (1)
    ...
  1. See DescribeJobTemplateResponseTypeDef
Usage example with kwargs
kwargs: DescribeJobTemplateRequestRequestTypeDef = {  # (1)
    "jobTemplateId": ...,
}

parent.describe_job_template(**kwargs)
  1. See DescribeJobTemplateRequestRequestTypeDef

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

Method definition
def describe_managed_job_template(
    self,
    *,
    templateName: str,
    templateVersion: str = ...,
) -> DescribeManagedJobTemplateResponseTypeDef:  # (1)
    ...
  1. See DescribeManagedJobTemplateResponseTypeDef
Usage example with kwargs
kwargs: DescribeManagedJobTemplateRequestRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.describe_managed_job_template(**kwargs)
  1. See DescribeManagedJobTemplateRequestRequestTypeDef

describe_mitigation_action

Gets information about a mitigation action.

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

Method definition
def describe_mitigation_action(
    self,
    *,
    actionName: str,
) -> DescribeMitigationActionResponseTypeDef:  # (1)
    ...
  1. See DescribeMitigationActionResponseTypeDef
Usage example with kwargs
kwargs: DescribeMitigationActionRequestRequestTypeDef = {  # (1)
    "actionName": ...,
}

parent.describe_mitigation_action(**kwargs)
  1. See DescribeMitigationActionRequestRequestTypeDef

describe_provisioning_template

Returns information about a provisioning template.

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

Method definition
def describe_provisioning_template(
    self,
    *,
    templateName: str,
) -> DescribeProvisioningTemplateResponseTypeDef:  # (1)
    ...
  1. See DescribeProvisioningTemplateResponseTypeDef
Usage example with kwargs
kwargs: DescribeProvisioningTemplateRequestRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.describe_provisioning_template(**kwargs)
  1. See DescribeProvisioningTemplateRequestRequestTypeDef

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

Method definition
def describe_provisioning_template_version(
    self,
    *,
    templateName: str,
    versionId: int,
) -> DescribeProvisioningTemplateVersionResponseTypeDef:  # (1)
    ...
  1. See DescribeProvisioningTemplateVersionResponseTypeDef
Usage example with kwargs
kwargs: DescribeProvisioningTemplateVersionRequestRequestTypeDef = {  # (1)
    "templateName": ...,
    "versionId": ...,
}

parent.describe_provisioning_template_version(**kwargs)
  1. See DescribeProvisioningTemplateVersionRequestRequestTypeDef

describe_role_alias

Describes a role alias.

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

Method definition
def describe_role_alias(
    self,
    *,
    roleAlias: str,
) -> DescribeRoleAliasResponseTypeDef:  # (1)
    ...
  1. See DescribeRoleAliasResponseTypeDef
Usage example with kwargs
kwargs: DescribeRoleAliasRequestRequestTypeDef = {  # (1)
    "roleAlias": ...,
}

parent.describe_role_alias(**kwargs)
  1. See DescribeRoleAliasRequestRequestTypeDef

describe_scheduled_audit

Gets information about a scheduled audit.

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

Method definition
def describe_scheduled_audit(
    self,
    *,
    scheduledAuditName: str,
) -> DescribeScheduledAuditResponseTypeDef:  # (1)
    ...
  1. See DescribeScheduledAuditResponseTypeDef
Usage example with kwargs
kwargs: DescribeScheduledAuditRequestRequestTypeDef = {  # (1)
    "scheduledAuditName": ...,
}

parent.describe_scheduled_audit(**kwargs)
  1. See DescribeScheduledAuditRequestRequestTypeDef

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

Method definition
def describe_security_profile(
    self,
    *,
    securityProfileName: str,
) -> DescribeSecurityProfileResponseTypeDef:  # (1)
    ...
  1. See DescribeSecurityProfileResponseTypeDef
Usage example with kwargs
kwargs: DescribeSecurityProfileRequestRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.describe_security_profile(**kwargs)
  1. See DescribeSecurityProfileRequestRequestTypeDef

describe_stream

Gets information about a stream.

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

Method definition
def describe_stream(
    self,
    *,
    streamId: str,
) -> DescribeStreamResponseTypeDef:  # (1)
    ...
  1. See DescribeStreamResponseTypeDef
Usage example with kwargs
kwargs: DescribeStreamRequestRequestTypeDef = {  # (1)
    "streamId": ...,
}

parent.describe_stream(**kwargs)
  1. See DescribeStreamRequestRequestTypeDef

describe_thing

Gets information about the specified thing.

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

Method definition
def describe_thing(
    self,
    *,
    thingName: str,
) -> DescribeThingResponseTypeDef:  # (1)
    ...
  1. See DescribeThingResponseTypeDef
Usage example with kwargs
kwargs: DescribeThingRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.describe_thing(**kwargs)
  1. See DescribeThingRequestRequestTypeDef

describe_thing_group

Describe a thing group.

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

Method definition
def describe_thing_group(
    self,
    *,
    thingGroupName: str,
) -> DescribeThingGroupResponseTypeDef:  # (1)
    ...
  1. See DescribeThingGroupResponseTypeDef
Usage example with kwargs
kwargs: DescribeThingGroupRequestRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.describe_thing_group(**kwargs)
  1. See DescribeThingGroupRequestRequestTypeDef

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

Method definition
def describe_thing_registration_task(
    self,
    *,
    taskId: str,
) -> DescribeThingRegistrationTaskResponseTypeDef:  # (1)
    ...
  1. See DescribeThingRegistrationTaskResponseTypeDef
Usage example with kwargs
kwargs: DescribeThingRegistrationTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.describe_thing_registration_task(**kwargs)
  1. See DescribeThingRegistrationTaskRequestRequestTypeDef

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

Method definition
def describe_thing_type(
    self,
    *,
    thingTypeName: str,
) -> DescribeThingTypeResponseTypeDef:  # (1)
    ...
  1. See DescribeThingTypeResponseTypeDef
Usage example with kwargs
kwargs: DescribeThingTypeRequestRequestTypeDef = {  # (1)
    "thingTypeName": ...,
}

parent.describe_thing_type(**kwargs)
  1. See DescribeThingTypeRequestRequestTypeDef

detach_policy

Detaches a policy from the specified target.

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

Method definition
def detach_policy(
    self,
    *,
    policyName: str,
    target: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DetachPolicyRequestRequestTypeDef = {  # (1)
    "policyName": ...,
    "target": ...,
}

parent.detach_policy(**kwargs)
  1. See DetachPolicyRequestRequestTypeDef

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

Method definition
def detach_principal_policy(
    self,
    *,
    policyName: str,
    principal: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DetachPrincipalPolicyRequestRequestTypeDef = {  # (1)
    "policyName": ...,
    "principal": ...,
}

parent.detach_principal_policy(**kwargs)
  1. See DetachPrincipalPolicyRequestRequestTypeDef

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

Method definition
def detach_security_profile(
    self,
    *,
    securityProfileName: str,
    securityProfileTargetArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DetachSecurityProfileRequestRequestTypeDef = {  # (1)
    "securityProfileName": ...,
    "securityProfileTargetArn": ...,
}

parent.detach_security_profile(**kwargs)
  1. See DetachSecurityProfileRequestRequestTypeDef

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

Method definition
def detach_thing_principal(
    self,
    *,
    thingName: str,
    principal: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DetachThingPrincipalRequestRequestTypeDef = {  # (1)
    "thingName": ...,
    "principal": ...,
}

parent.detach_thing_principal(**kwargs)
  1. See DetachThingPrincipalRequestRequestTypeDef

disable_topic_rule

Disables the rule.

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

Method definition
def disable_topic_rule(
    self,
    *,
    ruleName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DisableTopicRuleRequestRequestTypeDef = {  # (1)
    "ruleName": ...,
}

parent.disable_topic_rule(**kwargs)
  1. See DisableTopicRuleRequestRequestTypeDef

enable_topic_rule

Enables the rule.

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

Method definition
def enable_topic_rule(
    self,
    *,
    ruleName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: EnableTopicRuleRequestRequestTypeDef = {  # (1)
    "ruleName": ...,
}

parent.enable_topic_rule(**kwargs)
  1. See EnableTopicRuleRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

Method definition
def get_behavior_model_training_summaries(
    self,
    *,
    securityProfileName: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> GetBehaviorModelTrainingSummariesResponseTypeDef:  # (1)
    ...
  1. See GetBehaviorModelTrainingSummariesResponseTypeDef
Usage example with kwargs
kwargs: GetBehaviorModelTrainingSummariesRequestRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.get_behavior_model_training_summaries(**kwargs)
  1. See GetBehaviorModelTrainingSummariesRequestRequestTypeDef

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

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
Usage example with kwargs
kwargs: GetBucketsAggregationRequestRequestTypeDef = {  # (1)
    "queryString": ...,
    "aggregationField": ...,
    "bucketsAggregationType": ...,
}

parent.get_buckets_aggregation(**kwargs)
  1. See GetBucketsAggregationRequestRequestTypeDef

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

Method definition
def get_cardinality(
    self,
    *,
    queryString: str,
    indexName: str = ...,
    aggregationField: str = ...,
    queryVersion: str = ...,
) -> GetCardinalityResponseTypeDef:  # (1)
    ...
  1. See GetCardinalityResponseTypeDef
Usage example with kwargs
kwargs: GetCardinalityRequestRequestTypeDef = {  # (1)
    "queryString": ...,
}

parent.get_cardinality(**kwargs)
  1. See GetCardinalityRequestRequestTypeDef

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

Method definition
def get_effective_policies(
    self,
    *,
    principal: str = ...,
    cognitoIdentityPoolId: str = ...,
    thingName: str = ...,
) -> GetEffectivePoliciesResponseTypeDef:  # (1)
    ...
  1. See GetEffectivePoliciesResponseTypeDef
Usage example with kwargs
kwargs: GetEffectivePoliciesRequestRequestTypeDef = {  # (1)
    "principal": ...,
}

parent.get_effective_policies(**kwargs)
  1. See GetEffectivePoliciesRequestRequestTypeDef

get_indexing_configuration

Gets the indexing configuration.

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

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

Method definition
def get_job_document(
    self,
    *,
    jobId: str,
) -> GetJobDocumentResponseTypeDef:  # (1)
    ...
  1. See GetJobDocumentResponseTypeDef
Usage example with kwargs
kwargs: GetJobDocumentRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.get_job_document(**kwargs)
  1. See GetJobDocumentRequestRequestTypeDef

get_logging_options

Gets the logging options.

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

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

Method definition
def get_ota_update(
    self,
    *,
    otaUpdateId: str,
) -> GetOTAUpdateResponseTypeDef:  # (1)
    ...
  1. See GetOTAUpdateResponseTypeDef
Usage example with kwargs
kwargs: GetOTAUpdateRequestRequestTypeDef = {  # (1)
    "otaUpdateId": ...,
}

parent.get_ota_update(**kwargs)
  1. See GetOTAUpdateRequestRequestTypeDef

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

Method definition
def get_percentiles(
    self,
    *,
    queryString: str,
    indexName: str = ...,
    aggregationField: str = ...,
    queryVersion: str = ...,
    percents: Sequence[float] = ...,
) -> GetPercentilesResponseTypeDef:  # (1)
    ...
  1. See GetPercentilesResponseTypeDef
Usage example with kwargs
kwargs: GetPercentilesRequestRequestTypeDef = {  # (1)
    "queryString": ...,
}

parent.get_percentiles(**kwargs)
  1. See GetPercentilesRequestRequestTypeDef

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

Method definition
def get_policy(
    self,
    *,
    policyName: str,
) -> GetPolicyResponseTypeDef:  # (1)
    ...
  1. See GetPolicyResponseTypeDef
Usage example with kwargs
kwargs: GetPolicyRequestRequestTypeDef = {  # (1)
    "policyName": ...,
}

parent.get_policy(**kwargs)
  1. See GetPolicyRequestRequestTypeDef

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

Method definition
def get_policy_version(
    self,
    *,
    policyName: str,
    policyVersionId: str,
) -> GetPolicyVersionResponseTypeDef:  # (1)
    ...
  1. See GetPolicyVersionResponseTypeDef
Usage example with kwargs
kwargs: GetPolicyVersionRequestRequestTypeDef = {  # (1)
    "policyName": ...,
    "policyVersionId": ...,
}

parent.get_policy_version(**kwargs)
  1. See GetPolicyVersionRequestRequestTypeDef

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

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

Method definition
def get_statistics(
    self,
    *,
    queryString: str,
    indexName: str = ...,
    aggregationField: str = ...,
    queryVersion: str = ...,
) -> GetStatisticsResponseTypeDef:  # (1)
    ...
  1. See GetStatisticsResponseTypeDef
Usage example with kwargs
kwargs: GetStatisticsRequestRequestTypeDef = {  # (1)
    "queryString": ...,
}

parent.get_statistics(**kwargs)
  1. See GetStatisticsRequestRequestTypeDef

get_topic_rule

Gets information about the rule.

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

Method definition
def get_topic_rule(
    self,
    *,
    ruleName: str,
) -> GetTopicRuleResponseTypeDef:  # (1)
    ...
  1. See GetTopicRuleResponseTypeDef
Usage example with kwargs
kwargs: GetTopicRuleRequestRequestTypeDef = {  # (1)
    "ruleName": ...,
}

parent.get_topic_rule(**kwargs)
  1. See GetTopicRuleRequestRequestTypeDef

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

Method definition
def get_topic_rule_destination(
    self,
    *,
    arn: str,
) -> GetTopicRuleDestinationResponseTypeDef:  # (1)
    ...
  1. See GetTopicRuleDestinationResponseTypeDef
Usage example with kwargs
kwargs: GetTopicRuleDestinationRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.get_topic_rule_destination(**kwargs)
  1. See GetTopicRuleDestinationRequestRequestTypeDef

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

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

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
Usage example with kwargs
kwargs: ListActiveViolationsRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.list_active_violations(**kwargs)
  1. See ListActiveViolationsRequestRequestTypeDef

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

Method definition
def list_attached_policies(
    self,
    *,
    target: str,
    recursive: bool = ...,
    marker: str = ...,
    pageSize: int = ...,
) -> ListAttachedPoliciesResponseTypeDef:  # (1)
    ...
  1. See ListAttachedPoliciesResponseTypeDef
Usage example with kwargs
kwargs: ListAttachedPoliciesRequestRequestTypeDef = {  # (1)
    "target": ...,
}

parent.list_attached_policies(**kwargs)
  1. See ListAttachedPoliciesRequestRequestTypeDef

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

Method definition
def list_audit_findings(
    self,
    *,
    taskId: str = ...,
    checkName: str = ...,
    resourceIdentifier: ResourceIdentifierTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
    startTime: Union[datetime, str] = ...,
    endTime: Union[datetime, str] = ...,
    listSuppressedFindings: bool = ...,
) -> ListAuditFindingsResponseTypeDef:  # (2)
    ...
  1. See ResourceIdentifierTypeDef
  2. See ListAuditFindingsResponseTypeDef
Usage example with kwargs
kwargs: ListAuditFindingsRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.list_audit_findings(**kwargs)
  1. See ListAuditFindingsRequestRequestTypeDef

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

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
Usage example with kwargs
kwargs: ListAuditMitigationActionsExecutionsRequestRequestTypeDef = {  # (1)
    "taskId": ...,
    "findingId": ...,
}

parent.list_audit_mitigation_actions_executions(**kwargs)
  1. See ListAuditMitigationActionsExecutionsRequestRequestTypeDef

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

Method definition
def list_audit_mitigation_actions_tasks(
    self,
    *,
    startTime: Union[datetime, str],
    endTime: Union[datetime, str],
    auditTaskId: str = ...,
    findingId: str = ...,
    taskStatus: AuditMitigationActionsTaskStatusType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAuditMitigationActionsTasksResponseTypeDef:  # (2)
    ...
  1. See AuditMitigationActionsTaskStatusType
  2. See ListAuditMitigationActionsTasksResponseTypeDef
Usage example with kwargs
kwargs: ListAuditMitigationActionsTasksRequestRequestTypeDef = {  # (1)
    "startTime": ...,
    "endTime": ...,
}

parent.list_audit_mitigation_actions_tasks(**kwargs)
  1. See ListAuditMitigationActionsTasksRequestRequestTypeDef

list_audit_suppressions

Lists your Device Defender audit listings.

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

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
Usage example with kwargs
kwargs: ListAuditSuppressionsRequestRequestTypeDef = {  # (1)
    "checkName": ...,
}

parent.list_audit_suppressions(**kwargs)
  1. See ListAuditSuppressionsRequestRequestTypeDef

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

Method definition
def list_audit_tasks(
    self,
    *,
    startTime: Union[datetime, str],
    endTime: Union[datetime, str],
    taskType: AuditTaskTypeType = ...,  # (1)
    taskStatus: AuditTaskStatusType = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAuditTasksResponseTypeDef:  # (3)
    ...
  1. See AuditTaskTypeType
  2. See AuditTaskStatusType
  3. See ListAuditTasksResponseTypeDef
Usage example with kwargs
kwargs: ListAuditTasksRequestRequestTypeDef = {  # (1)
    "startTime": ...,
    "endTime": ...,
}

parent.list_audit_tasks(**kwargs)
  1. See ListAuditTasksRequestRequestTypeDef

list_authorizers

Lists the authorizers registered in your account.

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

Method definition
def list_authorizers(
    self,
    *,
    pageSize: int = ...,
    marker: str = ...,
    ascendingOrder: bool = ...,
    status: AuthorizerStatusType = ...,  # (1)
) -> ListAuthorizersResponseTypeDef:  # (2)
    ...
  1. See AuthorizerStatusType
  2. See ListAuthorizersResponseTypeDef
Usage example with kwargs
kwargs: ListAuthorizersRequestRequestTypeDef = {  # (1)
    "pageSize": ...,
}

parent.list_authorizers(**kwargs)
  1. See ListAuthorizersRequestRequestTypeDef

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

Method definition
def list_billing_groups(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    namePrefixFilter: str = ...,
) -> ListBillingGroupsResponseTypeDef:  # (1)
    ...
  1. See ListBillingGroupsResponseTypeDef
Usage example with kwargs
kwargs: ListBillingGroupsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_billing_groups(**kwargs)
  1. See ListBillingGroupsRequestRequestTypeDef

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

Method definition
def list_ca_certificates(
    self,
    *,
    pageSize: int = ...,
    marker: str = ...,
    ascendingOrder: bool = ...,
    templateName: str = ...,
) -> ListCACertificatesResponseTypeDef:  # (1)
    ...
  1. See ListCACertificatesResponseTypeDef
Usage example with kwargs
kwargs: ListCACertificatesRequestRequestTypeDef = {  # (1)
    "pageSize": ...,
}

parent.list_ca_certificates(**kwargs)
  1. See ListCACertificatesRequestRequestTypeDef

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

Method definition
def list_certificates(
    self,
    *,
    pageSize: int = ...,
    marker: str = ...,
    ascendingOrder: bool = ...,
) -> ListCertificatesResponseTypeDef:  # (1)
    ...
  1. See ListCertificatesResponseTypeDef
Usage example with kwargs
kwargs: ListCertificatesRequestRequestTypeDef = {  # (1)
    "pageSize": ...,
}

parent.list_certificates(**kwargs)
  1. See ListCertificatesRequestRequestTypeDef

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

Method definition
def list_certificates_by_ca(
    self,
    *,
    caCertificateId: str,
    pageSize: int = ...,
    marker: str = ...,
    ascendingOrder: bool = ...,
) -> ListCertificatesByCAResponseTypeDef:  # (1)
    ...
  1. See ListCertificatesByCAResponseTypeDef
Usage example with kwargs
kwargs: ListCertificatesByCARequestRequestTypeDef = {  # (1)
    "caCertificateId": ...,
}

parent.list_certificates_by_ca(**kwargs)
  1. See ListCertificatesByCARequestRequestTypeDef

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

Method definition
def list_custom_metrics(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCustomMetricsResponseTypeDef:  # (1)
    ...
  1. See ListCustomMetricsResponseTypeDef
Usage example with kwargs
kwargs: ListCustomMetricsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_custom_metrics(**kwargs)
  1. See ListCustomMetricsRequestRequestTypeDef

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

Method definition
def list_detect_mitigation_actions_executions(
    self,
    *,
    taskId: str = ...,
    violationId: str = ...,
    thingName: str = ...,
    startTime: Union[datetime, str] = ...,
    endTime: Union[datetime, str] = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDetectMitigationActionsExecutionsResponseTypeDef:  # (1)
    ...
  1. See ListDetectMitigationActionsExecutionsResponseTypeDef
Usage example with kwargs
kwargs: ListDetectMitigationActionsExecutionsRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.list_detect_mitigation_actions_executions(**kwargs)
  1. See ListDetectMitigationActionsExecutionsRequestRequestTypeDef

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

Method definition
def list_detect_mitigation_actions_tasks(
    self,
    *,
    startTime: Union[datetime, str],
    endTime: Union[datetime, str],
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDetectMitigationActionsTasksResponseTypeDef:  # (1)
    ...
  1. See ListDetectMitigationActionsTasksResponseTypeDef
Usage example with kwargs
kwargs: ListDetectMitigationActionsTasksRequestRequestTypeDef = {  # (1)
    "startTime": ...,
    "endTime": ...,
}

parent.list_detect_mitigation_actions_tasks(**kwargs)
  1. See ListDetectMitigationActionsTasksRequestRequestTypeDef

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

Method definition
def list_dimensions(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDimensionsResponseTypeDef:  # (1)
    ...
  1. See ListDimensionsResponseTypeDef
Usage example with kwargs
kwargs: ListDimensionsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_dimensions(**kwargs)
  1. See ListDimensionsRequestRequestTypeDef

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

Method definition
def list_domain_configurations(
    self,
    *,
    marker: str = ...,
    pageSize: int = ...,
    serviceType: ServiceTypeType = ...,  # (1)
) -> ListDomainConfigurationsResponseTypeDef:  # (2)
    ...
  1. See ServiceTypeType
  2. See ListDomainConfigurationsResponseTypeDef
Usage example with kwargs
kwargs: ListDomainConfigurationsRequestRequestTypeDef = {  # (1)
    "marker": ...,
}

parent.list_domain_configurations(**kwargs)
  1. See ListDomainConfigurationsRequestRequestTypeDef

list_fleet_metrics

Lists all your fleet metrics.

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

Method definition
def list_fleet_metrics(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFleetMetricsResponseTypeDef:  # (1)
    ...
  1. See ListFleetMetricsResponseTypeDef
Usage example with kwargs
kwargs: ListFleetMetricsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_fleet_metrics(**kwargs)
  1. See ListFleetMetricsRequestRequestTypeDef

list_indices

Lists the search indices.

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

Method definition
def list_indices(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListIndicesResponseTypeDef:  # (1)
    ...
  1. See ListIndicesResponseTypeDef
Usage example with kwargs
kwargs: ListIndicesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_indices(**kwargs)
  1. See ListIndicesRequestRequestTypeDef

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

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
Usage example with kwargs
kwargs: ListJobExecutionsForJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.list_job_executions_for_job(**kwargs)
  1. See ListJobExecutionsForJobRequestRequestTypeDef

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

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
Usage example with kwargs
kwargs: ListJobExecutionsForThingRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.list_job_executions_for_thing(**kwargs)
  1. See ListJobExecutionsForThingRequestRequestTypeDef

list_job_templates

Returns a list of job templates.

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

Method definition
def list_job_templates(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListJobTemplatesResponseTypeDef:  # (1)
    ...
  1. See ListJobTemplatesResponseTypeDef
Usage example with kwargs
kwargs: ListJobTemplatesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_job_templates(**kwargs)
  1. See ListJobTemplatesRequestRequestTypeDef

list_jobs

Lists jobs.

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

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
Usage example with kwargs
kwargs: ListJobsRequestRequestTypeDef = {  # (1)
    "status": ...,
}

parent.list_jobs(**kwargs)
  1. See ListJobsRequestRequestTypeDef

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

Method definition
def list_managed_job_templates(
    self,
    *,
    templateName: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListManagedJobTemplatesResponseTypeDef:  # (1)
    ...
  1. See ListManagedJobTemplatesResponseTypeDef
Usage example with kwargs
kwargs: ListManagedJobTemplatesRequestRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.list_managed_job_templates(**kwargs)
  1. See ListManagedJobTemplatesRequestRequestTypeDef

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

Method definition
def list_metric_values(
    self,
    *,
    thingName: str,
    metricName: str,
    startTime: Union[datetime, str],
    endTime: Union[datetime, str],
    dimensionName: str = ...,
    dimensionValueOperator: DimensionValueOperatorType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMetricValuesResponseTypeDef:  # (2)
    ...
  1. See DimensionValueOperatorType
  2. See ListMetricValuesResponseTypeDef
Usage example with kwargs
kwargs: ListMetricValuesRequestRequestTypeDef = {  # (1)
    "thingName": ...,
    "metricName": ...,
    "startTime": ...,
    "endTime": ...,
}

parent.list_metric_values(**kwargs)
  1. See ListMetricValuesRequestRequestTypeDef

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

Method definition
def list_mitigation_actions(
    self,
    *,
    actionType: MitigationActionTypeType = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListMitigationActionsResponseTypeDef:  # (2)
    ...
  1. See MitigationActionTypeType
  2. See ListMitigationActionsResponseTypeDef
Usage example with kwargs
kwargs: ListMitigationActionsRequestRequestTypeDef = {  # (1)
    "actionType": ...,
}

parent.list_mitigation_actions(**kwargs)
  1. See ListMitigationActionsRequestRequestTypeDef

list_ota_updates

Lists OTA updates.

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

Method definition
def list_ota_updates(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    otaUpdateStatus: OTAUpdateStatusType = ...,  # (1)
) -> ListOTAUpdatesResponseTypeDef:  # (2)
    ...
  1. See OTAUpdateStatusType
  2. See ListOTAUpdatesResponseTypeDef
Usage example with kwargs
kwargs: ListOTAUpdatesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_ota_updates(**kwargs)
  1. See ListOTAUpdatesRequestRequestTypeDef

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

Method definition
def list_outgoing_certificates(
    self,
    *,
    pageSize: int = ...,
    marker: str = ...,
    ascendingOrder: bool = ...,
) -> ListOutgoingCertificatesResponseTypeDef:  # (1)
    ...
  1. See ListOutgoingCertificatesResponseTypeDef
Usage example with kwargs
kwargs: ListOutgoingCertificatesRequestRequestTypeDef = {  # (1)
    "pageSize": ...,
}

parent.list_outgoing_certificates(**kwargs)
  1. See ListOutgoingCertificatesRequestRequestTypeDef

list_policies

Lists your policies.

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

Method definition
def list_policies(
    self,
    *,
    marker: str = ...,
    pageSize: int = ...,
    ascendingOrder: bool = ...,
) -> ListPoliciesResponseTypeDef:  # (1)
    ...
  1. See ListPoliciesResponseTypeDef
Usage example with kwargs
kwargs: ListPoliciesRequestRequestTypeDef = {  # (1)
    "marker": ...,
}

parent.list_policies(**kwargs)
  1. See ListPoliciesRequestRequestTypeDef

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

Method definition
def list_policy_principals(
    self,
    *,
    policyName: str,
    marker: str = ...,
    pageSize: int = ...,
    ascendingOrder: bool = ...,
) -> ListPolicyPrincipalsResponseTypeDef:  # (1)
    ...
  1. See ListPolicyPrincipalsResponseTypeDef
Usage example with kwargs
kwargs: ListPolicyPrincipalsRequestRequestTypeDef = {  # (1)
    "policyName": ...,
}

parent.list_policy_principals(**kwargs)
  1. See ListPolicyPrincipalsRequestRequestTypeDef

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

Method definition
def list_policy_versions(
    self,
    *,
    policyName: str,
) -> ListPolicyVersionsResponseTypeDef:  # (1)
    ...
  1. See ListPolicyVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListPolicyVersionsRequestRequestTypeDef = {  # (1)
    "policyName": ...,
}

parent.list_policy_versions(**kwargs)
  1. See ListPolicyVersionsRequestRequestTypeDef

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

Method definition
def list_principal_policies(
    self,
    *,
    principal: str,
    marker: str = ...,
    pageSize: int = ...,
    ascendingOrder: bool = ...,
) -> ListPrincipalPoliciesResponseTypeDef:  # (1)
    ...
  1. See ListPrincipalPoliciesResponseTypeDef
Usage example with kwargs
kwargs: ListPrincipalPoliciesRequestRequestTypeDef = {  # (1)
    "principal": ...,
}

parent.list_principal_policies(**kwargs)
  1. See ListPrincipalPoliciesRequestRequestTypeDef

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

Method definition
def list_principal_things(
    self,
    *,
    principal: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPrincipalThingsResponseTypeDef:  # (1)
    ...
  1. See ListPrincipalThingsResponseTypeDef
Usage example with kwargs
kwargs: ListPrincipalThingsRequestRequestTypeDef = {  # (1)
    "principal": ...,
}

parent.list_principal_things(**kwargs)
  1. See ListPrincipalThingsRequestRequestTypeDef

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

Method definition
def list_provisioning_template_versions(
    self,
    *,
    templateName: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListProvisioningTemplateVersionsResponseTypeDef:  # (1)
    ...
  1. See ListProvisioningTemplateVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListProvisioningTemplateVersionsRequestRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.list_provisioning_template_versions(**kwargs)
  1. See ListProvisioningTemplateVersionsRequestRequestTypeDef

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

Method definition
def list_provisioning_templates(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListProvisioningTemplatesResponseTypeDef:  # (1)
    ...
  1. See ListProvisioningTemplatesResponseTypeDef
Usage example with kwargs
kwargs: ListProvisioningTemplatesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_provisioning_templates(**kwargs)
  1. See ListProvisioningTemplatesRequestRequestTypeDef

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

Method definition
def list_related_resources_for_audit_finding(
    self,
    *,
    findingId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListRelatedResourcesForAuditFindingResponseTypeDef:  # (1)
    ...
  1. See ListRelatedResourcesForAuditFindingResponseTypeDef
Usage example with kwargs
kwargs: ListRelatedResourcesForAuditFindingRequestRequestTypeDef = {  # (1)
    "findingId": ...,
}

parent.list_related_resources_for_audit_finding(**kwargs)
  1. See ListRelatedResourcesForAuditFindingRequestRequestTypeDef

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

Method definition
def list_role_aliases(
    self,
    *,
    pageSize: int = ...,
    marker: str = ...,
    ascendingOrder: bool = ...,
) -> ListRoleAliasesResponseTypeDef:  # (1)
    ...
  1. See ListRoleAliasesResponseTypeDef
Usage example with kwargs
kwargs: ListRoleAliasesRequestRequestTypeDef = {  # (1)
    "pageSize": ...,
}

parent.list_role_aliases(**kwargs)
  1. See ListRoleAliasesRequestRequestTypeDef

list_scheduled_audits

Lists all of your scheduled audits.

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

Method definition
def list_scheduled_audits(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListScheduledAuditsResponseTypeDef:  # (1)
    ...
  1. See ListScheduledAuditsResponseTypeDef
Usage example with kwargs
kwargs: ListScheduledAuditsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_scheduled_audits(**kwargs)
  1. See ListScheduledAuditsRequestRequestTypeDef

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

Method definition
def list_security_profiles(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    dimensionName: str = ...,
    metricName: str = ...,
) -> ListSecurityProfilesResponseTypeDef:  # (1)
    ...
  1. See ListSecurityProfilesResponseTypeDef
Usage example with kwargs
kwargs: ListSecurityProfilesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_security_profiles(**kwargs)
  1. See ListSecurityProfilesRequestRequestTypeDef

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

Method definition
def list_security_profiles_for_target(
    self,
    *,
    securityProfileTargetArn: str,
    nextToken: str = ...,
    maxResults: int = ...,
    recursive: bool = ...,
) -> ListSecurityProfilesForTargetResponseTypeDef:  # (1)
    ...
  1. See ListSecurityProfilesForTargetResponseTypeDef
Usage example with kwargs
kwargs: ListSecurityProfilesForTargetRequestRequestTypeDef = {  # (1)
    "securityProfileTargetArn": ...,
}

parent.list_security_profiles_for_target(**kwargs)
  1. See ListSecurityProfilesForTargetRequestRequestTypeDef

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

Method definition
def list_streams(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    ascendingOrder: bool = ...,
) -> ListStreamsResponseTypeDef:  # (1)
    ...
  1. See ListStreamsResponseTypeDef
Usage example with kwargs
kwargs: ListStreamsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_streams(**kwargs)
  1. See ListStreamsRequestRequestTypeDef

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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
    nextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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

Method definition
def list_targets_for_policy(
    self,
    *,
    policyName: str,
    marker: str = ...,
    pageSize: int = ...,
) -> ListTargetsForPolicyResponseTypeDef:  # (1)
    ...
  1. See ListTargetsForPolicyResponseTypeDef
Usage example with kwargs
kwargs: ListTargetsForPolicyRequestRequestTypeDef = {  # (1)
    "policyName": ...,
}

parent.list_targets_for_policy(**kwargs)
  1. See ListTargetsForPolicyRequestRequestTypeDef

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

Method definition
def list_targets_for_security_profile(
    self,
    *,
    securityProfileName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListTargetsForSecurityProfileResponseTypeDef:  # (1)
    ...
  1. See ListTargetsForSecurityProfileResponseTypeDef
Usage example with kwargs
kwargs: ListTargetsForSecurityProfileRequestRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.list_targets_for_security_profile(**kwargs)
  1. See ListTargetsForSecurityProfileRequestRequestTypeDef

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

Method definition
def list_thing_groups(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    parentGroup: str = ...,
    namePrefixFilter: str = ...,
    recursive: bool = ...,
) -> ListThingGroupsResponseTypeDef:  # (1)
    ...
  1. See ListThingGroupsResponseTypeDef
Usage example with kwargs
kwargs: ListThingGroupsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_thing_groups(**kwargs)
  1. See ListThingGroupsRequestRequestTypeDef

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

Method definition
def list_thing_groups_for_thing(
    self,
    *,
    thingName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListThingGroupsForThingResponseTypeDef:  # (1)
    ...
  1. See ListThingGroupsForThingResponseTypeDef
Usage example with kwargs
kwargs: ListThingGroupsForThingRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.list_thing_groups_for_thing(**kwargs)
  1. See ListThingGroupsForThingRequestRequestTypeDef

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

Method definition
def list_thing_principals(
    self,
    *,
    thingName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListThingPrincipalsResponseTypeDef:  # (1)
    ...
  1. See ListThingPrincipalsResponseTypeDef
Usage example with kwargs
kwargs: ListThingPrincipalsRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.list_thing_principals(**kwargs)
  1. See ListThingPrincipalsRequestRequestTypeDef

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

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
Usage example with kwargs
kwargs: ListThingRegistrationTaskReportsRequestRequestTypeDef = {  # (1)
    "taskId": ...,
    "reportType": ...,
}

parent.list_thing_registration_task_reports(**kwargs)
  1. See ListThingRegistrationTaskReportsRequestRequestTypeDef

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

Method definition
def list_thing_registration_tasks(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    status: StatusType = ...,  # (1)
) -> ListThingRegistrationTasksResponseTypeDef:  # (2)
    ...
  1. See StatusType
  2. See ListThingRegistrationTasksResponseTypeDef
Usage example with kwargs
kwargs: ListThingRegistrationTasksRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_thing_registration_tasks(**kwargs)
  1. See ListThingRegistrationTasksRequestRequestTypeDef

list_thing_types

Lists the existing thing types.

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

Method definition
def list_thing_types(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    thingTypeName: str = ...,
) -> ListThingTypesResponseTypeDef:  # (1)
    ...
  1. See ListThingTypesResponseTypeDef
Usage example with kwargs
kwargs: ListThingTypesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_thing_types(**kwargs)
  1. See ListThingTypesRequestRequestTypeDef

list_things

Lists your things.

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

Method definition
def list_things(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    attributeName: str = ...,
    attributeValue: str = ...,
    thingTypeName: str = ...,
    usePrefixAttributeValue: bool = ...,
) -> ListThingsResponseTypeDef:  # (1)
    ...
  1. See ListThingsResponseTypeDef
Usage example with kwargs
kwargs: ListThingsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_things(**kwargs)
  1. See ListThingsRequestRequestTypeDef

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

Method definition
def list_things_in_billing_group(
    self,
    *,
    billingGroupName: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListThingsInBillingGroupResponseTypeDef:  # (1)
    ...
  1. See ListThingsInBillingGroupResponseTypeDef
Usage example with kwargs
kwargs: ListThingsInBillingGroupRequestRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.list_things_in_billing_group(**kwargs)
  1. See ListThingsInBillingGroupRequestRequestTypeDef

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

Method definition
def list_things_in_thing_group(
    self,
    *,
    thingGroupName: str,
    recursive: bool = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListThingsInThingGroupResponseTypeDef:  # (1)
    ...
  1. See ListThingsInThingGroupResponseTypeDef
Usage example with kwargs
kwargs: ListThingsInThingGroupRequestRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.list_things_in_thing_group(**kwargs)
  1. See ListThingsInThingGroupRequestRequestTypeDef

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

Method definition
def list_topic_rule_destinations(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTopicRuleDestinationsResponseTypeDef:  # (1)
    ...
  1. See ListTopicRuleDestinationsResponseTypeDef
Usage example with kwargs
kwargs: ListTopicRuleDestinationsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_topic_rule_destinations(**kwargs)
  1. See ListTopicRuleDestinationsRequestRequestTypeDef

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

Method definition
def list_topic_rules(
    self,
    *,
    topic: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    ruleDisabled: bool = ...,
) -> ListTopicRulesResponseTypeDef:  # (1)
    ...
  1. See ListTopicRulesResponseTypeDef
Usage example with kwargs
kwargs: ListTopicRulesRequestRequestTypeDef = {  # (1)
    "topic": ...,
}

parent.list_topic_rules(**kwargs)
  1. See ListTopicRulesRequestRequestTypeDef

list_v2_logging_levels

Lists logging levels.

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

Method definition
def list_v2_logging_levels(
    self,
    *,
    targetType: LogTargetTypeType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListV2LoggingLevelsResponseTypeDef:  # (2)
    ...
  1. See LogTargetTypeType
  2. See ListV2LoggingLevelsResponseTypeDef
Usage example with kwargs
kwargs: ListV2LoggingLevelsRequestRequestTypeDef = {  # (1)
    "targetType": ...,
}

parent.list_v2_logging_levels(**kwargs)
  1. See ListV2LoggingLevelsRequestRequestTypeDef

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

Method definition
def list_violation_events(
    self,
    *,
    startTime: Union[datetime, str],
    endTime: Union[datetime, str],
    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
Usage example with kwargs
kwargs: ListViolationEventsRequestRequestTypeDef = {  # (1)
    "startTime": ...,
    "endTime": ...,
}

parent.list_violation_events(**kwargs)
  1. See ListViolationEventsRequestRequestTypeDef

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

Method definition
def put_verification_state_on_violation(
    self,
    *,
    violationId: str,
    verificationState: VerificationStateType,  # (1)
    verificationStateDescription: str = ...,
) -> Dict[str, Any]:
    ...
  1. See VerificationStateType
Usage example with kwargs
kwargs: PutVerificationStateOnViolationRequestRequestTypeDef = {  # (1)
    "violationId": ...,
    "verificationState": ...,
}

parent.put_verification_state_on_violation(**kwargs)
  1. See PutVerificationStateOnViolationRequestRequestTypeDef

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

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 TagTypeDef
  3. See CertificateModeType
  4. See RegisterCACertificateResponseTypeDef
Usage example with kwargs
kwargs: RegisterCACertificateRequestRequestTypeDef = {  # (1)
    "caCertificate": ...,
}

parent.register_ca_certificate(**kwargs)
  1. See RegisterCACertificateRequestRequestTypeDef

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

Method definition
def register_certificate(
    self,
    *,
    certificatePem: str,
    caCertificatePem: str = ...,
    setAsActive: bool = ...,
    status: CertificateStatusType = ...,  # (1)
) -> RegisterCertificateResponseTypeDef:  # (2)
    ...
  1. See CertificateStatusType
  2. See RegisterCertificateResponseTypeDef
Usage example with kwargs
kwargs: RegisterCertificateRequestRequestTypeDef = {  # (1)
    "certificatePem": ...,
}

parent.register_certificate(**kwargs)
  1. See RegisterCertificateRequestRequestTypeDef

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

Method definition
def register_certificate_without_ca(
    self,
    *,
    certificatePem: str,
    status: CertificateStatusType = ...,  # (1)
) -> RegisterCertificateWithoutCAResponseTypeDef:  # (2)
    ...
  1. See CertificateStatusType
  2. See RegisterCertificateWithoutCAResponseTypeDef
Usage example with kwargs
kwargs: RegisterCertificateWithoutCARequestRequestTypeDef = {  # (1)
    "certificatePem": ...,
}

parent.register_certificate_without_ca(**kwargs)
  1. See RegisterCertificateWithoutCARequestRequestTypeDef

register_thing

Provisions a thing in the device registry.

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

Method definition
def register_thing(
    self,
    *,
    templateBody: str,
    parameters: Mapping[str, str] = ...,
) -> RegisterThingResponseTypeDef:  # (1)
    ...
  1. See RegisterThingResponseTypeDef
Usage example with kwargs
kwargs: RegisterThingRequestRequestTypeDef = {  # (1)
    "templateBody": ...,
}

parent.register_thing(**kwargs)
  1. See RegisterThingRequestRequestTypeDef

reject_certificate_transfer

Rejects a pending certificate transfer.

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

Method definition
def reject_certificate_transfer(
    self,
    *,
    certificateId: str,
    rejectReason: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: RejectCertificateTransferRequestRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.reject_certificate_transfer(**kwargs)
  1. See RejectCertificateTransferRequestRequestTypeDef

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

Method definition
def remove_thing_from_billing_group(
    self,
    *,
    billingGroupName: str = ...,
    billingGroupArn: str = ...,
    thingName: str = ...,
    thingArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: RemoveThingFromBillingGroupRequestRequestTypeDef = {  # (1)
    "billingGroupName": ...,
}

parent.remove_thing_from_billing_group(**kwargs)
  1. See RemoveThingFromBillingGroupRequestRequestTypeDef

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

Method definition
def remove_thing_from_thing_group(
    self,
    *,
    thingGroupName: str = ...,
    thingGroupArn: str = ...,
    thingName: str = ...,
    thingArn: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: RemoveThingFromThingGroupRequestRequestTypeDef = {  # (1)
    "thingGroupName": ...,
}

parent.remove_thing_from_thing_group(**kwargs)
  1. See RemoveThingFromThingGroupRequestRequestTypeDef

replace_topic_rule

Replaces the rule.

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

Method definition
def replace_topic_rule(
    self,
    *,
    ruleName: str,
    topicRulePayload: TopicRulePayloadTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TopicRulePayloadTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: ReplaceTopicRuleRequestRequestTypeDef = {  # (1)
    "ruleName": ...,
    "topicRulePayload": ...,
}

parent.replace_topic_rule(**kwargs)
  1. See ReplaceTopicRuleRequestRequestTypeDef

search_index

The query search index.

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

Method definition
def search_index(
    self,
    *,
    queryString: str,
    indexName: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    queryVersion: str = ...,
) -> SearchIndexResponseTypeDef:  # (1)
    ...
  1. See SearchIndexResponseTypeDef
Usage example with kwargs
kwargs: SearchIndexRequestRequestTypeDef = {  # (1)
    "queryString": ...,
}

parent.search_index(**kwargs)
  1. See SearchIndexRequestRequestTypeDef

set_default_authorizer

Sets the default authorizer.

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

Method definition
def set_default_authorizer(
    self,
    *,
    authorizerName: str,
) -> SetDefaultAuthorizerResponseTypeDef:  # (1)
    ...
  1. See SetDefaultAuthorizerResponseTypeDef
Usage example with kwargs
kwargs: SetDefaultAuthorizerRequestRequestTypeDef = {  # (1)
    "authorizerName": ...,
}

parent.set_default_authorizer(**kwargs)
  1. See SetDefaultAuthorizerRequestRequestTypeDef

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

Method definition
def set_default_policy_version(
    self,
    *,
    policyName: str,
    policyVersionId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: SetDefaultPolicyVersionRequestRequestTypeDef = {  # (1)
    "policyName": ...,
    "policyVersionId": ...,
}

parent.set_default_policy_version(**kwargs)
  1. See SetDefaultPolicyVersionRequestRequestTypeDef

set_logging_options

Sets the logging options.

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

Method definition
def set_logging_options(
    self,
    *,
    loggingOptionsPayload: LoggingOptionsPayloadTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See LoggingOptionsPayloadTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: SetLoggingOptionsRequestRequestTypeDef = {  # (1)
    "loggingOptionsPayload": ...,
}

parent.set_logging_options(**kwargs)
  1. See SetLoggingOptionsRequestRequestTypeDef

set_v2_logging_level

Sets the logging level.

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

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
Usage example with kwargs
kwargs: SetV2LoggingLevelRequestRequestTypeDef = {  # (1)
    "logTarget": ...,
    "logLevel": ...,
}

parent.set_v2_logging_level(**kwargs)
  1. See SetV2LoggingLevelRequestRequestTypeDef

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

Method definition
def set_v2_logging_options(
    self,
    *,
    roleArn: str = ...,
    defaultLogLevel: LogLevelType = ...,  # (1)
    disableAllLogs: bool = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See LogLevelType
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: SetV2LoggingOptionsRequestRequestTypeDef = {  # (1)
    "roleArn": ...,
}

parent.set_v2_logging_options(**kwargs)
  1. See SetV2LoggingOptionsRequestRequestTypeDef

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

Method definition
def start_audit_mitigation_actions_task(
    self,
    *,
    taskId: str,
    target: AuditMitigationActionsTaskTargetTypeDef,  # (1)
    auditCheckToActionsMapping: Mapping[str, Sequence[str]],
    clientRequestToken: str,
) -> StartAuditMitigationActionsTaskResponseTypeDef:  # (2)
    ...
  1. See AuditMitigationActionsTaskTargetTypeDef
  2. See StartAuditMitigationActionsTaskResponseTypeDef
Usage example with kwargs
kwargs: StartAuditMitigationActionsTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
    "target": ...,
    "auditCheckToActionsMapping": ...,
    "clientRequestToken": ...,
}

parent.start_audit_mitigation_actions_task(**kwargs)
  1. See StartAuditMitigationActionsTaskRequestRequestTypeDef

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

Method definition
def start_detect_mitigation_actions_task(
    self,
    *,
    taskId: str,
    target: DetectMitigationActionsTaskTargetTypeDef,  # (1)
    actions: Sequence[str],
    clientRequestToken: str,
    violationEventOccurrenceRange: ViolationEventOccurrenceRangeTypeDef = ...,  # (2)
    includeOnlyActiveViolations: bool = ...,
    includeSuppressedAlerts: bool = ...,
) -> StartDetectMitigationActionsTaskResponseTypeDef:  # (3)
    ...
  1. See DetectMitigationActionsTaskTargetTypeDef
  2. See ViolationEventOccurrenceRangeTypeDef
  3. See StartDetectMitigationActionsTaskResponseTypeDef
Usage example with kwargs
kwargs: StartDetectMitigationActionsTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
    "target": ...,
    "actions": ...,
    "clientRequestToken": ...,
}

parent.start_detect_mitigation_actions_task(**kwargs)
  1. See StartDetectMitigationActionsTaskRequestRequestTypeDef

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

Method definition
def start_on_demand_audit_task(
    self,
    *,
    targetCheckNames: Sequence[str],
) -> StartOnDemandAuditTaskResponseTypeDef:  # (1)
    ...
  1. See StartOnDemandAuditTaskResponseTypeDef
Usage example with kwargs
kwargs: StartOnDemandAuditTaskRequestRequestTypeDef = {  # (1)
    "targetCheckNames": ...,
}

parent.start_on_demand_audit_task(**kwargs)
  1. See StartOnDemandAuditTaskRequestRequestTypeDef

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

Method definition
def start_thing_registration_task(
    self,
    *,
    templateBody: str,
    inputFileBucket: str,
    inputFileKey: str,
    roleArn: str,
) -> StartThingRegistrationTaskResponseTypeDef:  # (1)
    ...
  1. See StartThingRegistrationTaskResponseTypeDef
Usage example with kwargs
kwargs: StartThingRegistrationTaskRequestRequestTypeDef = {  # (1)
    "templateBody": ...,
    "inputFileBucket": ...,
    "inputFileKey": ...,
    "roleArn": ...,
}

parent.start_thing_registration_task(**kwargs)
  1. See StartThingRegistrationTaskRequestRequestTypeDef

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

Method definition
def stop_thing_registration_task(
    self,
    *,
    taskId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: StopThingRegistrationTaskRequestRequestTypeDef = {  # (1)
    "taskId": ...,
}

parent.stop_thing_registration_task(**kwargs)
  1. See StopThingRegistrationTaskRequestRequestTypeDef

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

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

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

Method definition
def test_authorization(
    self,
    *,
    authInfos: Sequence[AuthInfoTypeDef],  # (1)
    principal: str = ...,
    cognitoIdentityPoolId: str = ...,
    clientId: str = ...,
    policyNamesToAdd: Sequence[str] = ...,
    policyNamesToSkip: Sequence[str] = ...,
) -> TestAuthorizationResponseTypeDef:  # (2)
    ...
  1. See AuthInfoTypeDef
  2. See TestAuthorizationResponseTypeDef
Usage example with kwargs
kwargs: TestAuthorizationRequestRequestTypeDef = {  # (1)
    "authInfos": ...,
}

parent.test_authorization(**kwargs)
  1. See TestAuthorizationRequestRequestTypeDef

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

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
Usage example with kwargs
kwargs: TestInvokeAuthorizerRequestRequestTypeDef = {  # (1)
    "authorizerName": ...,
}

parent.test_invoke_authorizer(**kwargs)
  1. See TestInvokeAuthorizerRequestRequestTypeDef

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

Method definition
def transfer_certificate(
    self,
    *,
    certificateId: str,
    targetAwsAccount: str,
    transferMessage: str = ...,
) -> TransferCertificateResponseTypeDef:  # (1)
    ...
  1. See TransferCertificateResponseTypeDef
Usage example with kwargs
kwargs: TransferCertificateRequestRequestTypeDef = {  # (1)
    "certificateId": ...,
    "targetAwsAccount": ...,
}

parent.transfer_certificate(**kwargs)
  1. See TransferCertificateRequestRequestTypeDef

untag_resource

Removes the given tags (metadata) from the resource.

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

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

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

Method definition
def update_account_audit_configuration(
    self,
    *,
    roleArn: str = ...,
    auditNotificationTargetConfigurations: Mapping[AuditNotificationTypeType, AuditNotificationTargetTypeDef] = ...,  # (1)
    auditCheckConfigurations: Mapping[str, AuditCheckConfigurationTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See AuditNotificationTypeType AuditNotificationTargetTypeDef
  2. See AuditCheckConfigurationTypeDef
Usage example with kwargs
kwargs: UpdateAccountAuditConfigurationRequestRequestTypeDef = {  # (1)
    "roleArn": ...,
}

parent.update_account_audit_configuration(**kwargs)
  1. See UpdateAccountAuditConfigurationRequestRequestTypeDef

update_audit_suppression

Updates a Device Defender audit suppression.

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

Method definition
def update_audit_suppression(
    self,
    *,
    checkName: str,
    resourceIdentifier: ResourceIdentifierTypeDef,  # (1)
    expirationDate: Union[datetime, str] = ...,
    suppressIndefinitely: bool = ...,
    description: str = ...,
) -> Dict[str, Any]:
    ...
  1. See ResourceIdentifierTypeDef
Usage example with kwargs
kwargs: UpdateAuditSuppressionRequestRequestTypeDef = {  # (1)
    "checkName": ...,
    "resourceIdentifier": ...,
}

parent.update_audit_suppression(**kwargs)
  1. See UpdateAuditSuppressionRequestRequestTypeDef

update_authorizer

Updates an authorizer.

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

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
Usage example with kwargs
kwargs: UpdateAuthorizerRequestRequestTypeDef = {  # (1)
    "authorizerName": ...,
}

parent.update_authorizer(**kwargs)
  1. See UpdateAuthorizerRequestRequestTypeDef

update_billing_group

Updates information about the billing group.

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

Method definition
def update_billing_group(
    self,
    *,
    billingGroupName: str,
    billingGroupProperties: BillingGroupPropertiesTypeDef,  # (1)
    expectedVersion: int = ...,
) -> UpdateBillingGroupResponseTypeDef:  # (2)
    ...
  1. See BillingGroupPropertiesTypeDef
  2. See UpdateBillingGroupResponseTypeDef
Usage example with kwargs
kwargs: UpdateBillingGroupRequestRequestTypeDef = {  # (1)
    "billingGroupName": ...,
    "billingGroupProperties": ...,
}

parent.update_billing_group(**kwargs)
  1. See UpdateBillingGroupRequestRequestTypeDef

update_ca_certificate

Updates a registered CA certificate.

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

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
Usage example with kwargs
kwargs: UpdateCACertificateRequestRequestTypeDef = {  # (1)
    "certificateId": ...,
}

parent.update_ca_certificate(**kwargs)
  1. See UpdateCACertificateRequestRequestTypeDef

update_certificate

Updates the status of the specified certificate.

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

Method definition
def update_certificate(
    self,
    *,
    certificateId: str,
    newStatus: CertificateStatusType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See CertificateStatusType
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: UpdateCertificateRequestRequestTypeDef = {  # (1)
    "certificateId": ...,
    "newStatus": ...,
}

parent.update_certificate(**kwargs)
  1. See UpdateCertificateRequestRequestTypeDef

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

Method definition
def update_custom_metric(
    self,
    *,
    metricName: str,
    displayName: str,
) -> UpdateCustomMetricResponseTypeDef:  # (1)
    ...
  1. See UpdateCustomMetricResponseTypeDef
Usage example with kwargs
kwargs: UpdateCustomMetricRequestRequestTypeDef = {  # (1)
    "metricName": ...,
    "displayName": ...,
}

parent.update_custom_metric(**kwargs)
  1. See UpdateCustomMetricRequestRequestTypeDef

update_dimension

Updates the definition for a dimension.

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

Method definition
def update_dimension(
    self,
    *,
    name: str,
    stringValues: Sequence[str],
) -> UpdateDimensionResponseTypeDef:  # (1)
    ...
  1. See UpdateDimensionResponseTypeDef
Usage example with kwargs
kwargs: UpdateDimensionRequestRequestTypeDef = {  # (1)
    "name": ...,
    "stringValues": ...,
}

parent.update_dimension(**kwargs)
  1. See UpdateDimensionRequestRequestTypeDef

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

Method definition
def update_domain_configuration(
    self,
    *,
    domainConfigurationName: str,
    authorizerConfig: AuthorizerConfigTypeDef = ...,  # (1)
    domainConfigurationStatus: DomainConfigurationStatusType = ...,  # (2)
    removeAuthorizerConfig: bool = ...,
) -> UpdateDomainConfigurationResponseTypeDef:  # (3)
    ...
  1. See AuthorizerConfigTypeDef
  2. See DomainConfigurationStatusType
  3. See UpdateDomainConfigurationResponseTypeDef
Usage example with kwargs
kwargs: UpdateDomainConfigurationRequestRequestTypeDef = {  # (1)
    "domainConfigurationName": ...,
}

parent.update_domain_configuration(**kwargs)
  1. See UpdateDomainConfigurationRequestRequestTypeDef

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

Method definition
def update_dynamic_thing_group(
    self,
    *,
    thingGroupName: str,
    thingGroupProperties: ThingGroupPropertiesTypeDef,  # (1)
    expectedVersion: int = ...,
    indexName: str = ...,
    queryString: str = ...,
    queryVersion: str = ...,
) -> UpdateDynamicThingGroupResponseTypeDef:  # (2)
    ...
  1. See ThingGroupPropertiesTypeDef
  2. See UpdateDynamicThingGroupResponseTypeDef
Usage example with kwargs
kwargs: UpdateDynamicThingGroupRequestRequestTypeDef = {  # (1)
    "thingGroupName": ...,
    "thingGroupProperties": ...,
}

parent.update_dynamic_thing_group(**kwargs)
  1. See UpdateDynamicThingGroupRequestRequestTypeDef

update_event_configurations

Updates the event configurations.

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

Method definition
def update_event_configurations(
    self,
    *,
    eventConfigurations: Mapping[EventTypeType, ConfigurationTypeDef] = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See EventTypeType ConfigurationTypeDef
Usage example with kwargs
kwargs: UpdateEventConfigurationsRequestRequestTypeDef = {  # (1)
    "eventConfigurations": ...,
}

parent.update_event_configurations(**kwargs)
  1. See UpdateEventConfigurationsRequestRequestTypeDef

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

Method definition
def update_fleet_metric(
    self,
    *,
    metricName: str,
    indexName: str,
    queryString: str = ...,
    aggregationType: AggregationTypeTypeDef = ...,  # (1)
    period: int = ...,
    aggregationField: str = ...,
    description: str = ...,
    queryVersion: str = ...,
    unit: FleetMetricUnitType = ...,  # (2)
    expectedVersion: int = ...,
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See AggregationTypeTypeDef
  2. See FleetMetricUnitType
  3. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: UpdateFleetMetricRequestRequestTypeDef = {  # (1)
    "metricName": ...,
    "indexName": ...,
}

parent.update_fleet_metric(**kwargs)
  1. See UpdateFleetMetricRequestRequestTypeDef

update_indexing_configuration

Updates the search configuration.

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

Method definition
def update_indexing_configuration(
    self,
    *,
    thingIndexingConfiguration: ThingIndexingConfigurationTypeDef = ...,  # (1)
    thingGroupIndexingConfiguration: ThingGroupIndexingConfigurationTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See ThingIndexingConfigurationTypeDef
  2. See ThingGroupIndexingConfigurationTypeDef
Usage example with kwargs
kwargs: UpdateIndexingConfigurationRequestRequestTypeDef = {  # (1)
    "thingIndexingConfiguration": ...,
}

parent.update_indexing_configuration(**kwargs)
  1. See UpdateIndexingConfigurationRequestRequestTypeDef

update_job

Updates supported fields of the specified job.

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

Method definition
def update_job(
    self,
    *,
    jobId: str,
    description: str = ...,
    presignedUrlConfig: PresignedUrlConfigTypeDef = ...,  # (1)
    jobExecutionsRolloutConfig: JobExecutionsRolloutConfigTypeDef = ...,  # (2)
    abortConfig: AbortConfigTypeDef = ...,  # (3)
    timeoutConfig: TimeoutConfigTypeDef = ...,  # (4)
    namespaceId: str = ...,
    jobExecutionsRetryConfig: JobExecutionsRetryConfigTypeDef = ...,  # (5)
) -> EmptyResponseMetadataTypeDef:  # (6)
    ...
  1. See PresignedUrlConfigTypeDef
  2. See JobExecutionsRolloutConfigTypeDef
  3. See AbortConfigTypeDef
  4. See TimeoutConfigTypeDef
  5. See JobExecutionsRetryConfigTypeDef
  6. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: UpdateJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.update_job(**kwargs)
  1. See UpdateJobRequestRequestTypeDef

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

Method definition
def update_mitigation_action(
    self,
    *,
    actionName: str,
    roleArn: str = ...,
    actionParams: MitigationActionParamsTypeDef = ...,  # (1)
) -> UpdateMitigationActionResponseTypeDef:  # (2)
    ...
  1. See MitigationActionParamsTypeDef
  2. See UpdateMitigationActionResponseTypeDef
Usage example with kwargs
kwargs: UpdateMitigationActionRequestRequestTypeDef = {  # (1)
    "actionName": ...,
}

parent.update_mitigation_action(**kwargs)
  1. See UpdateMitigationActionRequestRequestTypeDef

update_provisioning_template

Updates a provisioning template.

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

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
Usage example with kwargs
kwargs: UpdateProvisioningTemplateRequestRequestTypeDef = {  # (1)
    "templateName": ...,
}

parent.update_provisioning_template(**kwargs)
  1. See UpdateProvisioningTemplateRequestRequestTypeDef

update_role_alias

Updates a role alias.

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

Method definition
def update_role_alias(
    self,
    *,
    roleAlias: str,
    roleArn: str = ...,
    credentialDurationSeconds: int = ...,
) -> UpdateRoleAliasResponseTypeDef:  # (1)
    ...
  1. See UpdateRoleAliasResponseTypeDef
Usage example with kwargs
kwargs: UpdateRoleAliasRequestRequestTypeDef = {  # (1)
    "roleAlias": ...,
}

parent.update_role_alias(**kwargs)
  1. See UpdateRoleAliasRequestRequestTypeDef

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

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
Usage example with kwargs
kwargs: UpdateScheduledAuditRequestRequestTypeDef = {  # (1)
    "scheduledAuditName": ...,
}

parent.update_scheduled_audit(**kwargs)
  1. See UpdateScheduledAuditRequestRequestTypeDef

update_security_profile

Updates a Device Defender security profile.

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

Method definition
def update_security_profile(
    self,
    *,
    securityProfileName: str,
    securityProfileDescription: str = ...,
    behaviors: Sequence[BehaviorTypeDef] = ...,  # (1)
    alertTargets: Mapping[AlertTargetTypeType, AlertTargetTypeDef] = ...,  # (2)
    additionalMetricsToRetain: Sequence[str] = ...,
    additionalMetricsToRetainV2: Sequence[MetricToRetainTypeDef] = ...,  # (3)
    deleteBehaviors: bool = ...,
    deleteAlertTargets: bool = ...,
    deleteAdditionalMetricsToRetain: bool = ...,
    expectedVersion: int = ...,
) -> UpdateSecurityProfileResponseTypeDef:  # (4)
    ...
  1. See BehaviorTypeDef
  2. See AlertTargetTypeType AlertTargetTypeDef
  3. See MetricToRetainTypeDef
  4. See UpdateSecurityProfileResponseTypeDef
Usage example with kwargs
kwargs: UpdateSecurityProfileRequestRequestTypeDef = {  # (1)
    "securityProfileName": ...,
}

parent.update_security_profile(**kwargs)
  1. See UpdateSecurityProfileRequestRequestTypeDef

update_stream

Updates an existing stream.

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

Method definition
def update_stream(
    self,
    *,
    streamId: str,
    description: str = ...,
    files: Sequence[StreamFileTypeDef] = ...,  # (1)
    roleArn: str = ...,
) -> UpdateStreamResponseTypeDef:  # (2)
    ...
  1. See StreamFileTypeDef
  2. See UpdateStreamResponseTypeDef
Usage example with kwargs
kwargs: UpdateStreamRequestRequestTypeDef = {  # (1)
    "streamId": ...,
}

parent.update_stream(**kwargs)
  1. See UpdateStreamRequestRequestTypeDef

update_thing

Updates the data for a thing.

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

Method definition
def update_thing(
    self,
    *,
    thingName: str,
    thingTypeName: str = ...,
    attributePayload: AttributePayloadTypeDef = ...,  # (1)
    expectedVersion: int = ...,
    removeThingType: bool = ...,
) -> Dict[str, Any]:
    ...
  1. See AttributePayloadTypeDef
Usage example with kwargs
kwargs: UpdateThingRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.update_thing(**kwargs)
  1. See UpdateThingRequestRequestTypeDef

update_thing_group

Update a thing group.

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

Method definition
def update_thing_group(
    self,
    *,
    thingGroupName: str,
    thingGroupProperties: ThingGroupPropertiesTypeDef,  # (1)
    expectedVersion: int = ...,
) -> UpdateThingGroupResponseTypeDef:  # (2)
    ...
  1. See ThingGroupPropertiesTypeDef
  2. See UpdateThingGroupResponseTypeDef
Usage example with kwargs
kwargs: UpdateThingGroupRequestRequestTypeDef = {  # (1)
    "thingGroupName": ...,
    "thingGroupProperties": ...,
}

parent.update_thing_group(**kwargs)
  1. See UpdateThingGroupRequestRequestTypeDef

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

Method definition
def update_thing_groups_for_thing(
    self,
    *,
    thingName: str = ...,
    thingGroupsToAdd: Sequence[str] = ...,
    thingGroupsToRemove: Sequence[str] = ...,
    overrideDynamicGroups: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UpdateThingGroupsForThingRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.update_thing_groups_for_thing(**kwargs)
  1. See UpdateThingGroupsForThingRequestRequestTypeDef

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

Method definition
def update_topic_rule_destination(
    self,
    *,
    arn: str,
    status: TopicRuleDestinationStatusType,  # (1)
) -> Dict[str, Any]:
    ...
  1. See TopicRuleDestinationStatusType
Usage example with kwargs
kwargs: UpdateTopicRuleDestinationRequestRequestTypeDef = {  # (1)
    "arn": ...,
    "status": ...,
}

parent.update_topic_rule_destination(**kwargs)
  1. See UpdateTopicRuleDestinationRequestRequestTypeDef

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

Method definition
def validate_security_profile_behaviors(
    self,
    *,
    behaviors: Sequence[BehaviorTypeDef],  # (1)
) -> ValidateSecurityProfileBehaviorsResponseTypeDef:  # (2)
    ...
  1. See BehaviorTypeDef
  2. See ValidateSecurityProfileBehaviorsResponseTypeDef
Usage example with kwargs
kwargs: ValidateSecurityProfileBehaviorsRequestRequestTypeDef = {  # (1)
    "behaviors": ...,
}

parent.validate_security_profile_behaviors(**kwargs)
  1. See ValidateSecurityProfileBehaviorsRequestRequestTypeDef

get_paginator

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