Table Of Contents


User Guide

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

[ aws . pinpoint ]



Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--application-id <value>
--endpoint-batch-request <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--application-id (string)

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

--endpoint-batch-request (structure)

Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

JSON Syntax:

  "Item": [
      "Address": "string",
      "Attributes": {"string": ["string", ...]
      "Demographic": {
        "AppVersion": "string",
        "Locale": "string",
        "Make": "string",
        "Model": "string",
        "ModelVersion": "string",
        "Platform": "string",
        "PlatformVersion": "string",
        "Timezone": "string"
      "EffectiveDate": "string",
      "EndpointStatus": "string",
      "Id": "string",
      "Location": {
        "City": "string",
        "Country": "string",
        "Latitude": double,
        "Longitude": double,
        "PostalCode": "string",
        "Region": "string"
      "Metrics": {"string": double
      "OptOut": "string",
      "RequestId": "string",
      "User": {
        "UserAttributes": {"string": ["string", ...]
        "UserId": "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.


MessageBody -> (structure)

Provides information about an API request or response.

Message -> (string)

The message that's returned from the API.

RequestID -> (string)

The unique identifier for the request or response.