Amazon Marketplace ListEntities API

openapi: 3.0.0
info:
  version: '2018-09-17'
  x-release: v4
  title: AWS Marketplace Catalog Service CancelChangeSet#catalog&changeSetId ListEntities API
  description: <p>Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace. </p> <p>You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: marketplace-catalog
  x-aws-signingName: aws-marketplace
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/marketplace-catalog-2018-09-17.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://catalog.marketplace.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Marketplace Catalog multi-region endpoint
- url: https://catalog.marketplace.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Marketplace Catalog multi-region endpoint
- url: http://catalog.marketplace.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Marketplace Catalog endpoint for China (Beijing) and China (Ningxia)
- url: https://catalog.marketplace.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Marketplace Catalog endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: ListEntities
paths:
  /ListEntities:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: ListEntities
      description: Provides the list of entities of a given type.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEntitiesResponse'
        '480':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '483':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '484':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      parameters:
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - Catalog
              - EntityType
              properties:
                Catalog:
                  description: 'The catalog related to the request. Fixed value: <code>AWSMarketplace</code> '
                  type: string
                  pattern: ^[a-zA-Z]+$
                  minLength: 1
                  maxLength: 64
                EntityType:
                  description: The type of entities to retrieve.
                  type: string
                  pattern: ^[a-zA-Z]+$
                  minLength: 1
                  maxLength: 255
                FilterList:
                  description: An array of filter objects. Each filter object contains two attributes, <code>filterName</code> and <code>filterValues</code>.
                  type: array
                  items:
                    $ref: '#/components/schemas/Filter'
                  minItems: 1
                  maxItems: 8
                Sort:
                  description: An object that contains two attributes, <code>SortBy</code> and <code>SortOrder</code>.
                  type: object
                  properties:
                    SortBy:
                      allOf:
                      - $ref: '#/components/schemas/SortBy'
                      - description: <p>For <code>ListEntities</code>, supported attributes include <code>LastModifiedDate</code> (default), <code>Visibility</code>, <code>EntityId</code>, and <code>Name</code>.</p> <p>For <code>ListChangeSets</code>, supported attributes include <code>StartTime</code> and <code>EndTime</code>.</p>
                    SortOrder:
                      allOf:
                      - $ref: '#/components/schemas/SortOrder'
                      - description: The sorting order. Can be <code>ASCENDING</code> or <code>DESCENDING</code>. The default value is <code>DESCENDING</code>.
                NextToken:
                  description: The value of the next token, if it exists. Null if there are no more results.
                  type: string
                  pattern: ^[\w+=.:@\-\/]$
                  minLength: 1
                  maxLength: 2048
                MaxResults:
                  description: Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
                  type: integer
                  minimum: 1
                  maximum: 50
                OwnershipType:
                  description: ''
                  type: string
                  enum:
                  - SELF
                  - SHARED
      summary: Amazon Marketplace List Entities
      tags:
      - ListEntities
