attributes
Creates, updates, deletes, gets or lists an attributes resource.
Overview
| Name | attributes |
| Type | Resource |
| Id | aws.pinpoint.attributes |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
remove_attributes | update | application-id, attribute-type, region, UpdateAttributesRequest | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
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-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. |
region | string | AWS region (default: us-east-1) |
UPDATE examples
- remove_attributes
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.
UPDATE aws.pinpoint.attributes
SET
UpdateAttributesRequest = '{{ UpdateAttributesRequest }}'
WHERE
`application-id` = '{{ application-id }}' --required
AND `attribute-type` = '{{ attribute-type }}' --required
AND region = '{{ region }}' --required
AND UpdateAttributesRequest = '{{ UpdateAttributesRequest }}' --required
RETURNING
attributes_resource;