Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]

remove-attributes

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  remove-attributes
--application-id <value>
--attribute-type <value>
--update-attributes-request <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

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

--attribute-type (string)

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-custom-metrics - 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.

--update-attributes-request (structure)

Specifies one or more attributes to remove from all the endpoints that are associated with an application.

Shorthand Syntax:

Blacklist=string,string

JSON Syntax:

{
  "Blacklist": ["string", ...]
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

AttributesResource -> (structure)

Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.

ApplicationId -> (string)

The unique identifier for the application.

AttributeType -> (string)

The type of attribute or attributes that were removed from the endpoints. Valid values are:

  • endpoint-custom-attributes - Custom attributes that describe endpoints
  • endpoint-custom-metrics - Custom metrics that your app reports to Amazon Pinpoint for endpoints
  • endpoint-user-attributes - Custom attributes that describe users

Attributes -> (list)

An array that specifies the names of the attributes that were removed from the endpoints.

(string)