openapi: 3.2.0 info: version: '2016-06-30' x-release: v4 title: Amazon Import/Export Snowball 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). 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: Amazon Import/Export Snowball paths: /#X-Amz-Target=AWSIESnowballJobManagementService.CancelCluster: 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: CancelCluster description: Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum 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 tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.CancelJob: 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: CancelJob description: Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState 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 tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.CreateAddress: 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: 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 tags: - Amazon Import/Export Snowball /#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 CreateJob 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: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.CreateJob: 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: CreateJob description: '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 clusterId value; the other job attributes are inherited from the cluster. Only the Snowball; Edge device type is supported when ordering clustered jobs. The device capacity is optional. Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services. Snow Family devices and their capacities. Device type: SNC1_SSD Capacity: T14 Description: Snowcone Device type: SNC1_HDD Capacity: T8 Description: Snowcone Device type: EDGE_S Capacity: T98 Description: Snowball Edge Storage Optimized for data transfer only Device type: EDGE_CG Capacity: T42 Description: Snowball Edge Compute Optimized with GPU Device type: EDGE_C Capacity: T42 Description: Snowball Edge Compute Optimized without GPU Device type: EDGE Capacity: T100 Description: Snowball Edge Storage Optimized with EC2 Compute This device is replaced with T98. Device type: STANDARD Capacity: T50 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region Device type: STANDARD Capacity: T80 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region. Snow Family device type: RACK_5U_C Capacity: T13 Description: Snowblade. Device type: V3_5S Capacity: T240 Description: Snowball Edge Storage Optimized 210TB' 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 tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.CreateLongTermPricing: 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: 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 tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.CreateReturnShippingLabel: 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: 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 tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.DescribeAddress: 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: DescribeAddress description: Takes an AddressId and returns specific details about that address in the form of an Address 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: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.DescribeAddress summary: Amazon Describe Address x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.DescribeAddresses: 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: DescribeAddresses description: Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeAddressesResult' examples: DescribeAddresses200Example: summary: Default DescribeAddresses 200 x-microcks-default: true value: Addresses: example-value NextToken: example-value '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: DescribeAddresses480Example: summary: Default DescribeAddresses 480 x-microcks-default: true value: example-value '481': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: DescribeAddresses481Example: summary: Default DescribeAddresses 481 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeAddressesRequest' examples: DescribeAddressesRequestExample: summary: Default DescribeAddresses 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.DescribeAddresses summary: Amazon Describe Addresses x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.DescribeCluster: 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: DescribeCluster description: Returns information about a specific cluster including shipping information, cluster status, and other important metadata. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeClusterResult' examples: DescribeCluster200Example: summary: Default DescribeCluster 200 x-microcks-default: true value: ClusterMetadata: example-value '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: DescribeCluster480Example: summary: Default DescribeCluster 480 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeClusterRequest' examples: DescribeClusterRequestExample: summary: Default DescribeCluster request x-microcks-default: true value: ClusterId: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.DescribeCluster summary: Amazon Describe Cluster x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.DescribeJob: 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: DescribeJob description: Returns information about a specific job including shipping information, job status, and other important metadata. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeJobResult' examples: DescribeJob200Example: summary: Default DescribeJob 200 x-microcks-default: true value: JobMetadata: example-value SubJobMetadata: example-value '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: DescribeJob480Example: summary: Default DescribeJob 480 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeJobRequest' examples: DescribeJobRequestExample: summary: Default DescribeJob request x-microcks-default: true value: JobId: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.DescribeJob summary: Amazon Describe Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.DescribeReturnShippingLabel: 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: DescribeReturnShippingLabel description: Information on the shipping label of a Snow device that is being returned to Amazon Web Services. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeReturnShippingLabelResult' examples: DescribeReturnShippingLabel200Example: summary: Default DescribeReturnShippingLabel 200 x-microcks-default: true value: Status: Active ExpirationDate: example-value ReturnShippingLabelURI: example-value '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: DescribeReturnShippingLabel480Example: summary: Default DescribeReturnShippingLabel 480 x-microcks-default: true value: example-value '481': description: InvalidJobStateException content: application/json: schema: $ref: '#/components/schemas/InvalidJobStateException' examples: DescribeReturnShippingLabel481Example: summary: Default DescribeReturnShippingLabel 481 x-microcks-default: true value: example-value '482': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: DescribeReturnShippingLabel482Example: summary: Default DescribeReturnShippingLabel 482 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeReturnShippingLabelRequest' examples: DescribeReturnShippingLabelRequestExample: summary: Default DescribeReturnShippingLabel request x-microcks-default: true value: JobId: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.DescribeReturnShippingLabel summary: Amazon Describe Return Shipping Label x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.GetJobManifest: 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: GetJobManifest description: 'Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you''ll have to make another call to the GetJobManifest action. The manifest is an encrypted file that you can download after your job enters the WithCustomer status. This is the only valid status for calling this API as the manifest and UnlockCode code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snow device through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don''t save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJobManifestResult' examples: GetJobManifest200Example: summary: Default GetJobManifest 200 x-microcks-default: true value: ManifestURI: example-value '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: GetJobManifest480Example: summary: Default GetJobManifest 480 x-microcks-default: true value: example-value '481': description: InvalidJobStateException content: application/json: schema: $ref: '#/components/schemas/InvalidJobStateException' examples: GetJobManifest481Example: summary: Default GetJobManifest 481 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetJobManifestRequest' examples: GetJobManifestRequestExample: summary: Default GetJobManifest request x-microcks-default: true value: JobId: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.GetJobManifest summary: Amazon Get Job Manifest x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.GetJobUnlockCode: 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: GetJobUnlockCode description: 'Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is WithCustomer as the manifest and Unlock code values are used for securing your device and should only be used when you have the device. As a best practice, we recommend that you don''t save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetJobUnlockCodeResult' examples: GetJobUnlockCode200Example: summary: Default GetJobUnlockCode 200 x-microcks-default: true value: UnlockCode: example-value '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: GetJobUnlockCode480Example: summary: Default GetJobUnlockCode 480 x-microcks-default: true value: example-value '481': description: InvalidJobStateException content: application/json: schema: $ref: '#/components/schemas/InvalidJobStateException' examples: GetJobUnlockCode481Example: summary: Default GetJobUnlockCode 481 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetJobUnlockCodeRequest' examples: GetJobUnlockCodeRequestExample: summary: Default GetJobUnlockCode request x-microcks-default: true value: JobId: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.GetJobUnlockCode summary: Amazon Get Job Unlock Code x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.GetSnowballUsage: 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: GetSnowballUsage description: 'Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use. The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSnowballUsageResult' examples: GetSnowballUsage200Example: summary: Default GetSnowballUsage 200 x-microcks-default: true value: SnowballLimit: example-value SnowballsInUse: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetSnowballUsageRequest' examples: GetSnowballUsageRequestExample: summary: Default GetSnowballUsage request x-microcks-default: true value: {} parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.GetSnowballUsage summary: Amazon Get Snowball Usage x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.GetSoftwareUpdates: 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: GetSoftwareUpdates description: Returns an Amazon S3 presigned URL for an update file associated with a specified JobId. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSoftwareUpdatesResult' examples: GetSoftwareUpdates200Example: summary: Default GetSoftwareUpdates 200 x-microcks-default: true value: UpdatesURI: example-value '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: GetSoftwareUpdates480Example: summary: Default GetSoftwareUpdates 480 x-microcks-default: true value: example-value '481': description: InvalidJobStateException content: application/json: schema: $ref: '#/components/schemas/InvalidJobStateException' examples: GetSoftwareUpdates481Example: summary: Default GetSoftwareUpdates 481 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetSoftwareUpdatesRequest' examples: GetSoftwareUpdatesRequestExample: summary: Default GetSoftwareUpdates request x-microcks-default: true value: JobId: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.GetSoftwareUpdates summary: Amazon Get Software Updates x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.ListClusterJobs: 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: ListClusterJobs description: Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListClusterJobsResult' examples: ListClusterJobs200Example: summary: Default ListClusterJobs 200 x-microcks-default: true value: JobListEntries: example-value NextToken: example-value '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: ListClusterJobs480Example: summary: Default ListClusterJobs 480 x-microcks-default: true value: example-value '481': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListClusterJobs481Example: summary: Default ListClusterJobs 481 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListClusterJobsRequest' examples: ListClusterJobsRequestExample: summary: Default ListClusterJobs request x-microcks-default: true value: ClusterId: example-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.ListClusterJobs summary: Amazon List Cluster Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.ListClusters: 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: ListClusters description: Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListClustersResult' examples: ListClusters200Example: summary: Default ListClusters 200 x-microcks-default: true value: ClusterListEntries: example-value NextToken: example-value '480': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListClusters480Example: summary: Default ListClusters 480 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListClustersRequest' examples: ListClustersRequestExample: summary: Default ListClusters 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.ListClusters summary: Amazon List Clusters x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.ListCompatibleImages: 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: ListCompatibleImages description: This action returns a list of the different Amazon EC2-compatible Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListCompatibleImagesResult' examples: ListCompatibleImages200Example: summary: Default ListCompatibleImages 200 x-microcks-default: true value: CompatibleImages: example-value NextToken: example-value '480': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListCompatibleImages480Example: summary: Default ListCompatibleImages 480 x-microcks-default: true value: example-value '481': description: Ec2RequestFailedException content: application/json: schema: $ref: '#/components/schemas/Ec2RequestFailedException' examples: ListCompatibleImages481Example: summary: Default ListCompatibleImages 481 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListCompatibleImagesRequest' examples: ListCompatibleImagesRequestExample: summary: Default ListCompatibleImages 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.ListCompatibleImages summary: Amazon List Compatible Images x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.ListJobs: 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: ListJobs description: Returns an array of JobListEntry objects of the specified length. Each JobListEntry 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 export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListJobsResult' examples: ListJobs200Example: summary: Default ListJobs 200 x-microcks-default: true value: JobListEntries: example-value NextToken: example-value '480': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListJobs480Example: summary: Default ListJobs 480 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListJobsRequest' examples: ListJobsRequestExample: summary: Default ListJobs 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.ListJobs summary: Amazon List Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#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: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.ListPickupLocations: 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: ListPickupLocations description: A list of locations from which the customer can choose to pickup a device. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListPickupLocationsResult' examples: ListPickupLocations200Example: summary: Default ListPickupLocations 200 x-microcks-default: true value: Addresses: example-value NextToken: example-value '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: ListPickupLocations480Example: summary: Default ListPickupLocations 480 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListPickupLocationsRequest' examples: ListPickupLocationsRequestExample: summary: Default ListPickupLocations 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.ListPickupLocations summary: Amazon List Pickup Locations x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.ListServiceVersions: 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: ListServiceVersions description: Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListServiceVersionsResult' examples: ListServiceVersions200Example: summary: Default ListServiceVersions 200 x-microcks-default: true value: ServiceVersions: example-value ServiceName: MyResource DependentServices: example-value NextToken: example-value '480': description: InvalidNextTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidNextTokenException' examples: ListServiceVersions480Example: summary: Default ListServiceVersions 480 x-microcks-default: true value: example-value '481': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: ListServiceVersions481Example: summary: Default ListServiceVersions 481 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListServiceVersionsRequest' examples: ListServiceVersionsRequestExample: summary: Default ListServiceVersions request x-microcks-default: true value: ServiceName: MyResource DependentServices: example-value MaxResults: example-value NextToken: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.ListServiceVersions summary: Amazon List Service Versions x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.UpdateCluster: 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: UpdateCluster description: While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateClusterResult' examples: UpdateCluster200Example: summary: Default UpdateCluster 200 x-microcks-default: true value: {} '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: UpdateCluster480Example: summary: Default UpdateCluster 480 x-microcks-default: true value: example-value '481': description: InvalidJobStateException content: application/json: schema: $ref: '#/components/schemas/InvalidJobStateException' examples: UpdateCluster481Example: summary: Default UpdateCluster 481 x-microcks-default: true value: example-value '482': description: KMSRequestFailedException content: application/json: schema: $ref: '#/components/schemas/KMSRequestFailedException' examples: UpdateCluster482Example: summary: Default UpdateCluster 482 x-microcks-default: true value: example-value '483': description: InvalidInputCombinationException content: application/json: schema: $ref: '#/components/schemas/InvalidInputCombinationException' examples: UpdateCluster483Example: summary: Default UpdateCluster 483 x-microcks-default: true value: example-value '484': description: Ec2RequestFailedException content: application/json: schema: $ref: '#/components/schemas/Ec2RequestFailedException' examples: UpdateCluster484Example: summary: Default UpdateCluster 484 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateClusterRequest' examples: UpdateClusterRequestExample: summary: Default UpdateCluster request x-microcks-default: true value: ClusterId: example-value RoleARN: arn:aws:service:us-east-1:123456789012:resource/example Description: example-value Resources: example-value OnDeviceServiceConfiguration: example-value AddressId: example-value ShippingOption: example-value Notification: example-value ForwardingAddressId: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.UpdateCluster summary: Amazon Update Cluster x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.UpdateJob: 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: UpdateJob description: While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateJobResult' examples: UpdateJob200Example: summary: Default UpdateJob 200 x-microcks-default: true value: {} '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: UpdateJob480Example: summary: Default UpdateJob 480 x-microcks-default: true value: example-value '481': description: InvalidJobStateException content: application/json: schema: $ref: '#/components/schemas/InvalidJobStateException' examples: UpdateJob481Example: summary: Default UpdateJob 481 x-microcks-default: true value: example-value '482': description: KMSRequestFailedException content: application/json: schema: $ref: '#/components/schemas/KMSRequestFailedException' examples: UpdateJob482Example: summary: Default UpdateJob 482 x-microcks-default: true value: example-value '483': description: InvalidInputCombinationException content: application/json: schema: $ref: '#/components/schemas/InvalidInputCombinationException' examples: UpdateJob483Example: summary: Default UpdateJob 483 x-microcks-default: true value: example-value '484': description: ClusterLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ClusterLimitExceededException' examples: UpdateJob484Example: summary: Default UpdateJob 484 x-microcks-default: true value: example-value '485': description: Ec2RequestFailedException content: application/json: schema: $ref: '#/components/schemas/Ec2RequestFailedException' examples: UpdateJob485Example: summary: Default UpdateJob 485 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateJobRequest' examples: UpdateJobRequestExample: summary: Default UpdateJob request x-microcks-default: true value: JobId: example-value RoleARN: arn:aws:service:us-east-1:123456789012:resource/example Notification: example-value Resources: example-value OnDeviceServiceConfiguration: example-value AddressId: example-value ShippingOption: example-value Description: example-value SnowballCapacityPreference: example-value ForwardingAddressId: example-value PickupDetails: Name: MyResource PhoneNumber: example-value Email: example-value IdentificationNumber: example-value IdentificationExpirationDate: example-value IdentificationIssuingOrg: example-value DevicePickupId: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.UpdateJob summary: Amazon Update Job x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.UpdateJobShipmentState: 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: UpdateJobShipmentState description: Updates the state when a shipment state changes to a different state. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateJobShipmentStateResult' examples: UpdateJobShipmentState200Example: summary: Default UpdateJobShipmentState 200 x-microcks-default: true value: {} '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: UpdateJobShipmentState480Example: summary: Default UpdateJobShipmentState 480 x-microcks-default: true value: example-value '481': description: InvalidJobStateException content: application/json: schema: $ref: '#/components/schemas/InvalidJobStateException' examples: UpdateJobShipmentState481Example: summary: Default UpdateJobShipmentState 481 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateJobShipmentStateRequest' examples: UpdateJobShipmentStateRequestExample: summary: Default UpdateJobShipmentState request x-microcks-default: true value: JobId: example-value ShipmentState: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.UpdateJobShipmentState summary: Amazon Update Job Shipment State x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball /#X-Amz-Target=AWSIESnowballJobManagementService.UpdateLongTermPricing: 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: UpdateLongTermPricing description: Updates the long-term pricing type. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateLongTermPricingResult' examples: UpdateLongTermPricing200Example: summary: Default UpdateLongTermPricing 200 x-microcks-default: true value: {} '480': description: InvalidResourceException content: application/json: schema: $ref: '#/components/schemas/InvalidResourceException' examples: UpdateLongTermPricing480Example: summary: Default UpdateLongTermPricing 480 x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateLongTermPricingRequest' examples: UpdateLongTermPricingRequestExample: summary: Default UpdateLongTermPricing request x-microcks-default: true value: LongTermPricingId: example-value ReplacementJob: example-value IsLongTermPricingAutoRenew: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AWSIESnowballJobManagementService.UpdateLongTermPricing summary: Amazon Update Long Term Pricing x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Amazon Import/Export Snowball components: schemas: GetSoftwareUpdatesRequest: type: object required: - JobId title: GetSoftwareUpdatesRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The ID for a job that you want to get the software update file for, for example JID123e4567-e89b-12d3-a456-426655440000. DeviceConfiguration: type: object properties: SnowconeDeviceConfiguration: allOf: - $ref: '#/components/schemas/SnowconeDeviceConfiguration' - description: Returns information about the device configuration for an Snowcone job. description: 'The container for SnowconeDeviceConfiguration. ' S3StorageLimit: type: number format: double minimum: 0 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. InvalidNextTokenException: {} LongTermPricingAssociatedJobIdList: type: array items: $ref: '#/components/schemas/JobId' DescribeAddressResult: type: object example: Address: AddressId: ADID5643ec50-3eec-4eb3-9be6-9374c10eb51b City: Seattle Company: My Company Country: US Name: My Name PhoneNumber: 425-555-5555 PostalCode: '98101' StateOrProvince: WA Street1: 123 Main Street properties: Address: allOf: - $ref: '#/components/schemas/Address' - description: The address that you want the Snow device(s) associated with a specific job to be shipped to. UpdateClusterRequest: type: object required: - ClusterId title: UpdateClusterRequest properties: ClusterId: allOf: - $ref: '#/components/schemas/ClusterId' - description: The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description: The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in Identity and Access Management (IAM). Description: allOf: - $ref: '#/components/schemas/String' - description: The updated description of this cluster. Resources: allOf: - $ref: '#/components/schemas/JobResource' - description: The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects. 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). AddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The ID of the updated Address object. ShippingOption: allOf: - $ref: '#/components/schemas/ShippingOption' - description: The updated shipping option value of this cluster's ShippingDetails object. Notification: allOf: - $ref: '#/components/schemas/Notification' - description: The new or updated Notification object. ForwardingAddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The updated ID for the forwarding address for a cluster. This field is not supported in most regions. TransferOption: type: string enum: - IMPORT - EXPORT - LOCAL_USE UpdateLongTermPricingRequest: type: object required: - LongTermPricingId title: UpdateLongTermPricingRequest properties: LongTermPricingId: allOf: - $ref: '#/components/schemas/LongTermPricingId' - description: The ID of the long-term pricing type for the device. ReplacementJob: allOf: - $ref: '#/components/schemas/JobId' - description: Specifies that a device that is ordered with long-term pricing should be replaced with a new device. IsLongTermPricingAutoRenew: allOf: - $ref: '#/components/schemas/JavaBoolean' - description: If set to true, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires. CancelJobResult: type: object properties: {} CancelClusterResult: type: object properties: {} 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 ReturnShippingLabelAlreadyExistsException: {} CreateReturnShippingLabelResult: type: object properties: Status: allOf: - $ref: '#/components/schemas/ShippingLabelStatus' - description: The status information of the task on a Snow device that is being returned to Amazon Web Services. KMSRequestFailedException: {} ServiceVersionList: type: array items: $ref: '#/components/schemas/ServiceVersion' CompatibleImage: type: object properties: AmiId: allOf: - $ref: '#/components/schemas/String' - description: The unique identifier for an individual Snow device AMI. Name: allOf: - $ref: '#/components/schemas/String' - description: The optional name of a compatible image. description: A JSON-formatted object that describes a compatible Amazon Machine Image (AMI), including the ID and name for a Snow device AMI. This AMI is compatible with the device's physical hardware requirements, and it should be able to be run in an SBE1 instance on the device. DescribeClusterRequest: type: object required: - ClusterId title: DescribeClusterRequest properties: ClusterId: allOf: - $ref: '#/components/schemas/ClusterId' - description: The automatically generated ID for a cluster. ListClustersRequest: type: object title: ListClustersRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/ListLimit' - description: The number of ClusterListEntry objects to return. NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list. PhoneNumber: type: string pattern: '^\s*(?:\+?(\d{1,3}))?[-. (]*(\d{3})[-. )]*(\d{3})[-. ]*(\d{4})(?: *x(\d+))?\s*$' minLength: 7 maxLength: 30 format: password CompatibleImageList: type: array items: $ref: '#/components/schemas/CompatibleImage' InvalidInputCombinationException: {} InvalidAddressException: {} EventTriggerDefinitionList: type: array items: $ref: '#/components/schemas/EventTriggerDefinition' CreateJobResult: type: object example: JobId: JID123e4567-e89b-12d3-a456-426655440000 properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. GetJobManifestResult: type: object example: ManifestURI: https://awsie-frosty-manifests-prod.s3.amazonaws.com/JID123e4567-e89b-12d3-a456-426655440000_manifest.bin?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161224T005115Z&X-Amz-SignedHeaders=... properties: ManifestURI: allOf: - $ref: '#/components/schemas/String' - description: The Amazon S3 presigned URL for the manifest file associated with the specified JobId value. Long: type: integer ListServiceVersionsRequest: type: object required: - ServiceName title: ListServiceVersionsRequest properties: ServiceName: allOf: - $ref: '#/components/schemas/ServiceName' - description: The name of the service for which you're requesting supported versions. DependentServices: allOf: - $ref: '#/components/schemas/DependentServiceList' - description: A list of names and versions of dependant services of the requested service. MaxResults: allOf: - $ref: '#/components/schemas/ListLimit' - description: The maximum number of ListServiceVersions objects to return. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Because HTTP requests are stateless, this is the starting point for the next list of returned ListServiceVersionsRequest versions. 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 ListPickupLocationsRequest: type: object title: ListPickupLocationsRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/ListLimit' - description: The maximum number of locations to list per page. NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. To identify what object comes "next" in the list of ListPickupLocationsRequest objects, you have the option of specifying NextToken as the starting point for your returned list. SnowconeDeviceConfiguration: type: object properties: WirelessConnection: allOf: - $ref: '#/components/schemas/WirelessConnection' - description: Configures the wireless connection for the Snowcone device. description: Specifies the device configuration for an Snowcone job. InitialClusterSize: type: integer minimum: 0 maximum: 16 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 KeyRange within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, 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 S3Resource 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 KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted. StorageLimit: type: integer minimum: 0 DataTransfer: type: object properties: BytesTransferred: allOf: - $ref: '#/components/schemas/Long' - description: The number of bytes transferred between a Snow device and Amazon S3. ObjectsTransferred: allOf: - $ref: '#/components/schemas/Long' - description: The number of objects transferred between a Snow device and Amazon S3. TotalBytes: allOf: - $ref: '#/components/schemas/Long' - description: The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed. TotalObjects: allOf: - $ref: '#/components/schemas/Long' - description: The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed. description: Defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. This data is only available while a job has a JobState value of InProgress, for both import and export jobs. 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). DependentService: type: object properties: ServiceName: allOf: - $ref: '#/components/schemas/ServiceName' - description: The name of the dependent service. ServiceVersion: allOf: - $ref: '#/components/schemas/ServiceVersion' - description: The version of the dependent service. description: The name and version of the service dependant on the requested service. 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. ListPickupLocationsResult: type: object example: Addresses: - AddressId: ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b City: Seattle Company: My Company Country: US Name: My Name PhoneNumber: 425-555-5555 PostalCode: '98101' StateOrProvince: WA Street1: 123 Main Street properties: Addresses: allOf: - $ref: '#/components/schemas/AddressList' - description: Information about the address of pickup locations. NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. To identify what object comes "next" in the list of ListPickupLocationsResult objects, you have the option of specifying NextToken as the starting point for your returned list. UnsupportedAddressException: {} 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. DescribeAddressesResult: type: object example: Addresses: - AddressId: ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b City: Seattle Company: My Company Country: US Name: My Name PhoneNumber: 425-555-5555 PostalCode: '98101' StateOrProvince: WA Street1: 123 Main Street properties: Addresses: allOf: - $ref: '#/components/schemas/AddressList' - description: The Snow device shipping addresses that were created for this account. NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array. ListClusterJobsRequest: type: object required: - ClusterId title: ListClusterJobsRequest properties: ClusterId: allOf: - $ref: '#/components/schemas/ClusterId' - description: The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000. MaxResults: allOf: - $ref: '#/components/schemas/ListLimit' - description: The number of JobListEntry objects to return. NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list. GetJobManifestRequest: type: object required: - JobId title: GetJobManifestRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000. Integer: type: integer LambdaResourceList: type: array items: $ref: '#/components/schemas/LambdaResource' JavaBoolean: type: boolean ListClusterJobsResult: type: object example: JobListEntries: - CreationDate: '1480475524.0' Description: MyClustrer-node-001 IsMaster: false JobId: JID123e4567-e89b-12d3-a456-426655440000 JobState: New JobType: LOCAL_USE SnowballType: EDGE - CreationDate: '1480475525.0' Description: MyClustrer-node-002 IsMaster: false JobId: JID123e4567-e89b-12d3-a456-426655440001 JobState: New JobType: LOCAL_USE SnowballType: EDGE - CreationDate: '1480475525.0' Description: MyClustrer-node-003 IsMaster: false JobId: JID123e4567-e89b-12d3-a456-426655440002 JobState: New JobType: LOCAL_USE SnowballType: EDGE - CreationDate: '1480475525.0' Description: MyClustrer-node-004 IsMaster: false JobId: JID123e4567-e89b-12d3-a456-426655440003 JobState: New JobType: LOCAL_USE SnowballType: EDGE - CreationDate: '1480475525.0' Description: MyClustrer-node-005 IsMaster: false JobId: JID123e4567-e89b-12d3-a456-426655440004 JobState: New JobType: LOCAL_USE SnowballType: EDGE properties: JobListEntries: allOf: - $ref: '#/components/schemas/JobListEntryList' - description: 'Each JobListEntry 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 export jobs. ' NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. If you use the automatically generated NextToken value in your next ListClusterJobsResult call, your list of returned jobs will start from this point in the array. ListServiceVersionsResult: type: object required: - ServiceVersions - ServiceName properties: ServiceVersions: allOf: - $ref: '#/components/schemas/ServiceVersionList' - description: A list of supported versions. ServiceName: allOf: - $ref: '#/components/schemas/ServiceName' - description: The name of the service for which the system provided supported versions. DependentServices: allOf: - $ref: '#/components/schemas/DependentServiceList' - description: A list of names and versions of dependant services of the service for which the system provided supported versions. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Because HTTP requests are stateless, this is the starting point of the next list of returned ListServiceVersionsResult results. DescribeJobRequest: type: object required: - JobId title: DescribeJobRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. InvalidJobStateException: {} ListClustersResult: type: object example: ClusterListEntries: - ClusterId: CID123e4567-e89b-12d3-a456-426655440000 ClusterState: Pending CreationDate: '1480475517.0' Description: MyCluster properties: ClusterListEntries: allOf: - $ref: '#/components/schemas/ClusterListEntryList' - description: Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information. NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array. JobStateList: type: array items: $ref: '#/components/schemas/JobState' String: type: string pattern: .* minLength: 1 maxLength: 1024 JobLogs: type: object properties: JobCompletionReportURI: allOf: - $ref: '#/components/schemas/String' - description: A link to an Amazon S3 presigned URL where the job completion report is located. JobSuccessLogURI: allOf: - $ref: '#/components/schemas/String' - description: A link to an Amazon S3 presigned URL where the job success log is located. JobFailureLogURI: allOf: - $ref: '#/components/schemas/String' - description: A link to an Amazon S3 presigned URL where the job failure log is located. description: '

