libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.DetachThingPrincipal

Description

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.

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

Requires permission to access the DetachThingPrincipal action.

Synopsis

Creating a Request

data DetachThingPrincipal Source #

The input for the DetachThingPrincipal operation.

See: newDetachThingPrincipal smart constructor.

Constructors

DetachThingPrincipal' 

Fields

  • thingName :: Text

    The name of the thing.

  • principal :: Text

    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.

Instances

Instances details
Eq DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

Read DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

Show DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

Generic DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

Associated Types

type Rep DetachThingPrincipal :: Type -> Type #

NFData DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

Methods

rnf :: DetachThingPrincipal -> () #

Hashable DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

AWSRequest DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

Associated Types

type AWSResponse DetachThingPrincipal #

ToHeaders DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

ToPath DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

ToQuery DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

type Rep DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

type Rep DetachThingPrincipal = D1 ('MetaData "DetachThingPrincipal" "Amazonka.IoT.DetachThingPrincipal" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DetachThingPrincipal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "principal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DetachThingPrincipal Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

newDetachThingPrincipal Source #

Create a value of DetachThingPrincipal with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:thingName:DetachThingPrincipal', detachThingPrincipal_thingName - The name of the thing.

$sel:principal:DetachThingPrincipal', detachThingPrincipal_principal - 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.

Request Lenses

detachThingPrincipal_principal :: Lens' DetachThingPrincipal Text Source #

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.

Destructuring the Response

data DetachThingPrincipalResponse Source #

The output from the DetachThingPrincipal operation.

See: newDetachThingPrincipalResponse smart constructor.

Constructors

DetachThingPrincipalResponse' 

Fields

Instances

Instances details
Eq DetachThingPrincipalResponse Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

Read DetachThingPrincipalResponse Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

Show DetachThingPrincipalResponse Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

Generic DetachThingPrincipalResponse Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

Associated Types

type Rep DetachThingPrincipalResponse :: Type -> Type #

NFData DetachThingPrincipalResponse Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

type Rep DetachThingPrincipalResponse Source # 
Instance details

Defined in Amazonka.IoT.DetachThingPrincipal

type Rep DetachThingPrincipalResponse = D1 ('MetaData "DetachThingPrincipalResponse" "Amazonka.IoT.DetachThingPrincipal" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DetachThingPrincipalResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDetachThingPrincipalResponse Source #

Create a value of DetachThingPrincipalResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DetachThingPrincipalResponse', detachThingPrincipalResponse_httpStatus - The response's http status code.

Response Lenses