Amazon Pinpoint · JSON Structure

Amazon Pinpoint Segment Import Resource Structure

Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.

Type: object Properties: 6 Required: 5
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

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

Properties

ChannelCounts ExternalId Format RoleArn S3Url Size

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-segment-import-resource-structure.json",
  "name": "SegmentImportResource",
  "description": "Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.",
  "type": "object",
  "properties": {
    "ChannelCounts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOf__integer"
        },
        {
          "description": "The number of channel types in the endpoint definitions that were imported to create the segment."
        }
      ]
    },
    "ExternalId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint."
        }
      ]
    },
    "Format": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Format"
        },
        {
          "description": "The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format."
        }
      ]
    },
    "RoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from."
        }
      ]
    },
    "S3Url": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment."
        }
      ]
    },
    "Size": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The number of endpoint definitions that were imported successfully to create the segment."
        }
      ]
    }
  },
  "required": [
    "Format",
    "S3Url",
    "Size",
    "ExternalId",
    "RoleArn"
  ]
}

Work with this as data

Every JSON Structure here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Structure
curl "https://apis.io/api/v1/json-structures/amazon-pinpoint-segment-import-resource-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.