Contains job logs. Whenever a Snow device is used to import data into or export data out of Amazon S3, you''ll have the option of downloading a PDF job report. Job logs are returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type. The job logs can be accessed for up to 60 minutes after this request has been made. To access any of the job logs after 60 minutes have passed, you''ll have to make another call to the DescribeJob action.

For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you.

The job report provides you insight into the state of your Amazon S3 data transfer. The report includes details about your job or job part for your records.

For deeper visibility into the status of your transferred objects, you can look at the two associated logs: a success log and a failure log. The logs are saved in comma-separated value (CSV) format, and the name of each log includes the ID of the job or job part that the log describes.

' Email: type: string pattern: ^(?=.{3,100}$).+@.+[.].+$ minLength: 3 maxLength: 320 format: password 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: '

The scale unit of the NFS storage on the device.

Valid values: TB.

' 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. 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 ClusterLimitExceededException: {} SnowballType: type: string enum: - STANDARD - EDGE - EDGE_C - EDGE_CG - EDGE_S - SNC1_HDD - SNC1_SSD - V3_5C - V3_5S - RACK_5U_C CreateClusterRequest: type: object required: - JobType - AddressId - SnowballType - ShippingOption title: CreateClusterRequest properties: JobType: allOf: - $ref: '#/components/schemas/JobType' - description:

