Skip to content

Remove Attributes

pinpoint_remove_attributes R Documentation

Removes one or more custom attributes, of the same attribute type, from the application

Description

Removes one or more custom attributes, of the same attribute type, from the application. Existing endpoints still have the attributes but Amazon Pinpoint will stop capturing new or changed values for these attributes.

Usage

pinpoint_remove_attributes(ApplicationId, AttributeType,
  UpdateAttributesRequest)

Arguments

ApplicationId

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

AttributeType

[required] 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.

UpdateAttributesRequest

[required]

Value

A list with the following syntax: 

list(
  AttributesResource = list(
    ApplicationId = "string",
    AttributeType = "string",
    Attributes = list(
      "string"
    )
  )
)

Request syntax

svc$remove_attributes(
  ApplicationId = "string",
  AttributeType = "string",
  UpdateAttributesRequest = list(
    Blacklist = list(
      "string"
    )
  )
)