IoT / Client / detach_thing_principal

detach_thing_principal#

IoT.Client.detach_thing_principal(**kwargs)#

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

Note

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

Requires permission to access the DetachThingPrincipal action.

See also: AWS API Documentation

Request Syntax

response = client.detach_thing_principal(
    thingName='string',
    principal='string'
)
Parameters:

  • thingName (string) –

    [REQUIRED]

    The name of the thing.

  • principal (string) –

    [REQUIRED]

    If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    The output from the DetachThingPrincipal operation.

Exceptions

  • IoT.Client.exceptions.ResourceNotFoundException

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.UnauthorizedException

  • IoT.Client.exceptions.ServiceUnavailableException

  • IoT.Client.exceptions.InternalFailureException