Amazon Snow Family #X Amz Target=AWSIESnowballJobManagementService.ListLongTermPricing API

openapi: 3.0.0
info:
  version: '2016-06-30'
  x-release: v4
  title: 'Amazon Import/Export Snowball #X Amz Target=AWSIESnowballJobManagementService.CancelCluster #X Amz Target=AWSIESnowballJobManagementService.CancelCluster #X Amz Target=AWSIESnowballJobManagementService.ListLongTermPricing API'
  description: The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the <a href="https://docs.aws.amazon.com/AWSImportExport/latest/ug/api-reference.html">User Guide</a>.
  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: snowball
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/snowball-2016-06-30.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://snowball.{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 Amazon Snowball multi-region endpoint
- url: https://snowball.{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 Amazon Snowball multi-region endpoint
- url: http://snowball.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Snowball endpoint for China (Beijing) and China (Ningxia)
- url: https://snowball.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Snowball endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSIESnowballJobManagementService.ListLongTermPricing'
paths:
  /#X-Amz-Target=AWSIESnowballJobManagementService.ListLongTermPricing:
    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: ListLongTermPricing
      description: Lists all long-term pricing types.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLongTermPricingResult'
              examples:
                ListLongTermPricing200Example:
                  summary: Default ListLongTermPricing 200
                  x-microcks-default: true
                  value:
                    LongTermPricingEntries: example-value
                    NextToken: example-value
        '480':
          description: InvalidResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidResourceException'
              examples:
                ListLongTermPricing480Example:
                  summary: Default ListLongTermPricing 480
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
              examples:
                ListLongTermPricing481Example:
                  summary: Default ListLongTermPricing 481
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListLongTermPricingRequest'
            examples:
              ListLongTermPricingRequestExample:
                summary: Default ListLongTermPricing request
                x-microcks-default: true
                value:
                  MaxResults: example-value
                  NextToken: example-value
      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
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSIESnowballJobManagementService.ListLongTermPricing
      summary: Amazon List Long Term Pricing
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSIESnowballJobManagementService.ListLongTermPricing'
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      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-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
  schemas:
    String:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 1024
    InvalidNextTokenException: {}
    ListLimit:
      type: integer
      minimum: 0
      maximum: 100
    JobId:
      type: string
      pattern: (M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
      minLength: 39
      maxLength: 39
    InvalidResourceException: {}
    SnowballType:
      type: string
      enum:
      - STANDARD
      - EDGE
      - EDGE_C
      - EDGE_CG
      - EDGE_S
      - SNC1_HDD
      - SNC1_SSD
      - V3_5C
      - V3_5S
      - RACK_5U_C
    ListLongTermPricingRequest:
      type: object
      title: ListLongTermPricingRequest
      properties:
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/ListLimit'
          - description: The maximum number of <code>ListLongTermPricing</code> objects to return.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Because HTTP requests are stateless, this is the starting point for your next list of <code>ListLongTermPricing</code> to return.
    LongTermPricingListEntry:
      type: object
      properties:
        LongTermPricingId:
          allOf:
          - $ref: '#/components/schemas/LongTermPricingId'
          - description: The ID of the long-term pricing type for the device.
        LongTermPricingEndDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The end date the long-term pricing contract.
        LongTermPricingStartDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The start date of the long-term pricing contract.
        LongTermPricingType:
          allOf:
          - $ref: '#/components/schemas/LongTermPricingType'
          - description: The type of long-term pricing that was selected for the device.
        CurrentActiveJob:
          allOf:
          - $ref: '#/components/schemas/JobId'
          - description: The current active jobs on the device the long-term pricing type.
        ReplacementJob:
          allOf:
          - $ref: '#/components/schemas/JobId'
          - description: A new device that replaces a device that is ordered with long-term pricing.
        IsLongTermPricingAutoRenew:
          allOf:
          - $ref: '#/components/schemas/JavaBoolean'
          - description: If set to <code>true</code>, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires.
        LongTermPricingStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The status of the long-term pricing type.
        SnowballType:
          allOf:
          - $ref: '#/components/schemas/SnowballType'
          - description: The type of Snow Family devices associated with this long-term pricing job.
        JobIds:
          allOf:
          - $ref: '#/components/schemas/LongTermPricingAssociatedJobIdList'
          - description: The IDs of the jobs that are associated with a long-term pricing type.
      description: Each <code>LongTermPricingListEntry</code> object contains information about a long-term pricing type.
    LongTermPricingId:
      type: string
      pattern: LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
      minLength: 41
      maxLength: 41
    Timestamp:
      type: string
      format: date-time
    ListLongTermPricingResult:
      type: object
      properties:
        LongTermPricingEntries:
          allOf:
          - $ref: '#/components/schemas/LongTermPricingEntryList'
          - description: 'Each <code>LongTermPricingEntry</code> object contains a status, ID, and other information about the <code>LongTermPricing</code> type. '
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Because HTTP requests are stateless, this is the starting point for your next list of returned <code>ListLongTermPricing</code> list.
    JavaBoolean:
      type: boolean
    LongTermPricingAssociatedJobIdList:
      type: array
      items:
        $ref: '#/components/schemas/JobId'
    LongTermPricingType:
      type: string
      enum:
      - OneYear
      - ThreeYear
      - OneMonth
    LongTermPricingEntryList:
      type: array
      items:
        $ref: '#/components/schemas/LongTermPricingListEntry'
  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/snowball/
x-hasEquivalentPaths: true