AWS Snow Device Management API

The AWS Snow Device Management API provides programmatic access to manage Snow device jobs, tasks, device resources, and network configurations for edge computing and data transfer operations.

OpenAPI Specification

amazon-snow-family.yaml Raw ↑
openapi: 3.0.0
info:
  version: '2016-06-30'
  x-release: v4
  title: Amazon Import/Export Snowball
  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: [email protected]
    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
externalDocs:
  description: Amazon Web Services documentation
  url: 'https://docs.aws.amazon.com/snowball/'
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)
x-hasEquivalentPaths: true
paths:
  /#X-Amz-Target=AWSIESnowballJobManagementService.CancelCluster:
    post:
      operationId: CancelCluster
      description: Cancels a cluster job. You can only cancel a cluster job while it's in the <code>AwaitingQuorum</code> status. You'll have at least an hour after creating a cluster job to cancel 
        it.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelClusterResult'
              examples:
                CancelCluster200Example:
                  summary: Default CancelCluster 200
                  x-microcks-default: true
                  value: {}
        '480':
          description: KMSRequestFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KMSRequestFailedException'
              examples:
                CancelCluster480Example:
                  summary: Default CancelCluster 480
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidJobStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidJobStateException'
              examples:
                CancelCluster481Example:
                  summary: Default CancelCluster 481
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InvalidResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidResourceException'
              examples:
                CancelCluster482Example:
                  summary: Default CancelCluster 482
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelClusterRequest'
            examples:
              CancelClusterRequestExample:
                summary: Default CancelCluster request
                x-microcks-default: true
                value:
                  ClusterId: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSIESnowballJobManagementService.CancelCluster
      summary: Amazon Cancel Cluster
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=AWSIESnowballJobManagementService.CancelJob:
    post:
      operationId: CancelJob
      description: Cancels the specified job. You can only cancel a job before its <code>JobState</code> value changes to <code>PreparingAppliance</code>. Requesting the <code>ListJobs</code> or 
        <code>DescribeJob</code> action returns a job's <code>JobState</code> as part of the response element data returned.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelJobResult'
              examples:
                CancelJob200Example:
                  summary: Default CancelJob 200
                  x-microcks-default: true
                  value: {}
        '480':
          description: InvalidResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidResourceException'
              examples:
                CancelJob480Example:
                  summary: Default CancelJob 480
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidJobStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidJobStateException'
              examples:
                CancelJob481Example:
                  summary: Default CancelJob 481
                  x-microcks-default: true
                  value: example-value
        '482':
          description: KMSRequestFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KMSRequestFailedException'
              examples:
                CancelJob482Example:
                  summary: Default CancelJob 482
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelJobRequest'
            examples:
              CancelJobRequestExample:
                summary: Default CancelJob request
                x-microcks-default: true
                value:
                  JobId: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSIESnowballJobManagementService.CancelJob
      summary: Amazon Cancel Job
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=AWSIESnowballJobManagementService.CreateAddress:
    post:
      operationId: CreateAddress
      description: 'Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable
        area of your region. If the address is invalid or unsupported, then an exception is thrown.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAddressResult'
              examples:
                CreateAddress200Example:
                  summary: Default CreateAddress 200
                  x-microcks-default: true
                  value:
                    AddressId: example-value
        '480':
          description: InvalidAddressException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidAddressException'
              examples:
                CreateAddress480Example:
                  summary: Default CreateAddress 480
                  x-microcks-default: true
                  value: example-value
        '481':
          description: UnsupportedAddressException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedAddressException'
              examples:
                CreateAddress481Example:
                  summary: Default CreateAddress 481
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAddressRequest'
            examples:
              CreateAddressRequestExample:
                summary: Default CreateAddress request
                x-microcks-default: true
                value:
                  Address: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSIESnowballJobManagementService.CreateAddress
      summary: Amazon Create Address
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=AWSIESnowballJobManagementService.CreateCluster:
    post:
      operationId: CreateCluster
      description: Creates an empty cluster. Each cluster supports five nodes. You use the <a>CreateJob</a> action separately to create the jobs for each of these nodes. The cluster does not ship 
        until these five node jobs have been created.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateClusterResult'
              examples:
                CreateCluster200Example:
                  summary: Default CreateCluster 200
                  x-microcks-default: true
                  value:
                    ClusterId: example-value
                    JobListEntries: example-value
        '480':
          description: InvalidResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidResourceException'
              examples:
                CreateCluster480Example:
                  summary: Default CreateCluster 480
                  x-microcks-default: true
                  value: example-value
        '481':
          description: KMSRequestFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KMSRequestFailedException'
              examples:
                CreateCluster481Example:
                  summary: Default CreateCluster 481
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InvalidInputCombinationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputCombinationException'
              examples:
                CreateCluster482Example:
                  summary: Default CreateCluster 482
                  x-microcks-default: true
                  value: example-value
        '483':
          description: Ec2RequestFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ec2RequestFailedException'
              examples:
                CreateCluster483Example:
                  summary: Default CreateCluster 483
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateClusterRequest'
            examples:
              CreateClusterRequestExample:
                summary: Default CreateCluster request
                x-microcks-default: true
                value:
                  JobType: example-value
                  Resources: example-value
                  OnDeviceServiceConfiguration: example-value
                  Description: example-value
                  AddressId: example-value
                  KmsKeyARN: arn:aws:service:us-east-1:123456789012:resource/example
                  RoleARN: arn:aws:service:us-east-1:123456789012:resource/example
                  SnowballType: example-value
                  ShippingOption: example-value
                  Notification: example-value
                  ForwardingAddressId: example-value
                  TaxDocuments: example-value
                  RemoteManagement: example-value
                  InitialClusterSize: example-value
                  ForceCreateJobs: example-value
                  LongTermPricingIds: example-value
                  SnowballCapacityPreference: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSIESnowballJobManagementService.CreateCluster
      summary: Amazon Create Cluster
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=AWSIESnowballJobManagementService.CreateJob:
    post:
      operationId: CreateJob
      description: '<p>Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place
        to create a job for a Snow device. If you''re creating a job for a node in a cluster, you only need to provide the <code>clusterId</code> value; the other job attributes are inherited from the cluster.
        </p> <note> <p>Only the Snowball; Edge device type is supported when ordering clustered jobs.</p> <p>The device capacity is optional.</p> <p>Availability of device types differ by Amazon Web Services
        Region. For more information about Region availability, see <a href="https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?p=ngi&amp;loc=4">Amazon Web Services Regional
        Services</a>.</p> </note> <p/> <p class="title"> <b>Snow Family devices and their capacities.</b> </p> <ul> <li> <p>Device type: <b>SNC1_SSD</b> </p> <ul> <li> <p>Capacity: T14</p> </li> <li> <p>Description:
        Snowcone </p> </li> </ul> <p/> </li> <li> <p>Device type: <b>SNC1_HDD</b> </p> <ul> <li> <p>Capacity: T8</p> </li> <li> <p>Description: Snowcone </p> </li> </ul> <p/> </li> <li> <p>Device type:
        <b>EDGE_S</b> </p> <ul> <li> <p>Capacity: T98</p> </li> <li> <p>Description: Snowball Edge Storage Optimized for data transfer only </p> </li> </ul> <p/> </li> <li> <p>Device type: <b>EDGE_CG</b>
        </p> <ul> <li> <p>Capacity: T42</p> </li> <li> <p>Description: Snowball Edge Compute Optimized with GPU</p> </li> </ul> <p/> </li> <li> <p>Device type: <b>EDGE_C</b> </p> <ul> <li> <p>Capacity:
        T42</p> </li> <li> <p>Description: Snowball Edge Compute Optimized without GPU</p> </li> </ul> <p/> </li> <li> <p>Device type: <b>EDGE</b> </p> <ul> <li> <p>Capacity: T100</p> </li> <li> <p>Description:
        Snowball Edge Storage Optimized with EC2 Compute</p> </li> </ul> <note> <p>This device is replaced with T98.</p> </note> <p/> </li> <li> <p>Device type: <b>STANDARD</b> </p> <ul> <li> <p>Capacity:
        T50</p> </li> <li> <p>Description: Original Snowball device</p> <note> <p>This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region </p> </note> </li> </ul>
        <p/> </li> <li> <p>Device type: <b>STANDARD</b> </p> <ul> <li> <p>Capacity: T80</p> </li> <li> <p>Description: Original Snowball device</p> <note> <p>This device is only available in the Ningxia,
        Beijing, and Singapore Amazon Web Services Region. </p> </note> </li> </ul> <p/> </li> <li> <p>Snow Family device type: <b>RACK_5U_C</b> </p> <ul> <li> <p>Capacity: T13 </p> </li> <li> <p>Description:
        Snowblade.</p> </li> </ul> </li> <li> <p>Device type: <b>V3_5S</b> </p> <ul> <li> <p>Capacity: T240</p> </li> <li> <p>Description: Snowball Edge Storage Optimized 210TB</p> </li> </ul> </li> </ul>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateJobResult'
              examples:
                CreateJob200Example:
                  summary: Default CreateJob 200
                  x-microcks-default: true
                  value:
                    JobId: example-value
        '480':
          description: InvalidResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidResourceException'
              examples:
                CreateJob480Example:
                  summary: Default CreateJob 480
                  x-microcks-default: true
                  value: example-value
        '481':
          description: KMSRequestFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KMSRequestFailedException'
              examples:
                CreateJob481Example:
                  summary: Default CreateJob 481
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InvalidInputCombinationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputCombinationException'
              examples:
                CreateJob482Example:
                  summary: Default CreateJob 482
                  x-microcks-default: true
                  value: example-value
        '483':
          description: ClusterLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterLimitExceededException'
              examples:
                CreateJob483Example:
                  summary: Default CreateJob 483
                  x-microcks-default: true
                  value: example-value
        '484':
          description: Ec2RequestFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ec2RequestFailedException'
              examples:
                CreateJob484Example:
                  summary: Default CreateJob 484
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobRequest'
            examples:
              CreateJobRequestExample:
                summary: Default CreateJob request
                x-microcks-default: true
                value:
                  JobType: example-value
                  Resources: example-value
                  OnDeviceServiceConfiguration: example-value
                  Description: example-value
                  AddressId: example-value
                  KmsKeyARN: arn:aws:service:us-east-1:123456789012:resource/example
                  RoleARN: arn:aws:service:us-east-1:123456789012:resource/example
                  SnowballCapacityPreference: example-value
                  ShippingOption: example-value
                  Notification: example-value
                  ClusterId: example-value
                  SnowballType: example-value
                  ForwardingAddressId: example-value
                  TaxDocuments: example-value
                  DeviceConfiguration: example-value
                  RemoteManagement: example-value
                  LongTermPricingId: example-value
                  ImpactLevel: example-value
                  PickupDetails: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSIESnowballJobManagementService.CreateJob
      summary: Amazon Create Job
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=AWSIESnowballJobManagementService.CreateLongTermPricing:
    post:
      operationId: CreateLongTermPricing
      description: 'Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services
        provides discounts for long-term pricing. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateLongTermPricingResult'
              examples:
                CreateLongTermPricing200Example:
                  summary: Default CreateLongTermPricing 200
                  x-microcks-default: true
                  value:
                    LongTermPricingId: example-value
        '480':
          description: InvalidResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidResourceException'
              examples:
                CreateLongTermPricing480Example:
                  summary: Default CreateLongTermPricing 480
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLongTermPricingRequest'
            examples:
              CreateLongTermPricingRequestExample:
                summary: Default CreateLongTermPricing request
                x-microcks-default: true
                value:
                  LongTermPricingType: example-value
                  IsLongTermPricingAutoRenew: example-value
                  SnowballType: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSIESnowballJobManagementService.CreateLongTermPricing
      summary: Amazon Create Long Term Pricing
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=AWSIESnowballJobManagementService.CreateReturnShippingLabel:
    post:
      operationId: CreateReturnShippingLabel
      description: Creates a shipping label that will be used to return the Snow device to Amazon Web Services.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateReturnShippingLabelResult'
              examples:
                CreateReturnShippingLabel200Example:
                  summary: Default CreateReturnShippingLabel 200
                  x-microcks-default: true
                  value:
                    Status: Active
        '480':
          description: InvalidResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidResourceException'
              examples:
                CreateReturnShippingLabel480Example:
                  summary: Default CreateReturnShippingLabel 480
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidJobStateException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidJobStateException'
              examples:
                CreateReturnShippingLabel481Example:
                  summary: Default CreateReturnShippingLabel 481
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InvalidInputCombinationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputCombinationException'
              examples:
                CreateReturnShippingLabel482Example:
                  summary: Default CreateReturnShippingLabel 482
                  x-microcks-default: true
                  value: example-value
        '483':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                CreateReturnShippingLabel483Example:
                  summary: Default CreateReturnShippingLabel 483
                  x-microcks-default: true
                  value: example-value
        '484':
          description: ReturnShippingLabelAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReturnShippingLabelAlreadyExistsException'
              examples:
                CreateReturnShippingLabel484Example:
                  summary: Default CreateReturnShippingLabel 484
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReturnShippingLabelRequest'
            examples:
              CreateReturnShippingLabelRequestExample:
                summary: Default CreateReturnShippingLabel request
                x-microcks-default: true
                value:
                  JobId: example-value
                  ShippingOption: example-value
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSIESnowballJobManagementService.CreateReturnShippingLabel
      summary: Amazon Create Return Shipping Label
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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'
  /#X-Amz-Target=AWSIESnowballJobManagementService.DescribeAddress:
    post:
      operationId: DescribeAddress
      description: Takes an <code>AddressId</code> and returns specific details about that address in the form of an <code>Address</code> object.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAddressResult'
              examples:
                DescribeAddress200Example:
                  summary: Default DescribeAddress 200
                  x-microcks-default: true
                  value:
                    Address: example-value
        '480':
          description: InvalidResourceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidResourceException'
              examples:
                DescribeAddress480Example:
                  summary: Default DescribeAddress 480
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeAddressRequest'
            examples:
              DescribeAddressRequestExample:
                summary: Default DescribeAddress request
                x-microcks-default: true
                value:
                  AddressId: example-value
      parameters:
      

# --- truncated at 32 KB (185 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-snow-family/refs/heads/main/openapi/amazon-snow-family.yaml