prowler-sdk-poc
Version:
769 lines (768 loc) • 73 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Snowball extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Snowball.Types.ClientConfiguration)
config: Config & Snowball.Types.ClientConfiguration;
/**
* 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.
*/
cancelCluster(params: Snowball.Types.CancelClusterRequest, callback?: (err: AWSError, data: Snowball.Types.CancelClusterResult) => void): Request<Snowball.Types.CancelClusterResult, AWSError>;
/**
* 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.
*/
cancelCluster(callback?: (err: AWSError, data: Snowball.Types.CancelClusterResult) => void): Request<Snowball.Types.CancelClusterResult, AWSError>;
/**
* 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.
*/
cancelJob(params: Snowball.Types.CancelJobRequest, callback?: (err: AWSError, data: Snowball.Types.CancelJobResult) => void): Request<Snowball.Types.CancelJobResult, AWSError>;
/**
* 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.
*/
cancelJob(callback?: (err: AWSError, data: Snowball.Types.CancelJobResult) => void): Request<Snowball.Types.CancelJobResult, AWSError>;
/**
* 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.
*/
createAddress(params: Snowball.Types.CreateAddressRequest, callback?: (err: AWSError, data: Snowball.Types.CreateAddressResult) => void): Request<Snowball.Types.CreateAddressResult, AWSError>;
/**
* 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.
*/
createAddress(callback?: (err: AWSError, data: Snowball.Types.CreateAddressResult) => void): Request<Snowball.Types.CreateAddressResult, AWSError>;
/**
* 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.
*/
createCluster(params: Snowball.Types.CreateClusterRequest, callback?: (err: AWSError, data: Snowball.Types.CreateClusterResult) => void): Request<Snowball.Types.CreateClusterResult, AWSError>;
/**
* 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.
*/
createCluster(callback?: (err: AWSError, data: Snowball.Types.CreateClusterResult) => void): Request<Snowball.Types.CreateClusterResult, AWSError>;
/**
* Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS 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 AWS Region. For more information about Region availability, see AWS Regional Services. AWS Snow Family device types and their capacities. Snow Family device type: SNC1_SSD Capacity: T14 Description: Snowcone Snow Family 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 Device type: STANDARD Capacity: T50 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore AWS Regions. Device type: STANDARD Capacity: T80 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore AWS Regions.
*/
createJob(params: Snowball.Types.CreateJobRequest, callback?: (err: AWSError, data: Snowball.Types.CreateJobResult) => void): Request<Snowball.Types.CreateJobResult, AWSError>;
/**
* Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS 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 AWS Region. For more information about Region availability, see AWS Regional Services. AWS Snow Family device types and their capacities. Snow Family device type: SNC1_SSD Capacity: T14 Description: Snowcone Snow Family 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 Device type: STANDARD Capacity: T50 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore AWS Regions. Device type: STANDARD Capacity: T80 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore AWS Regions.
*/
createJob(callback?: (err: AWSError, data: Snowball.Types.CreateJobResult) => void): Request<Snowball.Types.CreateJobResult, AWSError>;
/**
* 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 AWS provides discounts for long-term pricing.
*/
createLongTermPricing(params: Snowball.Types.CreateLongTermPricingRequest, callback?: (err: AWSError, data: Snowball.Types.CreateLongTermPricingResult) => void): Request<Snowball.Types.CreateLongTermPricingResult, AWSError>;
/**
* 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 AWS provides discounts for long-term pricing.
*/
createLongTermPricing(callback?: (err: AWSError, data: Snowball.Types.CreateLongTermPricingResult) => void): Request<Snowball.Types.CreateLongTermPricingResult, AWSError>;
/**
* Creates a shipping label that will be used to return the Snow device to AWS.
*/
createReturnShippingLabel(params: Snowball.Types.CreateReturnShippingLabelRequest, callback?: (err: AWSError, data: Snowball.Types.CreateReturnShippingLabelResult) => void): Request<Snowball.Types.CreateReturnShippingLabelResult, AWSError>;
/**
* Creates a shipping label that will be used to return the Snow device to AWS.
*/
createReturnShippingLabel(callback?: (err: AWSError, data: Snowball.Types.CreateReturnShippingLabelResult) => void): Request<Snowball.Types.CreateReturnShippingLabelResult, AWSError>;
/**
* Takes an AddressId and returns specific details about that address in the form of an Address object.
*/
describeAddress(params: Snowball.Types.DescribeAddressRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeAddressResult) => void): Request<Snowball.Types.DescribeAddressResult, AWSError>;
/**
* Takes an AddressId and returns specific details about that address in the form of an Address object.
*/
describeAddress(callback?: (err: AWSError, data: Snowball.Types.DescribeAddressResult) => void): Request<Snowball.Types.DescribeAddressResult, AWSError>;
/**
* 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.
*/
describeAddresses(params: Snowball.Types.DescribeAddressesRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeAddressesResult) => void): Request<Snowball.Types.DescribeAddressesResult, AWSError>;
/**
* 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.
*/
describeAddresses(callback?: (err: AWSError, data: Snowball.Types.DescribeAddressesResult) => void): Request<Snowball.Types.DescribeAddressesResult, AWSError>;
/**
* Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
*/
describeCluster(params: Snowball.Types.DescribeClusterRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeClusterResult) => void): Request<Snowball.Types.DescribeClusterResult, AWSError>;
/**
* Returns information about a specific cluster including shipping information, cluster status, and other important metadata.
*/
describeCluster(callback?: (err: AWSError, data: Snowball.Types.DescribeClusterResult) => void): Request<Snowball.Types.DescribeClusterResult, AWSError>;
/**
* Returns information about a specific job including shipping information, job status, and other important metadata.
*/
describeJob(params: Snowball.Types.DescribeJobRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeJobResult) => void): Request<Snowball.Types.DescribeJobResult, AWSError>;
/**
* Returns information about a specific job including shipping information, job status, and other important metadata.
*/
describeJob(callback?: (err: AWSError, data: Snowball.Types.DescribeJobResult) => void): Request<Snowball.Types.DescribeJobResult, AWSError>;
/**
* Information on the shipping label of a Snow device that is being returned to AWS.
*/
describeReturnShippingLabel(params: Snowball.Types.DescribeReturnShippingLabelRequest, callback?: (err: AWSError, data: Snowball.Types.DescribeReturnShippingLabelResult) => void): Request<Snowball.Types.DescribeReturnShippingLabelResult, AWSError>;
/**
* Information on the shipping label of a Snow device that is being returned to AWS.
*/
describeReturnShippingLabel(callback?: (err: AWSError, data: Snowball.Types.DescribeReturnShippingLabelResult) => void): Request<Snowball.Types.DescribeReturnShippingLabelResult, AWSError>;
/**
* 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. 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.
*/
getJobManifest(params: Snowball.Types.GetJobManifestRequest, callback?: (err: AWSError, data: Snowball.Types.GetJobManifestResult) => void): Request<Snowball.Types.GetJobManifestResult, AWSError>;
/**
* 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. 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.
*/
getJobManifest(callback?: (err: AWSError, data: Snowball.Types.GetJobManifestResult) => void): Request<Snowball.Types.GetJobManifestResult, AWSError>;
/**
* 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. 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.
*/
getJobUnlockCode(params: Snowball.Types.GetJobUnlockCodeRequest, callback?: (err: AWSError, data: Snowball.Types.GetJobUnlockCodeResult) => void): Request<Snowball.Types.GetJobUnlockCodeResult, AWSError>;
/**
* 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. 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.
*/
getJobUnlockCode(callback?: (err: AWSError, data: Snowball.Types.GetJobUnlockCodeResult) => void): Request<Snowball.Types.GetJobUnlockCodeResult, AWSError>;
/**
* 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 AWS Support.
*/
getSnowballUsage(params: Snowball.Types.GetSnowballUsageRequest, callback?: (err: AWSError, data: Snowball.Types.GetSnowballUsageResult) => void): Request<Snowball.Types.GetSnowballUsageResult, AWSError>;
/**
* 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 AWS Support.
*/
getSnowballUsage(callback?: (err: AWSError, data: Snowball.Types.GetSnowballUsageResult) => void): Request<Snowball.Types.GetSnowballUsageResult, AWSError>;
/**
* Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
*/
getSoftwareUpdates(params: Snowball.Types.GetSoftwareUpdatesRequest, callback?: (err: AWSError, data: Snowball.Types.GetSoftwareUpdatesResult) => void): Request<Snowball.Types.GetSoftwareUpdatesResult, AWSError>;
/**
* Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.
*/
getSoftwareUpdates(callback?: (err: AWSError, data: Snowball.Types.GetSoftwareUpdatesResult) => void): Request<Snowball.Types.GetSoftwareUpdatesResult, AWSError>;
/**
* 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.
*/
listClusterJobs(params: Snowball.Types.ListClusterJobsRequest, callback?: (err: AWSError, data: Snowball.Types.ListClusterJobsResult) => void): Request<Snowball.Types.ListClusterJobsResult, AWSError>;
/**
* 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.
*/
listClusterJobs(callback?: (err: AWSError, data: Snowball.Types.ListClusterJobsResult) => void): Request<Snowball.Types.ListClusterJobsResult, AWSError>;
/**
* 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.
*/
listClusters(params: Snowball.Types.ListClustersRequest, callback?: (err: AWSError, data: Snowball.Types.ListClustersResult) => void): Request<Snowball.Types.ListClustersResult, AWSError>;
/**
* 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.
*/
listClusters(callback?: (err: AWSError, data: Snowball.Types.ListClustersResult) => void): Request<Snowball.Types.ListClustersResult, AWSError>;
/**
* This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snow device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace.
*/
listCompatibleImages(params: Snowball.Types.ListCompatibleImagesRequest, callback?: (err: AWSError, data: Snowball.Types.ListCompatibleImagesResult) => void): Request<Snowball.Types.ListCompatibleImagesResult, AWSError>;
/**
* This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snow device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace.
*/
listCompatibleImages(callback?: (err: AWSError, data: Snowball.Types.ListCompatibleImagesResult) => void): Request<Snowball.Types.ListCompatibleImagesResult, AWSError>;
/**
* 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.
*/
listJobs(params: Snowball.Types.ListJobsRequest, callback?: (err: AWSError, data: Snowball.Types.ListJobsResult) => void): Request<Snowball.Types.ListJobsResult, AWSError>;
/**
* 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.
*/
listJobs(callback?: (err: AWSError, data: Snowball.Types.ListJobsResult) => void): Request<Snowball.Types.ListJobsResult, AWSError>;
/**
* Lists all long-term pricing types.
*/
listLongTermPricing(params: Snowball.Types.ListLongTermPricingRequest, callback?: (err: AWSError, data: Snowball.Types.ListLongTermPricingResult) => void): Request<Snowball.Types.ListLongTermPricingResult, AWSError>;
/**
* Lists all long-term pricing types.
*/
listLongTermPricing(callback?: (err: AWSError, data: Snowball.Types.ListLongTermPricingResult) => void): Request<Snowball.Types.ListLongTermPricingResult, AWSError>;
/**
* 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.
*/
updateCluster(params: Snowball.Types.UpdateClusterRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateClusterResult) => void): Request<Snowball.Types.UpdateClusterResult, AWSError>;
/**
* 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.
*/
updateCluster(callback?: (err: AWSError, data: Snowball.Types.UpdateClusterResult) => void): Request<Snowball.Types.UpdateClusterResult, AWSError>;
/**
* 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.
*/
updateJob(params: Snowball.Types.UpdateJobRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateJobResult) => void): Request<Snowball.Types.UpdateJobResult, AWSError>;
/**
* 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.
*/
updateJob(callback?: (err: AWSError, data: Snowball.Types.UpdateJobResult) => void): Request<Snowball.Types.UpdateJobResult, AWSError>;
/**
* Updates the state when a shipment state changes to a different state.
*/
updateJobShipmentState(params: Snowball.Types.UpdateJobShipmentStateRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateJobShipmentStateResult) => void): Request<Snowball.Types.UpdateJobShipmentStateResult, AWSError>;
/**
* Updates the state when a shipment state changes to a different state.
*/
updateJobShipmentState(callback?: (err: AWSError, data: Snowball.Types.UpdateJobShipmentStateResult) => void): Request<Snowball.Types.UpdateJobShipmentStateResult, AWSError>;
/**
* Updates the long-term pricing type.
*/
updateLongTermPricing(params: Snowball.Types.UpdateLongTermPricingRequest, callback?: (err: AWSError, data: Snowball.Types.UpdateLongTermPricingResult) => void): Request<Snowball.Types.UpdateLongTermPricingResult, AWSError>;
/**
* Updates the long-term pricing type.
*/
updateLongTermPricing(callback?: (err: AWSError, data: Snowball.Types.UpdateLongTermPricingResult) => void): Request<Snowball.Types.UpdateLongTermPricingResult, AWSError>;
}
declare namespace Snowball {
export interface Address {
/**
* The unique ID for an address.
*/
AddressId?: AddressId;
/**
* The name of a person to receive a Snow device at an address.
*/
Name?: String;
/**
* The name of the company to receive a Snow device at an address.
*/
Company?: String;
/**
* The first line in a street address that a Snow device is to be delivered to.
*/
Street1?: String;
/**
* The second line in a street address that a Snow device is to be delivered to.
*/
Street2?: String;
/**
* The third line in a street address that a Snow device is to be delivered to.
*/
Street3?: String;
/**
* The city in an address that a Snow device is to be delivered to.
*/
City?: String;
/**
* The state or province in an address that a Snow device is to be delivered to.
*/
StateOrProvince?: String;
/**
* This field is no longer used and the value is ignored.
*/
PrefectureOrDistrict?: String;
/**
* This field is no longer used and the value is ignored.
*/
Landmark?: String;
/**
* The country in an address that a Snow device is to be delivered to.
*/
Country?: String;
/**
* The postal code in an address that a Snow device is to be delivered to.
*/
PostalCode?: String;
/**
* The phone number associated with an address that a Snow device is to be delivered to.
*/
PhoneNumber?: String;
/**
* If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
*/
IsRestricted?: Boolean;
}
export type AddressId = string;
export type AddressList = Address[];
export type AmiId = string;
export type Boolean = boolean;
export interface CancelClusterRequest {
/**
* The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000.
*/
ClusterId: ClusterId;
}
export interface CancelClusterResult {
}
export interface CancelJobRequest {
/**
* The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface CancelJobResult {
}
export type ClusterId = string;
export interface ClusterListEntry {
/**
* The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.
*/
ClusterId?: String;
/**
* The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.
*/
ClusterState?: ClusterState;
/**
* The creation date for this cluster.
*/
CreationDate?: Timestamp;
/**
* Defines an optional description of the cluster, for example Environmental Data Cluster-01.
*/
Description?: String;
}
export type ClusterListEntryList = ClusterListEntry[];
export interface ClusterMetadata {
/**
* The automatically generated ID for a cluster.
*/
ClusterId?: String;
/**
* The optional description of the cluster.
*/
Description?: String;
/**
* The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).
*/
KmsKeyARN?: KmsKeyARN;
/**
* The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
*/
RoleARN?: RoleARN;
/**
* The current status of the cluster.
*/
ClusterState?: ClusterState;
/**
* The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.
*/
JobType?: JobType;
/**
* The type of AWS Snow device to use for this cluster. For cluster jobs, AWS Snow Family currently supports only the EDGE device type.
*/
SnowballType?: SnowballType;
/**
* The creation date for this cluster.
*/
CreationDate?: Timestamp;
/**
* The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
*/
Resources?: JobResource;
/**
* The automatically generated ID for a specific address.
*/
AddressId?: AddressId;
/**
* 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.
*/
ShippingOption?: ShippingOption;
/**
* The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
*/
Notification?: Notification;
/**
* 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.
*/
ForwardingAddressId?: AddressId;
/**
* The tax documents required in your AWS Region.
*/
TaxDocuments?: TaxDocuments;
/**
* Represents metadata and configuration settings for services on an AWS Snow Family device.
*/
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
}
export type ClusterState = "AwaitingQuorum"|"Pending"|"InUse"|"Complete"|"Cancelled"|string;
export interface CompatibleImage {
/**
* The unique identifier for an individual Snow device AMI.
*/
AmiId?: String;
/**
* The optional name of a compatible image.
*/
Name?: String;
}
export type CompatibleImageList = CompatibleImage[];
export interface CreateAddressRequest {
/**
* The address that you want the Snow device shipped to.
*/
Address: Address;
}
export interface CreateAddressResult {
/**
* 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.
*/
AddressId?: String;
}
export interface CreateClusterRequest {
/**
* 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.
*/
JobType: JobType;
/**
* The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.
*/
Resources: JobResource;
/**
* Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
*/
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
/**
* An optional description of this specific cluster, for example Environmental Data Cluster-01.
*/
Description?: String;
/**
* The ID for the address that you want the cluster shipped to.
*/
AddressId: AddressId;
/**
* The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).
*/
KmsKeyARN?: KmsKeyARN;
/**
* The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).
*/
RoleARN: RoleARN;
/**
* The type of AWS Snow Family device to use for this cluster. For cluster jobs, AWS 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.
*/
SnowballType: SnowballType;
/**
* 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: In Australia, you have access to express shipping. Typically, Snow 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 United States of America (US), you have access to one-day shipping and two-day shipping. 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.
*/
ShippingOption: ShippingOption;
/**
* The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
*/
Notification?: Notification;
/**
* The forwarding address ID for a cluster. This field is not supported in most regions.
*/
ForwardingAddressId?: AddressId;
/**
* The tax documents required in your AWS Region.
*/
TaxDocuments?: TaxDocuments;
/**
* 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.
*/
RemoteManagement?: RemoteManagement;
}
export interface CreateClusterResult {
/**
* The automatically generated ID for a cluster.
*/
ClusterId?: ClusterId;
}
export interface CreateJobRequest {
/**
* Defines the type of job that you're creating.
*/
JobType?: JobType;
/**
* 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.
*/
Resources?: JobResource;
/**
* Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).
*/
OnDeviceServiceConfiguration?: OnDeviceServiceConfiguration;
/**
* Defines an optional description of this specific job, for example Important Photos 2016-08-11.
*/
Description?: String;
/**
* The ID for the address that you want the Snow device shipped to.
*/
AddressId?: AddressId;
/**
* The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.
*/
KmsKeyARN?: KmsKeyARN;
/**
* The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.
*/
RoleARN?: RoleARN;
/**
* 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.
*/
SnowballCapacityPreference?: SnowballCapacity;
/**
* 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: In Australia, you have access to express shipping. Typically, Snow 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.
*/
ShippingOption?: ShippingOption;
/**
* Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
*/
Notification?: Notification;
/**
* 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.
*/
ClusterId?: ClusterId;
/**
* The type of AWS Snow Family device to use for this job. For cluster jobs, AWS Snow Family currently supports only the EDGE device type. The type of AWS 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.
*/
SnowballType?: SnowballType;
/**
* The forwarding address ID for a job. This field is not supported in most Regions.
*/
ForwardingAddressId?: AddressId;
/**
* The tax documents required in your AWS Region.
*/
TaxDocuments?: TaxDocuments;
/**
* Defines the device configuration for an AWS 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.
*/
DeviceConfiguration?: DeviceConfiguration;
/**
* 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.
*/
RemoteManagement?: RemoteManagement;
/**
* The ID of the long-term pricing type for the device.
*/
LongTermPricingId?: LongTermPricingId;
}
export interface CreateJobResult {
/**
* The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId?: JobId;
}
export interface CreateLongTermPricingRequest {
/**
* The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing.
*/
LongTermPricingType: LongTermPricingType;
/**
* Specifies whether the current long-term pricing type for the device should be renewed.
*/
IsLongTermPricingAutoRenew?: JavaBoolean;
/**
* The type of AWS Snow Family device to use for the long-term pricing job.
*/
SnowballType?: SnowballType;
}
export interface CreateLongTermPricingResult {
/**
* The ID of the long-term pricing type for the device.
*/
LongTermPricingId?: LongTermPricingId;
}
export interface CreateReturnShippingLabelRequest {
/**
* The ID for a job that you want to create the return shipping label for; for example, JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
/**
* The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to AWS. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:
*/
ShippingOption?: ShippingOption;
}
export interface CreateReturnShippingLabelResult {
/**
* The status information of the task on a Snow device that is being returned to AWS.
*/
Status?: ShippingLabelStatus;
}
export interface DataTransfer {
/**
* The number of bytes transferred between a Snow device and Amazon S3.
*/
BytesTransferred?: Long;
/**
* The number of objects transferred between a Snow device and Amazon S3.
*/
ObjectsTransferred?: Long;
/**
* 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.
*/
TotalBytes?: Long;
/**
* 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.
*/
TotalObjects?: Long;
}
export interface DescribeAddressRequest {
/**
* The automatically generated ID for a specific address.
*/
AddressId: AddressId;
}
export interface DescribeAddressResult {
/**
* The address that you want the Snow device(s) associated with a specific job to be shipped to.
*/
Address?: Address;
}
export interface DescribeAddressesRequest {
/**
* The number of ADDRESS objects to return.
*/
MaxResults?: ListLimit;
/**
* 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.
*/
NextToken?: String;
}
export interface DescribeAddressesResult {
/**
* The Snow device shipping addresses that were created for this account.
*/
Addresses?: AddressList;
/**
* 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.
*/
NextToken?: String;
}
export interface DescribeClusterRequest {
/**
* The automatically generated ID for a cluster.
*/
ClusterId: ClusterId;
}
export interface DescribeClusterResult {
/**
* Information about a specific cluster, including shipping information, cluster status, and other important metadata.
*/
ClusterMetadata?: ClusterMetadata;
}
export interface DescribeJobRequest {
/**
* The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface DescribeJobResult {
/**
* Information about a specific job, including shipping information, job status, and other important metadata.
*/
JobMetadata?: JobMetadata;
/**
* Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.
*/
SubJobMetadata?: JobMetadataList;
}
export interface DescribeReturnShippingLabelRequest {
/**
* The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface DescribeReturnShippingLabelResult {
/**
* The status information of the task on a Snow device that is being returned to AWS.
*/
Status?: ShippingLabelStatus;
/**
* The expiration date of the current return shipping label.
*/
ExpirationDate?: Timestamp;
}
export interface DeviceConfiguration {
/**
* Returns information about the device configuration for an AWS Snowcone job.
*/
SnowconeDeviceConfiguration?: SnowconeDeviceConfiguration;
}
export type DeviceServiceName = "NFS_ON_DEVICE_SERVICE"|"S3_ON_DEVICE_SERVICE"|string;
export interface Ec2AmiResource {
/**
* The ID of the AMI in Amazon EC2.
*/
AmiId: AmiId;
/**
* The ID of the AMI on the Snow device.
*/
SnowballAmiId?: String;
}
export type Ec2AmiResourceList = Ec2AmiResource[];
export interface EventTriggerDefinition {
/**
* The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an AWS Lambda function's event trigger associated with this job.
*/
EventResourceARN?: ResourceARN;
}
export type EventTriggerDefinitionList = EventTriggerDefinition[];
export type GSTIN = string;
export interface GetJobManifestRequest {
/**
* The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface GetJobManifestResult {
/**
* The Amazon S3 presigned URL for the manifest file associated with the specified JobId value.
*/
ManifestURI?: String;
}
export interface GetJobUnlockCodeRequest {
/**
* The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface GetJobUnlockCodeResult {
/**
* The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 360 days after the job has been created.
*/
UnlockCode?: String;
}
export interface GetSnowballUsageRequest {
}
export interface GetSnowballUsageResult {
/**
* The service limit for number of Snow devices this account can have at once. The default service limit is 1 (one).
*/
SnowballLimit?: Integer;
/**
* The number of Snow devices that this account is currently using.
*/
SnowballsInUse?: Integer;
}
export interface GetSoftwareUpdatesRequest {
/**
* The ID for a job that you want to get the software update file for, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId: JobId;
}
export interface GetSoftwareUpdatesResult {
/**
* 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.
*/
UpdatesURI?: String;
}
export interface INDTaxDocuments {
/**
* The Goods and Services Tax (GST) documents required in AWS Regions in India.
*/
GSTIN?: GSTIN;
}
export type Integer = number;
export type JavaBoolean = boolean;
export type JobId = string;
export interface JobListEntry {
/**
* The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.
*/
JobId?: String;
/**
* The current state of this job.
*/
JobState?: JobState;
/**
* 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.
*/
IsMaster?: Boolean;
/**
* The type of job.
*/
JobType?: JobType;
/**
* The type of device used with this job.
*/