The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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 Environmental Data Cluster-01. 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 KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in Key Management Service (KMS). ' RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description: The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in Identity and Access Management (IAM). SnowballType: allOf: - $ref: '#/components/schemas/SnowballType' - description:

The type of Snow Family devices to use for this cluster.

For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

ShippingOption: allOf: - $ref: '#/components/schemas/ShippingOption' - description: '

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:

' 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 INSTALLED_AUTOSTART, 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 OnDeviceServiceConfiguration. 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:

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.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

LongTermPricingIdList: type: array items: $ref: '#/components/schemas/LongTermPricingId' ResourceARN: type: string pattern: arn:aws.*:* maxLength: 255 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. ClusterListEntry: type: object properties: ClusterId: allOf: - $ref: '#/components/schemas/String' - description: The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000. ClusterState: allOf: - $ref: '#/components/schemas/ClusterState' - description: The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState. CreationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The creation date for this cluster. Description: allOf: - $ref: '#/components/schemas/String' - description: Defines an optional description of the cluster, for example Environmental Data Cluster-01. description: Contains a cluster's state, a cluster's ID, and other important information. RemoteManagement: type: string enum: - INSTALLED_ONLY - INSTALLED_AUTOSTART - NOT_INSTALLED Shipment: type: object properties: Status: allOf: - $ref: '#/components/schemas/String' - description: Status information for a shipment. TrackingNumber: allOf: - $ref: '#/components/schemas/String' - description:

