Pinpoint / Client / remove_attributes

remove_attributes#

Pinpoint.Client.remove_attributes(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.remove_attributes(
    ApplicationId='string',
    AttributeType='string',
    UpdateAttributesRequest={
        'Blacklist': [
            'string',
        ]
    }
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

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

  • AttributeType (string) –

    [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 (dict) –

    [REQUIRED]

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

    • Blacklist (list) –

      An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AttributesResource': {
        'ApplicationId': 'string',
        'AttributeType': 'string',
        'Attributes': [
            'string',
        ]
    }
}

Response Structure

  • (dict) –

    The request succeeded.

    • AttributesResource (dict) –

      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-metric-attributes - 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) –

Exceptions