libZSservicesZSamazonka-pinpointZSamazonka-pinpoint
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.Pinpoint.RemoveAttributes

Description

Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

Synopsis

Creating a Request

data RemoveAttributes Source #

See: newRemoveAttributes smart constructor.

Constructors

RemoveAttributes' 

Fields

  • attributeType :: Text

    The type of attribute or attributes to remove. Valid values are:

    • endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.
    • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
    • endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.
  • applicationId :: Text

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • updateAttributesRequest :: UpdateAttributesRequest
     

Instances

Instances details
Eq RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

(==) :: RemoveAttributes -> RemoveAttributes -> Bool #

(/=) :: RemoveAttributes -> RemoveAttributes -> Bool #

Read RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

readsPrec :: Int -> ReadS RemoveAttributes #

readList :: ReadS [RemoveAttributes] #

readPrec :: ReadPrec RemoveAttributes #

readListPrec :: ReadPrec [RemoveAttributes] #

Show RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

showsPrec :: Int -> RemoveAttributes -> ShowS #

show :: RemoveAttributes -> String #

showList :: [RemoveAttributes] -> ShowS #

Generic RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Associated Types

type Rep RemoveAttributes :: Type -> Type #

Methods

from :: RemoveAttributes -> Rep RemoveAttributes x #

to :: Rep RemoveAttributes x -> RemoveAttributes #

NFData RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

rnf :: RemoveAttributes -> () #

Hashable RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

hashWithSalt :: Int -> RemoveAttributes -> Int #

hash :: RemoveAttributes -> Int #

ToJSON RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

toJSON :: RemoveAttributes -> Value #

toEncoding :: RemoveAttributes -> Encoding #

toJSONList :: [RemoveAttributes] -> Value #

toEncodingList :: [RemoveAttributes] -> Encoding #

AWSRequest RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Associated Types

type AWSResponse RemoveAttributes #

Methods

request :: RemoveAttributes -> Request RemoveAttributes #

response :: MonadResource m => Logger -> Service -> Proxy RemoveAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RemoveAttributes))) #

ToHeaders RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

toHeaders :: RemoveAttributes -> [Header] #

ToPath RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

toPath :: RemoveAttributes -> ByteString #

ToQuery RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

toQuery :: RemoveAttributes -> QueryString #

type Rep RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

type Rep RemoveAttributes = D1 ('MetaData "RemoveAttributes" "Amazonka.Pinpoint.RemoveAttributes" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "RemoveAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updateAttributesRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UpdateAttributesRequest))))
type AWSResponse RemoveAttributes Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

type AWSResponse RemoveAttributes = RemoveAttributesResponse

newRemoveAttributes Source #

Arguments

:: Text

$sel:attributeType:RemoveAttributes'

-> Text

$sel:applicationId:RemoveAttributes'

-> UpdateAttributesRequest

$sel:updateAttributesRequest:RemoveAttributes'

-> RemoveAttributes 

Create a value of RemoveAttributes 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:attributeType:RemoveAttributes', removeAttributes_attributeType - The type of attribute or attributes to remove. Valid values are:

  • endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.
  • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
  • endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.

$sel:applicationId:RemoveAttributes', removeAttributes_applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

$sel:updateAttributesRequest:RemoveAttributes', removeAttributes_updateAttributesRequest - Undocumented member.

Request Lenses

removeAttributes_attributeType :: Lens' RemoveAttributes Text Source #

The type of attribute or attributes to remove. Valid values are:

  • endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.
  • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.
  • endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.

removeAttributes_applicationId :: Lens' RemoveAttributes Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

removeAttributes_updateAttributesRequest :: Lens' RemoveAttributes UpdateAttributesRequest Source #

Undocumented member.

Destructuring the Response

data RemoveAttributesResponse Source #

See: newRemoveAttributesResponse smart constructor.

Constructors

RemoveAttributesResponse' 

Fields

Instances

Instances details
Eq RemoveAttributesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

(==) :: RemoveAttributesResponse -> RemoveAttributesResponse -> Bool #

(/=) :: RemoveAttributesResponse -> RemoveAttributesResponse -> Bool #

Read RemoveAttributesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

readsPrec :: Int -> ReadS RemoveAttributesResponse #

readList :: ReadS [RemoveAttributesResponse] #

readPrec :: ReadPrec RemoveAttributesResponse #

readListPrec :: ReadPrec [RemoveAttributesResponse] #

Show RemoveAttributesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

showsPrec :: Int -> RemoveAttributesResponse -> ShowS #

show :: RemoveAttributesResponse -> String #

showList :: [RemoveAttributesResponse] -> ShowS #

Generic RemoveAttributesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Associated Types

type Rep RemoveAttributesResponse :: Type -> Type #

Methods

from :: RemoveAttributesResponse -> Rep RemoveAttributesResponse x #

to :: Rep RemoveAttributesResponse x -> RemoveAttributesResponse #

NFData RemoveAttributesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

Methods

rnf :: RemoveAttributesResponse -> () #

type Rep RemoveAttributesResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.RemoveAttributes

type Rep RemoveAttributesResponse = D1 ('MetaData "RemoveAttributesResponse" "Amazonka.Pinpoint.RemoveAttributes" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "RemoveAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "attributesResource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AttributesResource)))

newRemoveAttributesResponse Source #

Arguments

:: Int

$sel:httpStatus:RemoveAttributesResponse'

-> AttributesResource

$sel:attributesResource:RemoveAttributesResponse'

-> RemoveAttributesResponse 

Create a value of RemoveAttributesResponse 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:RemoveAttributesResponse', removeAttributesResponse_httpStatus - The response's http status code.

$sel:attributesResource:RemoveAttributesResponse', removeAttributesResponse_attributesResource - Undocumented member.

Response Lenses

removeAttributesResponse_httpStatus :: Lens' RemoveAttributesResponse Int Source #

The response's http status code.

removeAttributesResponse_attributesResource :: Lens' RemoveAttributesResponse AttributesResource Source #

Undocumented member.