The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device as the carrier transports it.

For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

description: The Status and TrackingNumber information for an inbound or outbound shipment. PickupDetails: type: object properties: Name: allOf: - $ref: '#/components/schemas/String' - description: The name of the person picking up the device. PhoneNumber: allOf: - $ref: '#/components/schemas/PhoneNumber' - description: The phone number of the person picking up the device. Email: allOf: - $ref: '#/components/schemas/Email' - description: The email address of the person picking up the device. IdentificationNumber: allOf: - $ref: '#/components/schemas/String' - description: The number on the credential identifying the person picking up the device. IdentificationExpirationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: Expiration date of the credential identifying the person picking up the device. IdentificationIssuingOrg: allOf: - $ref: '#/components/schemas/String' - description: Organization that issued the credential identifying the person picking up the device. DevicePickupId: allOf: - $ref: '#/components/schemas/DevicePickupId' - description: The unique ID for a device that will be picked up. description: Information identifying the person picking up the device. ClusterListEntryList: type: array items: $ref: '#/components/schemas/ClusterListEntry' AddressList: type: array items: $ref: '#/components/schemas/Address' 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 S3Resource object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted. JobListEntry: type: object properties: JobId: allOf: - $ref: '#/components/schemas/String' - description: The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 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 Important Photos 2016-08-11. description: Each JobListEntry 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. Notification: type: object properties: SnsTopicARN: allOf: - $ref: '#/components/schemas/SnsTopicARN' - description:

