Amazon Pinpoint · JSON Structure

Amazon Pinpoint Attributes Resource Structure

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

Type: object Properties: 3 Required: 2
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

AttributesResource is a JSON Structure definition published by Amazon Pinpoint, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ApplicationId AttributeType Attributes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-structure/amazon-pinpoint-attributes-resource-structure.json",
  "name": "AttributesResource",
  "description": "Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.",
  "type": "object",
  "properties": {
    "ApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the application."
        }
      ]
    },
    "AttributeType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "<p>The type of attribute or attributes that were removed from the endpoints. Valid values are:</p> <ul><li><p>endpoint-custom-attributes - Custom attributes that describe endpoints.</p></li> <li><p>endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.</p></li> <li><p>endpoint-user-attributes - Custom attributes that describe users.</p></li></ul>"
        }
      ]
    },
    "Attributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOf__string"
        },
        {
          "description": "An array that specifies the names of the attributes that were removed from the endpoints."
        }
      ]
    }
  },
  "required": [
    "AttributeType",
    "ApplicationId"
  ]
}