openapi: 3.0.0
info:
version: '2016-06-30'
x-release: v4
title: 'Amazon Import/Export Snowball #X Amz Target=AWSIESnowballJobManagementService.CancelCluster #X Amz Target=AWSIESnowballJobManagementService.CancelCluster #X Amz Target=AWSIESnowballJobManagementService.DescribeCluster API'
description: The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: snowball
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/snowball-2016-06-30.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://snowball.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Snowball multi-region endpoint
- url: https://snowball.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon Snowball multi-region endpoint
- url: http://snowball.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Snowball endpoint for China (Beijing) and China (Ningxia)
- url: https://snowball.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon Snowball endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSIESnowballJobManagementService.DescribeCluster'
paths:
/#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:
- '#X Amz Target=AWSIESnowballJobManagementService.DescribeCluster'
components:
schemas:
AmiId:
type: string
pattern: (ami-[0-9a-f]{8})|(ami-[0-9a-f]{17})
minLength: 12
maxLength: 21
DeviceServiceName:
type: string
enum:
- NFS_ON_DEVICE_SERVICE
- S3_ON_DEVICE_SERVICE
SnsTopicARN:
type: string
pattern: arn:aws.*:sns:.*:[0-9]{12}:.*
maxLength: 255
String:
type: string
pattern: .*
minLength: 1
maxLength: 1024
EventTriggerDefinition:
type: object
properties:
EventResourceARN:
allOf:
- $ref: '#/components/schemas/ResourceARN'
- description: The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.
description: The container for the EventTriggerDefinition$EventResourceARN.
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.
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:
In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.
In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.
In India, Snow devices are delivered in one to seven days.
In the US, you have access to one-day shipping and two-day shipping.
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.
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.
TargetOnDeviceServiceList:
type: array
items:
$ref: '#/components/schemas/TargetOnDeviceService'
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.
RoleARN:
type: string
pattern: arn:aws.*:iam::[0-9]{12}:role/.*
maxLength: 255
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.
DescribeClusterRequest:
type: object
required:
- ClusterId
title: DescribeClusterRequest
properties:
ClusterId:
allOf:
- $ref: '#/components/schemas/ClusterId'
- description: The automatically generated ID for a cluster.
LambdaResourceList:
type: array
items:
$ref: '#/components/schemas/LambdaResource'
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
InvalidResourceException: {}
JobStateList:
type: array
items:
$ref: '#/components/schemas/JobState'
S3ResourceList:
type: array
items:
$ref: '#/components/schemas/S3Resource'
SnowballType:
type: string
enum:
- STANDARD
- EDGE
- EDGE_C
- EDGE_CG
- EDGE_S
- SNC1_HDD
- SNC1_SSD
- V3_5C
- V3_5S
- RACK_5U_C
EKSOnDeviceServiceConfiguration:
type: object
properties:
KubernetesVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: The Kubernetes version for EKS Anywhere on the Snow Family device.
EKSAnywhereVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: The version of EKS Anywhere on the Snow Family device.
description: An object representing the metadata and configuration settings of EKS Anywhere on the Snow Family device.
EventTriggerDefinitionList:
type: array
items:
$ref: '#/components/schemas/EventTriggerDefinition'
JobState:
type: string
enum:
- New
- PreparingAppliance
- PreparingShipment
- InTransitToCustomer
- WithCustomer
- InTransitToAWS
- WithAWSSortingFacility
- WithAWS
- InProgress
- Complete
- Cancelled
- Listing
- Pending
NodeFaultTolerance:
type: integer
minimum: 1
maximum: 4
StorageUnit:
type: string
enum:
- TB
StorageLimit:
type: integer
minimum: 0
ShippingOption:
type: string
enum:
- SECOND_DAY
- NEXT_DAY
- EXPRESS
- STANDARD
KeyRange:
type: object
properties:
BeginMarker:
allOf:
- $ref: '#/components/schemas/String'
- description: The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
EndMarker:
allOf:
- $ref: '#/components/schemas/String'
- description: The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
description: Contains a key range. For export jobs, a 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.
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).
AddressId:
type: string
pattern: ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
minLength: 40
maxLength: 40
S3OnDeviceServiceConfiguration:
type: object
properties:
StorageLimit:
allOf:
- $ref: '#/components/schemas/S3StorageLimit'
- description: If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.
StorageUnit:
allOf:
- $ref: '#/components/schemas/StorageUnit'
- description: Storage unit. Currently the only supported unit is TB.
ServiceSize:
allOf:
- $ref: '#/components/schemas/ServiceSize'
- description: Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.
FaultTolerance:
allOf:
- $ref: '#/components/schemas/NodeFaultTolerance'
- description: '>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.
TaxDocuments:
type: object
properties:
IND:
$ref: '#/components/schemas/INDTaxDocuments'
description: The tax documents required in your Amazon Web Services Region.
Timestamp:
type: string
format: date-time
NFSOnDeviceServiceConfiguration:
type: object
properties:
StorageLimit:
allOf:
- $ref: '#/components/schemas/StorageLimit'
- description: The maximum NFS storage for one Snow Family device.
StorageUnit:
allOf:
- $ref: '#/components/schemas/StorageUnit'
- description: '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. 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 ' INDTaxDocuments: type: object properties: GSTIN: allOf: - $ref: '#/components/schemas/GSTIN' - description: The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India. description: The tax documents required in Amazon Web Services Region in India. TransferOption: type: string enum: - IMPORT - EXPORT - LOCAL_USE parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/snowball/ x-hasEquivalentPaths: true