The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.

You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.

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:

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll set to true.

S3ResourceList: type: array items: $ref: '#/components/schemas/S3Resource' ImpactLevel: type: string enum: - IL2 - IL4 - IL5 - IL6 - IL99 DescribeAddressRequest: type: object required: - AddressId title: DescribeAddressRequest properties: AddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The automatically generated ID for a specific address. ClusterMetadata: type: object properties: ClusterId: allOf: - $ref: '#/components/schemas/String' - description: The automatically generated ID for a cluster. Description: allOf: - $ref: '#/components/schemas/String' - description: The optional description of the cluster. KmsKeyARN: allOf: - $ref: '#/components/schemas/KmsKeyARN' - description: The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description: The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM). ClusterState: allOf: - $ref: '#/components/schemas/ClusterState' - description: The current status of the cluster. JobType: allOf: - $ref: '#/components/schemas/JobType' - description: The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE. SnowballType: allOf: - $ref: '#/components/schemas/SnowballType' - description:

The type of Snowcone device to use for this cluster.

For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

 CreationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The creation date for this cluster. Resources: allOf: - $ref: '#/components/schemas/JobResource' - description: The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects. AddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The automatically generated ID for a specific address. ShippingOption: allOf: - $ref: '#/components/schemas/ShippingOption' - description:

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:

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 ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. 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. OnDeviceServiceConfiguration: allOf: - $ref: '#/components/schemas/OnDeviceServiceConfiguration' - description: Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device. description: Contains metadata about a specific cluster. ConflictException: {} UpdateJobRequest: type: object required: - JobId title: UpdateJobRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description: The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API action. Notification: allOf: - $ref: '#/components/schemas/Notification' - description: The new or updated Notification object. Resources: allOf: - $ref: '#/components/schemas/JobResource' - description: 'The updated JobResource object, or the updated JobResource object. ' 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 supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type. AddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The ID of the updated Address object. ShippingOption: allOf: - $ref: '#/components/schemas/ShippingOption' - description: The updated shipping option value of this job's ShippingDetails object. Description: allOf: - $ref: '#/components/schemas/String' - description: The updated description of this job's JobMetadata object. SnowballCapacityPreference: allOf: - $ref: '#/components/schemas/SnowballCapacity' - description:

The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

ForwardingAddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The updated ID for the forwarding address for a job. This field is not supported in most regions. PickupDetails: $ref: '#/components/schemas/PickupDetails' WirelessConnection: type: object properties: IsWifiEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Enables the Wi-Fi adapter on an Snowcone device. description: Configures the wireless connection on an Snowcone device. TaxDocuments: type: object properties: IND: $ref: '#/components/schemas/INDTaxDocuments' description: The tax documents required in your Amazon Web Services Region. JobListEntryList: type: array items: $ref: '#/components/schemas/JobListEntry' ShippingDetails: type: object properties: ShippingOption: allOf: - $ref: '#/components/schemas/ShippingOption' - description:

The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snow device from the job's creation date. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:

InboundShipment: allOf: - $ref: '#/components/schemas/Shipment' - description: The Status and TrackingNumber values for a Snow device being returned to Amazon Web Services for a particular job. OutboundShipment: allOf: - $ref: '#/components/schemas/Shipment' - description: The Status and TrackingNumber values for a Snow device being delivered to the address that you specified for a particular job. description: A job's shipping information, including inbound and outbound tracking numbers and shipping speed options. GetJobUnlockCodeResult: type: object example: UnlockCode: 12345-abcde-56789-fghij-01234 properties: UnlockCode: allOf: - $ref: '#/components/schemas/String' - description: The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 360 days after the job has been created. Address: type: object properties: AddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The unique ID for an address. Name: allOf: - $ref: '#/components/schemas/String' - description: The name of a person to receive a Snow device at an address. Company: allOf: - $ref: '#/components/schemas/String' - description: The name of the company to receive a Snow device at an address. Street1: allOf: - $ref: '#/components/schemas/String' - description: The first line in a street address that a Snow device is to be delivered to. Street2: allOf: - $ref: '#/components/schemas/String' - description: The second line in a street address that a Snow device is to be delivered to. Street3: allOf: - $ref: '#/components/schemas/String' - description: The third line in a street address that a Snow device is to be delivered to. City: allOf: - $ref: '#/components/schemas/String' - description: The city in an address that a Snow device is to be delivered to. StateOrProvince: allOf: - $ref: '#/components/schemas/String' - description: The state or province in an address that a Snow device is to be delivered to. PrefectureOrDistrict: allOf: - $ref: '#/components/schemas/String' - description: This field is no longer used and the value is ignored. Landmark: allOf: - $ref: '#/components/schemas/String' - description: This field is no longer used and the value is ignored. Country: allOf: - $ref: '#/components/schemas/String' - description: The country in an address that a Snow device is to be delivered to. PostalCode: allOf: - $ref: '#/components/schemas/String' - description: The postal code in an address that a Snow device is to be delivered to. PhoneNumber: allOf: - $ref: '#/components/schemas/String' - description: The phone number associated with an address that a Snow device is to be delivered to. IsRestricted: allOf: - $ref: '#/components/schemas/Boolean' - description: If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions. Type: allOf: - $ref: '#/components/schemas/AddressType' - description: Differentiates between delivery address and pickup address in the customer account. Provided at job creation. description: The address that you want the Snow device(s) associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address are required, if the address is invalid or unsupported, then an exception is thrown. JobResource: type: object properties: S3Resources: allOf: - $ref: '#/components/schemas/S3ResourceList' - description: An array of S3Resource 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. ListJobsResult: type: object example: JobListEntries: - CreationDate: '1460678186.0' Description: MyJob IsMaster: false JobId: JID123e4567-e89b-12d3-a456-426655440000 JobState: New JobType: IMPORT SnowballType: STANDARD properties: JobListEntries: allOf: - $ref: '#/components/schemas/JobListEntryList' - description: 'Each JobListEntry 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 export jobs. ' NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array. JobMetadata: type: object properties: JobId: allOf: - $ref: '#/components/schemas/String' - description: The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. JobState: allOf: - $ref: '#/components/schemas/JobState' - description: The current status of the jobs. 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. Resources: allOf: - $ref: '#/components/schemas/JobResource' - description: An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. Description: allOf: - $ref: '#/components/schemas/String' - description: The description of the job, provided at job creation. KmsKeyARN: allOf: - $ref: '#/components/schemas/KmsKeyARN' - description: The Amazon Resource Name (ARN) for the Key Management Service (KMS) key associated with this job. This ARN was created using the CreateKey API action in KMS. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description: The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management. AddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The ID for the address that you want the Snow device shipped to. ShippingDetails: allOf: - $ref: '#/components/schemas/ShippingDetails' - description: A job's shipping information, including inbound and outbound tracking numbers and shipping speed options. SnowballCapacityPreference: allOf: - $ref: '#/components/schemas/SnowballCapacity' - description:

The Snow device capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