components:
  schemas:
    ResourceNotFoundException: {}
    Filter:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/FilterName'
          - description: <p>For <code>ListEntities</code>, the supported value for this is an <code>EntityId</code>.</p> <p>For <code>ListChangeSets</code>, the supported values are as follows:</p>
        ValueList:
          allOf:
          - $ref: '#/components/schemas/ValueList'
          - description: <p> <code>ListEntities</code> - This is a list of unique <code>EntityId</code>s.</p> <p> <code>ListChangeSets</code> - The supported filter names and associated <code>ValueList</code>s is as follows:</p> <ul> <li> <p> <code>ChangeSetName</code> - The supported <code>ValueList</code> is a list of non-unique <code>ChangeSetName</code>s. These are defined when you call the <code>StartChangeSet</code> action.</p> </li> <li> <p> <code>Status</code> - The supported <code>ValueList</code> is a list of statuses for all change set requests.</p> </li> <li> <p> <code>EntityId</code> - The supported <code>ValueList</code> is a list of unique <code>EntityId</code>s.</p> </li> <li> <p> <code>BeforeStartTime</code> - The supported <code>ValueList</code> is a list of all change sets that started before the filter value.</p> </li> <li> <p> <code>AfterStartTime</code> - The supported <code>ValueList</code> is a list of all change sets that started after the filter value.</p> </li> <li> <p> <code>BeforeEndTime</code> - The supported <code>ValueList</code> is a list of all change sets that ended before the filter value.</p> </li> <li> <p> <code>AfterEndTime</code> - The supported <code>ValueList</code> is a list of all change sets that ended after the filter value.</p> </li> </ul>
      description: A filter object, used to optionally filter results from calls to the <code>ListEntities</code> and <code>ListChangeSets</code> actions.
    ThrottlingException: {}
    VisibilityValue:
      type: string
      pattern: ^[a-zA-Z]+$
      minLength: 1
      maxLength: 64
    ValueList:
      type: array
      items:
        $ref: '#/components/schemas/FilterValueContent'
      minItems: 1
      maxItems: 10
    ResourceId:
      type: string
      pattern: ^[\w\-]+$
      minLength: 1
      maxLength: 255
    FilterValueContent:
      type: string
      pattern: ^(.)+$
      minLength: 1
      maxLength: 255
    EntityNameString:
      type: string
      pattern: ^\\S+[\\S\\s]*
      minLength: 1
      maxLength: 255
    FilterName:
      type: string
      pattern: ^[a-zA-Z]+$
      minLength: 1
      maxLength: 255
    NextToken:
      type: string
      pattern: ^[\w+=.:@\-\/]$
      minLength: 1
      maxLength: 2048
    AccessDeniedException: {}
    EntityType:
      type: string
      pattern: ^[a-zA-Z]+$
      minLength: 1
      maxLength: 255
    ValidationException: {}
    InternalServiceException: {}
    DateTimeISO8601:
      type: string
      pattern: ^([\d]{4})\-(1[0-2]|0[1-9])\-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$
      minLength: 20
      maxLength: 20
    EntitySummary:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/EntityNameString'
          - description: The name for the entity. This value is not unique. It is defined by the seller.
        EntityType:
          allOf:
          - $ref: '#/components/schemas/EntityType'
          - description: The type of the entity.
        EntityId:
          allOf:
          - $ref: '#/components/schemas/ResourceId'
          - description: The unique identifier for the entity.
        EntityArn:
          allOf:
          - $ref: '#/components/schemas/ARN'
          - description: The ARN associated with the unique identifier for the entity.
        LastModifiedDate:
          allOf:
          - $ref: '#/components/schemas/DateTimeISO8601'
          - description: The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
        Visibility:
          allOf:
          - $ref: '#/components/schemas/VisibilityValue'
          - description: 'The visibility status of the entity to buyers. This value can be <code>Public</code> (everyone can view the entity), <code>Limited</code> (the entity is visible to limited accounts only), or <code>Restricted</code> (the entity was published and then unpublished and only existing buyers can view it). '
      description: This object is a container for common summary information about the entity. The summary doesn't contain the whole entity structure, but it does contain information common across all entities.
    ListEntitiesResponse:
      type: object
      properties:
        EntitySummaryList:
          allOf:
          - $ref: '#/components/schemas/EntitySummaryList'
          - description: ' Array of <code>EntitySummary</code> object.'
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The value of the next token if it exists. Null if there is no more result.
    SortOrder:
      type: string
      enum:
      - ASCENDING
      - DESCENDING
    SortBy:
      type: string
      pattern: ^[a-zA-Z]+$
      minLength: 1
      maxLength: 255
    EntitySummaryList:
      type: array
      items:
        $ref: '#/components/schemas/EntitySummary'
    ARN:
      type: string
      pattern: ^[a-zA-Z0-9:*/-]+$
      minLength: 1
      maxLength: 2048
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/marketplace/