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.CreateCluster 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.CreateCluster'
paths:
  /#X-Amz-Target=AWSIESnowballJobManagementService.CreateCluster:
    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: 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
      tags:
      - '#X Amz Target=AWSIESnowballJobManagementService.CreateCluster'
components:
  schemas:
    AmiId:
      type: string
      pattern: (ami-[0-9a-f]{8})|(ami-[0-9a-f]{17})
      minLength: 12
      maxLength: 21
    DeviceServiceName:
      type: string
      enum:
      - NFS_ON_DEVICE_SERVICE
      - S3_ON_DEVICE_SERVICE
    SnsTopicARN:
      type: string
      pattern: arn:aws.*:sns:.*:[0-9]{12}:.*
      maxLength: 255
    Ec2RequestFailedException: {}
    String:
      type: string
      pattern: .*
      minLength: 1
      maxLength: 1024
    EventTriggerDefinition:
      type: object
      properties:
        EventResourceARN:
          allOf:
          - $ref: '#/components/schemas/ResourceARN'
          - description: The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
      description: The container for the <a>EventTriggerDefinition$EventResourceARN</a>.
    SnowballCapacity:
      type: string
      enum:
      - T50
      - T80
      - T100
      - T42
      - T98
      - T8
      - T14
      - T32
      - NoPreference
      - T240
      - T13
    TGWOnDeviceServiceConfiguration:
      type: object
      properties:
        StorageLimit:
          allOf:
          - $ref: '#/components/schemas/StorageLimit'
          - description: The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.
        StorageUnit:
          allOf:
          - $ref: '#/components/schemas/StorageUnit'
          - description: The scale unit of the virtual tapes on the device.
      description: An object that represents the metadata and configuration settings for the Storage Gateway service Tape Gateway type on an Amazon Web Services Snow Family device.
    JobType:
      type: string
      enum:
      - IMPORT
      - EXPORT
      - LOCAL_USE
    KmsKeyARN:
      type: string
      pattern: arn:aws.*:kms:.*:[0-9]{12}:key/.*
      maxLength: 255
    Notification:
      type: object
      properties:
        SnsTopicARN:
          allOf:
          - $ref: '#/components/schemas/SnsTopicARN'
          - description: <p>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action.</p> <p>You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> Amazon Simple Notification Service (Amazon SNS) API action.</p>
        JobStatesToNotify:
          allOf:
          - $ref: '#/components/schemas/JobStateList'
          - description: The list of job states that will trigger a notification for this job.
        NotifyAll:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Any change in job state will trigger a notification for this job.
        DevicePickupSnsTopicARN:
          allOf:
          - $ref: '#/components/schemas/SnsTopicARN'
          - description: Used to send SNS notifications for the person picking up the device (identified during job creation).
      description: <p>The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The <code>Notification</code> object is returned as a part of the response syntax of the <code>DescribeJob</code> action in the <code>JobMetadata</code> data type.</p> <p>When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the <code>JobStatesToNotify</code> array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with <code>NotifyAll</code> set to true.</p>
    OnDeviceServiceConfiguration:
      type: object
      properties:
        NFSOnDeviceService:
          allOf:
          - $ref: '#/components/schemas/NFSOnDeviceServiceConfiguration'
          - description: Represents the NFS (Network File System) service on a Snow Family device.
        TGWOnDeviceService:
          allOf:
          - $ref: '#/components/schemas/TGWOnDeviceServiceConfiguration'
          - description: Represents the Storage Gateway service Tape Gateway type on a Snow Family device.
        EKSOnDeviceService:
          allOf:
          - $ref: '#/components/schemas/EKSOnDeviceServiceConfiguration'
          - description: The configuration of EKS Anywhere on the Snow Family device.
        S3OnDeviceService:
          allOf:
          - $ref: '#/components/schemas/S3OnDeviceServiceConfiguration'
          - description: Configuration for Amazon S3 compatible storage on Snow family devices.
      description: An object that represents the metadata and configuration settings for services on an Amazon Web Services Snow Family device.
    Ec2AmiResource:
      type: object
      required:
      - AmiId
      properties:
        AmiId:
          allOf:
          - $ref: '#/components/schemas/AmiId'
          - description: The ID of the AMI in Amazon EC2.
        SnowballAmiId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The ID of the AMI on the Snow device.
      description: A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2-compatible AMI ID and the Snow device AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.
    GSTIN:
      type: string
      pattern: \d{2}[A-Z]{5}\d{4}[A-Z]{1}[A-Z\d]{1}[Z]{1}[A-Z\d]{1}
      minLength: 15
      maxLength: 15
    ServiceSize:
      type: integer
      minimum: 3
      maximum: 16
    ResourceARN:
      type: string
      pattern: arn:aws.*:*
      maxLength: 255
    Boolean:
      type: boolean
    Ec2AmiResourceList:
      type: array
      items:
        $ref: '#/components/schemas/Ec2AmiResource'
    S3StorageLimit:
      type: number
      format: double
      minimum: 0
    S3Resource:
      type: object
      properties:
        BucketArn:
          allOf:
          - $ref: '#/components/schemas/ResourceARN'
          - description: The Amazon Resource Name (ARN) of an Amazon S3 bucket.
        KeyRange:
          allOf:
          - $ref: '#/components/schemas/KeyRange'
          - description: For export jobs, you can provide an optional <code>KeyRange</code> within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive <code>BeginMarker</code>, an inclusive <code>EndMarker</code>, or both. Ranges are UTF-8 binary sorted.
        TargetOnDeviceServices:
          allOf:
          - $ref: '#/components/schemas/TargetOnDeviceServiceList'
          - description: Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).
      description: Each <code>S3Resource</code> object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optional <code>KeyRange</code> value. The length of the range is defined at job creation, and has either an inclusive <code>BeginMarker</code>, an inclusive <code>EndMarker</code>, or both. Ranges are UTF-8 binary sorted.
    TargetOnDeviceServiceList:
      type: array
      items:
        $ref: '#/components/schemas/TargetOnDeviceService'
    JobResource:
      type: object
      properties:
        S3Resources:
          allOf:
          - $ref: '#/components/schemas/S3ResourceList'
          - description: An array of <code>S3Resource</code> objects.
        LambdaResources:
          allOf:
          - $ref: '#/components/schemas/LambdaResourceList'
          - description: The Python-language Lambda functions for this job.
        Ec2AmiResources:
          allOf:
          - $ref: '#/components/schemas/Ec2AmiResourceList'
          - description: The Amazon Machine Images (AMIs) associated with this job.
      description: Contains an array of Amazon Web Services resource objects. Each object represents an Amazon S3 bucket, an Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is associated with a particular job.
    LongTermPricingIdList:
      type: array
      items:
        $ref: '#/components/schemas/LongTermPricingId'
    RoleARN:
      type: string
      pattern: arn:aws.*:iam::[0-9]{12}:role/.*
      maxLength: 255
    LambdaResourceList:
      type: array
      items:
        $ref: '#/components/schemas/LambdaResource'
    KMSRequestFailedException: {}
    JobStateList:
      type: array
      items:
        $ref: '#/components/schemas/JobState'
    InvalidResourceException: {}
    S3ResourceList:
      type: array
      items:
        $ref: '#/components/schemas/S3Resource'
    ClusterId:
      type: string
      pattern: CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
      minLength: 39
      maxLength: 39
    SnowballType:
      type: string
      enum:
      - STANDARD
      - EDGE
      - EDGE_C
      - EDGE_CG
      - EDGE_S
      - SNC1_HDD
      - SNC1_SSD
      - V3_5C
      - V3_5S
      - RACK_5U_C
    EKSOnDeviceServiceConfiguration:
      type: object
      properties:
        KubernetesVersion:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Kubernetes version for EKS Anywhere on the Snow Family device.
        EKSAnywhereVersion:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The version of EKS Anywhere on the Snow Family device.
      description: An object representing the metadata and configuration settings of EKS Anywhere on the Snow Family device.
    EventTriggerDefinitionList:
      type: array
      items:
        $ref: '#/components/schemas/EventTriggerDefinition'
    JobState:
      type: string
      enum:
      - New
      - PreparingAppliance
      - PreparingShipment
      - InTransitToCustomer
      - WithCustomer
      - InTransitToAWS
      - WithAWSSortingFacility
      - WithAWS
      - InProgress
      - Complete
      - Cancelled
      - Listing
      - Pending
    NodeFaultTolerance:
      type: integer
      minimum: 1
      maximum: 4
    StorageUnit:
      type: string
      enum:
      - TB
    StorageLimit:
      type: integer
      minimum: 0
    ShippingOption:
      type: string
      enum:
      - SECOND_DAY
      - NEXT_DAY
      - EXPRESS
      - STANDARD
    KeyRange:
      type: object
      properties:
        BeginMarker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
        EndMarker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
      description: Contains a key range. For export jobs, a <code>S3Resource</code> object can have an optional <code>KeyRange</code> value. The length of the range is defined at job creation, and has either an inclusive <code>BeginMarker</code>, an inclusive <code>EndMarker</code>, or both. Ranges are UTF-8 binary sorted.
    JobListEntryList:
      type: array
      items:
        $ref: '#/components/schemas/JobListEntry'
    JobListEntry:
      type: object
      properties:
        JobId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The automatically generated ID for a job, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.
        JobState:
          allOf:
          - $ref: '#/components/schemas/JobState'
          - description: The current state of this job.
        IsMaster:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular main job are listed, because they are created after the main job is created.
        JobType:
          allOf:
          - $ref: '#/components/schemas/JobType'
          - description: The type of job.
        SnowballType:
          allOf:
          - $ref: '#/components/schemas/SnowballType'
          - description: The type of device used with this job.
        CreationDate:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The creation date for this job.
        Description:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The optional description of this specific job, for example <code>Important Photos 2016-08-11</code>.
      description: Each <code>JobListEntry</code> object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of an export job.
    InitialClusterSize:
      type: integer
      minimum: 0
      maximum: 16
    TargetOnDeviceService:
      type: object
      properties:
        ServiceName:
          allOf:
          - $ref: '#/components/schemas/DeviceServiceName'
          - description: Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
        TransferOption:
          allOf:
          - $ref: '#/components/schemas/TransferOption'
          - description: Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.
      description: An object that represents the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).
    CreateClusterRequest:
      type: object
      required:
      - JobType
      - AddressId
      - SnowballType
      - ShippingOption
      title: CreateClusterRequest
      properties:
        JobType:
          allOf:
          - $ref: '#/components/schemas/JobType'
          - description: <p>The type of job for this cluster. Currently, the only job type supported for clusters is <code>LOCAL_USE</code>.</p> <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
        Resources:
          allOf:
          - $ref: '#/components/schemas/JobResource'
          - description: 'The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language. '
        OnDeviceServiceConfiguration:
          allOf:
          - $ref: '#/components/schemas/OnDeviceServiceConfiguration'
          - description: Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
        Description:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: An optional description of this specific cluster, for example <code>Environmental Data Cluster-01</code>.
        AddressId:
          allOf:
          - $ref: '#/components/schemas/AddressId'
          - description: The ID for the address that you want the cluster shipped to.
        KmsKeyARN:
          allOf:
          - $ref: '#/components/schemas/KmsKeyARN'
          - description: 'The <code>KmsKeyARN</code> value that you want to associate with this cluster. <code>KmsKeyARN</code> values are created by using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in Key Management Service (KMS). '
        RoleARN:
          allOf:
          - $ref: '#/components/schemas/RoleARN'
          - description: The <code>RoleARN</code> that you want to associate with this cluster. <code>RoleArn</code> values are created by using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).
        SnowballType:
          allOf:
          - $ref: '#/components/schemas/SnowballType'
          - description: <p>The type of Snow Family devices to use for this cluster. </p> <note> <p>For cluster jobs, Amazon Web Services Snow Family currently supports only the <code>EDGE</code> device type.</p> </note> <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
        ShippingOption:
          allOf:
          - $ref: '#/components/schemas/ShippingOption'
          - description: '<p>The shipping speed for each node in this cluster. This speed doesn''t dictate how soon you''ll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: </p> <ul> <li> <p>In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.</p> </li> <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li> <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li> <li> <p>In the United States of America (US), you have access to one-day shipping and two-day shipping.</p> </li> </ul> <ul> <li> <p>In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.</p> </li> <li> <p>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</p> </li> <li> <p>In India, Snow devices are delivered in one to seven days.</p> </li> <li> <p>In the US, you have access to one-day shipping and two-day shipping.</p> </li> </ul>'
        Notification:
          allOf:
          - $ref: '#/components/schemas/Notification'
          - description: The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
        ForwardingAddressId:
          allOf:
          - $ref: '#/components/schemas/AddressId'
          - description: The forwarding address ID for a cluster. This field is not supported in most regions.
        TaxDocuments:
          allOf:
          - $ref: '#/components/schemas/TaxDocuments'
          - description: The tax documents required in your Amazon Web Services Region.
        RemoteManagement:
          allOf:
          - $ref: '#/components/schemas/RemoteManagement'
          - description: Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.
        InitialClusterSize:
          allOf:
          - $ref: '#/components/schemas/InitialClusterSize'
          - description: If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.
        ForceCreateJobs:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with <code>OnDeviceServiceConfiguration</code>.
        LongTermPricingIds:
          allOf:
          - $ref: '#/components/schemas/LongTermPricingIdList'
          - description: Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
        SnowballCapacityPreference:
          allOf:
          - $ref: '#/components/schemas/SnowballCapacity'
          - description: <p>If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.</p> <p>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</p>
    AddressId:
      type: string
      pattern: ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
      minLength: 40
      maxLength: 40
    S3OnDeviceServiceConfiguration:
      type: object
      properties:
        StorageLimit:
          allOf:
          - $ref: '#/components/schemas/S3StorageLimit'
          - description: If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.
        StorageUnit:
          allOf:
          - $ref: '#/components/schemas/StorageUnit'
          - description: Storage unit. Currently the only supported unit is TB.
        ServiceSize:
          allOf:
          - $ref: '#/components/schemas/ServiceSize'
          - description: Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.
        FaultTolerance:
          allOf:
          - $ref: '#/components/schemas/NodeFaultTolerance'
          - description: '&gt;Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified <code>StorageLimit</code> matches more than one Amazon S3 compatible storage on Snow family devices service configuration.'
      description: Amazon S3 compatible storage on Snow family devices configuration items.
    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
    TaxDocuments:
      type: object
      properties:
        IND:
          $ref: '#/components/schemas/INDTaxDocuments'
      description: The tax documents required in your Amazon Web Services Region.
    CreateClusterResult:
      type: object
      example:
        ClusterId: CID123e4567-e89b-12d3-a456-426655440000
      properties:
        ClusterId:
          allOf:
          - $ref: '#/components/schemas/ClusterId'
          - description: The automatically generated ID for a cluster.
        JobListEntries:
          allOf:
          - $ref: '#/components/schemas/JobListEntryList'
          - description: List of jobs created for this cluster. For syntax, see <a href="http://amazonaws.com/snowball/latest/api-reference/API_ListJobs.html#API_ListJobs_ResponseSyntax">ListJobsResult$JobListEntries</a> in this guide.
    Timestamp:
      type: string
      format: date-time
    NFSOnDeviceServiceConfiguration:
      type: object
      properties:
        StorageLimit:
          allOf:
          - $ref: '#/components/schemas/StorageLimit'
          - description: The maximum NFS storage for one Snow Family device.
        StorageUnit:
          allOf:
          - $ref: '#/components/schemas/StorageUnit'
          - description: '<p>The scale unit of the NFS storage on the device.</p> <p>Valid values: TB.</p>'
      description: An object that represents the metadata and configuration settings for the NFS (Network File System) service on an Amazon Web Services Snow Family device.
    LambdaResource:
      type: object
      properties:
        LambdaArn:
          allOf:
          - $ref: '#/components/schemas/ResourceARN'
          - description: An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
        EventTriggers:
          allOf:
          - $ref: '#/components/schemas/EventTriggerDefinitionList'
          - description: The array of ARNs for <a>S3Resource</a> objects to trigger the <a>LambdaResource</a> objects associated with this job.
      description: 'Identifies '
    INDTaxDocuments:
      type: object
      properties:
        GSTIN:
          allOf:
          - $ref: '#/components/schemas/GSTIN'
          - description: The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
      description: The tax documents required in Amazon Web Services Region in India.
    TransferOption:
      type: string
      enum:
      - IMPORT
      - EXPORT
      - LOCAL_USE
    RemoteManagement:
      type: string
      enum:
      - INSTALLED_ONLY
      - INSTALLED_AUTOSTART
      - NOT_INSTALLED
    InvalidInputCombinationException: {}
  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
  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