Notification: allOf: - $ref: '#/components/schemas/Notification' - description: The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type. DataTransferProgress: allOf: - $ref: '#/components/schemas/DataTransfer' - description: A value that defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. This data is only available while a job has a JobState value of InProgress, for both import and export jobs. JobLogInfo: allOf: - $ref: '#/components/schemas/JobLogs' - description: Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snow device for your job part is being delivered to you. ClusterId: allOf: - $ref: '#/components/schemas/String' - description: The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000. ForwardingAddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions. TaxDocuments: allOf: - $ref: '#/components/schemas/TaxDocuments' - description: The metadata associated with the tax documents required in your Amazon Web Services Region. DeviceConfiguration: $ref: '#/components/schemas/DeviceConfiguration' RemoteManagement: allOf: - $ref: '#/components/schemas/RemoteManagement' - description: Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, 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. LongTermPricingId: allOf: - $ref: '#/components/schemas/LongTermPricingId' - description: The ID of the long-term pricing type for the device. OnDeviceServiceConfiguration: allOf: - $ref: '#/components/schemas/OnDeviceServiceConfiguration' - description: Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device. ImpactLevel: allOf: - $ref: '#/components/schemas/ImpactLevel' - description: The highest impact level of data that will be stored or processed on the device, provided at job creation. PickupDetails: allOf: - $ref: '#/components/schemas/PickupDetails' - description: Information identifying the person picking up the device. SnowballId: allOf: - $ref: '#/components/schemas/String' - description: Unique ID associated with a device. description: Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the DescribeJob action. JobState: type: string enum: - New - PreparingAppliance - PreparingShipment - InTransitToCustomer - WithCustomer - InTransitToAWS - WithAWSSortingFacility - WithAWS - InProgress - Complete - Cancelled - Listing - Pending GetSnowballUsageRequest: type: object title: GetSnowballUsageRequest properties: {} ShipmentState: type: string enum: - RECEIVED - RETURNED GetSoftwareUpdatesResult: type: object properties: UpdatesURI: allOf: - $ref: '#/components/schemas/String' - description: The Amazon S3 presigned URL for the update file associated with the specified JobId value. The software update will be available for 2 days after this request is made. To access an update after the 2 days have passed, you'll have to make another call to GetSoftwareUpdates. DescribeAddressesRequest: type: object title: DescribeAddressesRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/ListLimit' - description: The number of ADDRESS objects to return. NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses. DevicePickupId: type: string pattern: DPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12} minLength: 40 maxLength: 40 SnowballCapacity: type: string enum: - T50 - T80 - T100 - T42 - T98 - T8 - T14 - T32 - NoPreference - T240 - T13 DescribeReturnShippingLabelRequest: type: object required: - JobId title: DescribeReturnShippingLabelRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000. 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. CreateLongTermPricingRequest: type: object required: - LongTermPricingType - SnowballType title: CreateLongTermPricingRequest properties: LongTermPricingType: allOf: - $ref: '#/components/schemas/LongTermPricingType' - description: The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing. IsLongTermPricingAutoRenew: allOf: - $ref: '#/components/schemas/JavaBoolean' - description: Specifies whether the current long-term pricing type for the device should be renewed. SnowballType: allOf: - $ref: '#/components/schemas/SnowballType' - description: The type of Snow Family devices to use for the long-term pricing job. InvalidResourceException: {} 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 EventTriggerDefinition$EventResourceARN. Timestamp: type: string format: date-time GetSnowballUsageResult: type: object example: SnowballLimit: 1 SnowballsInUse: 0 properties: SnowballLimit: allOf: - $ref: '#/components/schemas/Integer' - description: The service limit for number of Snow devices this account can have at once. The default service limit is 1 (one). SnowballsInUse: allOf: - $ref: '#/components/schemas/Integer' - description: The number of Snow devices that this account is currently using. CancelJobRequest: type: object required: - JobId title: CancelJobRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000. ListCompatibleImagesRequest: type: object title: ListCompatibleImagesRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/ListLimit' - description: The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs. NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. To identify what object comes "next" in the list of compatible images, you can specify a value for NextToken as the starting point for your list of returned images. UpdateLongTermPricingResult: type: object properties: {} ListCompatibleImagesResult: type: object properties: CompatibleImages: allOf: - $ref: '#/components/schemas/CompatibleImageList' - description: A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snow device AMI. NextToken: allOf: - $ref: '#/components/schemas/String' - description: Because HTTP requests are stateless, this is the starting point for your next list of returned images. CreateLongTermPricingResult: type: object properties: LongTermPricingId: allOf: - $ref: '#/components/schemas/LongTermPricingId' - description: The ID of the long-term pricing type for the device. 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 true, 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 LongTermPricingListEntry object contains information about a long-term pricing type. UpdateJobResult: type: object properties: {} JobMetadataList: type: array items: $ref: '#/components/schemas/JobMetadata' ServiceVersion: type: object properties: Version: allOf: - $ref: '#/components/schemas/String' - description: The version number of the requested service. description: The version of the requested service. JobType: type: string enum: - IMPORT - EXPORT - LOCAL_USE StorageUnit: type: string enum: - TB KmsKeyARN: type: string pattern: arn:aws.*:kms:.*:[0-9]{12}:key/.* maxLength: 255 NodeFaultTolerance: type: integer minimum: 1 maximum: 4 UpdateClusterResult: type: object properties: {} Ec2RequestFailedException: {} LongTermPricingEntryList: type: array items: $ref: '#/components/schemas/LongTermPricingListEntry' ServiceName: type: string enum: - KUBERNETES - EKS_ANYWHERE 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 AmiId: type: string pattern: (ami-[0-9a-f]{8})|(ami-[0-9a-f]{17}) minLength: 12 maxLength: 21 DescribeReturnShippingLabelResult: type: object properties: Status: allOf: - $ref: '#/components/schemas/ShippingLabelStatus' - description: The status information of the task on a Snow device that is being returned to Amazon Web Services. ExpirationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The expiration date of the current return shipping label. ReturnShippingLabelURI: allOf: - $ref: '#/components/schemas/String' - description: The pre-signed Amazon S3 URI used to download the return shipping label. Ec2AmiResourceList: type: array items: $ref: '#/components/schemas/Ec2AmiResource' 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 UpdateJobShipmentStateRequest: type: object required: - JobId - ShipmentState title: UpdateJobShipmentStateRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The job ID of the job whose shipment date you want to update, for example JID123e4567-e89b-12d3-a456-426655440000. ShipmentState: allOf: - $ref: '#/components/schemas/ShipmentState' - description:

The state of a device when it is being shipped.

Set to RECEIVED when the device arrives at your location.

Set to RETURNED when you have returned the device to Amazon Web Services.

CreateAddressResult: type: object example: AddressId: ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b properties: AddressId: allOf: - $ref: '#/components/schemas/String' - description: The automatically generated ID for a specific address. You'll use this ID when you create a job to specify which address you want the Snow device for that job shipped to. DependentServiceList: type: array items: $ref: '#/components/schemas/DependentService' Boolean: type: boolean CreateJobRequest: type: object title: CreateJobRequest properties: JobType: allOf: - $ref: '#/components/schemas/JobType' - description: 'Defines the type of job that you''re creating. ' Resources: allOf: - $ref: '#/components/schemas/JobResource' - description:

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

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 supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type. Description: allOf: - $ref: '#/components/schemas/String' - description: Defines an optional description of this specific job, for example Important Photos 2016-08-11. AddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The ID for the address that you want the Snow device shipped to. KmsKeyARN: allOf: - $ref: '#/components/schemas/KmsKeyARN' - description: The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey Key Management Service (KMS) API action. RoleARN: allOf: - $ref: '#/components/schemas/RoleARN' - description: The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole Identity and Access Management (IAM) API action. SnowballCapacityPreference: allOf: - $ref: '#/components/schemas/SnowballCapacity' - description:

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.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

ShippingOption: allOf: - $ref: '#/components/schemas/ShippingOption' - description:

The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:

Notification: allOf: - $ref: '#/components/schemas/Notification' - description: Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job. ClusterId: allOf: - $ref: '#/components/schemas/ClusterId' - description: The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster. SnowballType: allOf: - $ref: '#/components/schemas/SnowballType' - description:

The type of Snow Family devices to use for this job.

For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

The type of Amazon Web Services Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.

For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

ForwardingAddressId: allOf: - $ref: '#/components/schemas/AddressId' - description: The forwarding address ID for a job. 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. DeviceConfiguration: allOf: - $ref: '#/components/schemas/DeviceConfiguration' - description:

Defines the device configuration for an Snowcone job.

For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

RemoteManagement: allOf: - $ref: '#/components/schemas/RemoteManagement' - description: 'Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Edge client to manage the device. When set to NOT_INSTALLED, remote management will not be available on the device. ' LongTermPricingId: allOf: - $ref: '#/components/schemas/LongTermPricingId' - description: The ID of the long-term pricing type for the device. ImpactLevel: allOf: - $ref: '#/components/schemas/ImpactLevel' - description: The highest impact level of data that will be stored or processed on the device, provided at job creation. PickupDetails: allOf: - $ref: '#/components/schemas/PickupDetails' - description: Information identifying the person picking up the device. ShippingOption: type: string enum: - SECOND_DAY - NEXT_DAY - EXPRESS - STANDARD ListJobsRequest: type: object title: ListJobsRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/ListLimit' - description: The number of JobListEntry objects to return. NextToken: allOf: - $ref: '#/components/schemas/String' - description: HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list. AddressType: type: string enum: - CUST_PICKUP - AWS_SHIP RoleARN: type: string pattern: arn:aws.*:iam::[0-9]{12}:role/.* maxLength: 255 ListLongTermPricingRequest: type: object title: ListLongTermPricingRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/ListLimit' - description: The maximum number of ListLongTermPricing 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 ListLongTermPricing to return. CancelClusterRequest: type: object required: - ClusterId title: CancelClusterRequest properties: ClusterId: allOf: - $ref: '#/components/schemas/ClusterId' - description: The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000. TargetOnDeviceServiceList: type: array items: $ref: '#/components/schemas/TargetOnDeviceService' ListLimit: type: integer minimum: 0 maximum: 100 ClusterState: type: string enum: - AwaitingQuorum - Pending - InUse - Complete - Cancelled ShippingLabelStatus: type: string enum: - InProgress - TimedOut - Succeeded - Failed GetJobUnlockCodeRequest: type: object required: - JobId title: GetJobUnlockCodeRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000. LongTermPricingType: type: string enum: - OneYear - ThreeYear - OneMonth DescribeJobResult: type: object example: JobMetadata: AddressId: ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b CreationDate: '1475626164' Description: My Job JobId: JID123e4567-e89b-12d3-a456-426655440000 JobState: New JobType: IMPORT KmsKeyARN: arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456 Notification: JobStatesToNotify: [] NotifyAll: false Resources: S3Resources: - BucketArn: arn:aws:s3:::MyBucket KeyRange: {} RoleARN: arn:aws:iam::123456789012:role/snowball-import-S3-role ShippingDetails: ShippingOption: SECOND_DAY SnowballCapacityPreference: T80 SnowballType: STANDARD properties: JobMetadata: allOf: - $ref: '#/components/schemas/JobMetadata' - description: Information about a specific job, including shipping information, job status, and other important metadata. SubJobMetadata: allOf: - $ref: '#/components/schemas/JobMetadataList' - description: Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata. UpdateJobShipmentStateResult: type: object properties: {} DescribeClusterResult: type: object example: ClusterMetadata: AddressId: ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b ClusterId: CID123e4567-e89b-12d3-a456-426655440000 ClusterState: Pending CreationDate: '1480475517.0' Description: MyCluster JobType: LOCAL_USE KmsKeyARN: arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456 Notification: JobStatesToNotify: [] NotifyAll: false Resources: S3Resources: - BucketArn: arn:aws:s3:::MyBucket KeyRange: {} RoleARN: arn:aws:iam::123456789012:role/snowball-import-S3-role ShippingOption: SECOND_DAY properties: ClusterMetadata: allOf: - $ref: '#/components/schemas/ClusterMetadata' - description: Information about a specific cluster, including shipping information, cluster status, and other important metadata. 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: '>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 StorageLimit 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. SnsTopicARN: type: string pattern: arn:aws.*:sns:.*:[0-9]{12}:.* maxLength: 255 ServiceSize: type: integer minimum: 3 maximum: 16 CreateReturnShippingLabelRequest: type: object required: - JobId title: CreateReturnShippingLabelRequest properties: JobId: allOf: - $ref: '#/components/schemas/JobId' - description: The ID for a job that you want to create the return shipping label for; for example, JID123e4567-e89b-12d3-a456-426655440000. ShippingOption: allOf: - $ref: '#/components/schemas/ShippingOption' - description: 'The shipping speed for a particular job. This speed doesn''t dictate how soon the device is returned to Amazon Web Services. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:' 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 ListJobsResult$JobListEntries in this guide. DeviceServiceName: type: string enum: - NFS_ON_DEVICE_SERVICE - S3_ON_DEVICE_SERVICE CreateAddressRequest: type: object required: - Address title: CreateAddressRequest properties: Address: allOf: - $ref: '#/components/schemas/Address' - description: The address that you want the Snow device shipped to. 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 S3Resource objects to trigger the LambdaResource objects associated with this job. description: 'Identifies ' ListLongTermPricingResult: type: object properties: LongTermPricingEntries: allOf: - $ref: '#/components/schemas/LongTermPricingEntryList' - description: 'Each LongTermPricingEntry object contains a status, ID, and other information about the LongTermPricing type. ' NextToken: allOf: - $ref: '#/components/schemas/String' - description: Because HTTP requests are stateless, this is the starting point for your next list of returned ListLongTermPricing list. parameters: 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-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders 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-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/snowball/ x-hasEquivalentPaths: true