Module Smaws_Client_Snowball

Snowball client library built on EIO.

Types

type nonrec wireless_connection = {
  1. is_wifi_enabled : bool option;
    (*

    Enables the Wi-Fi adapter on an Snowcone device.

    *)
}

Configures the wireless connection on an Snowcone device.

type nonrec update_long_term_pricing_request = {
  1. is_long_term_pricing_auto_renew : bool option;
    (*

    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.

    *)
  2. replacement_job : string option;
    (*

    Specifies that a device that is ordered with long-term pricing should be replaced with a new device.

    *)
  3. long_term_pricing_id : string;
    (*

    The ID of the long-term pricing type for the device.

    *)
}
type nonrec invalid_resource_exception = {
  1. resource_type : string option;
    (*

    The provided resource value is invalid.

    *)
  2. message : string option;
}

The specified resource can't be found. Check the information you provided in your last request, and try again.

type nonrec shipment_state =
  1. | RETURNED
  2. | RECEIVED
type nonrec update_job_shipment_state_request = {
  1. shipment_state : shipment_state;
    (*

    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.

    *)
  2. job_id : string;
    (*

    The job ID of the job whose shipment date you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec invalid_job_state_exception = {
  1. message : string option;
}

The action can't be performed because the job's current state doesn't allow that action to be performed.

type nonrec job_state =
  1. | PENDING
  2. | LISTING
  3. | CANCELLED
  4. | COMPLETE
  5. | IN_PROGRESS
  6. | WITH_AWS
  7. | WITH_AWS_SORTING_FACILITY
  8. | IN_TRANSIT_TO_AWS
  9. | WITH_CUSTOMER
  10. | IN_TRANSIT_TO_CUSTOMER
  11. | PREPARING_SHIPMENT
  12. | PREPARING_APPLIANCE
  13. | NEW
type nonrec notification = {
  1. device_pickup_sns_topic_ar_n : string option;
    (*

    Used to send SNS notifications for the person picking up the device (identified during job creation).

    *)
  2. notify_all : bool option;
    (*

    Any change in job state will trigger a notification for this job.

    *)
  3. job_states_to_notify : job_state list option;
    (*

    The list of job states that will trigger a notification for this job.

    *)
  4. sns_topic_ar_n : string option;
    (*

    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.

    *)
}

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.

type nonrec key_range = {
  1. end_marker : string option;
    (*

    The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

    *)
  2. begin_marker : string option;
    (*

    The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

    *)
}

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.

type nonrec device_service_name =
  1. | S3_ON_DEVICE_SERVICE
  2. | NFS_ON_DEVICE_SERVICE
type nonrec transfer_option =
  1. | LOCAL_USE
  2. | EXPORT
  3. | IMPORT
type nonrec target_on_device_service = {
  1. transfer_option : transfer_option option;
    (*

    Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.

    *)
  2. service_name : device_service_name option;
    (*

    Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.

    *)
}

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).

type nonrec s3_resource = {
  1. target_on_device_services : target_on_device_service list option;
    (*

    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).

    *)
  2. key_range : key_range option;
    (*

    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.

    *)
  3. bucket_arn : string option;
    (*

    The Amazon Resource Name (ARN) of an Amazon S3 bucket.

    *)
}

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.

type nonrec event_trigger_definition = {
  1. event_resource_ar_n : string option;
    (*

    The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.

    *)
}

The container for the EventTriggerDefinition$EventResourceARN.

type nonrec lambda_resource = {
  1. event_triggers : event_trigger_definition list option;
    (*

    The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.

    *)
  2. lambda_arn : string option;
    (*

    An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.

    *)
}

Identifies

type nonrec ec2_ami_resource = {
  1. snowball_ami_id : string option;
    (*

    The ID of the AMI on the Snow device.

    *)
  2. ami_id : string;
    (*

    The ID of the AMI in Amazon EC2.

    *)
}

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.

type nonrec job_resource = {
  1. ec2_ami_resources : ec2_ami_resource list option;
    (*

    The Amazon Machine Images (AMIs) associated with this job.

    *)
  2. lambda_resources : lambda_resource list option;
    (*

    The Python-language Lambda functions for this job.

    *)
  3. s3_resources : s3_resource list option;
    (*

    An array of S3Resource objects.

    *)
}

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.

type nonrec storage_unit =
  1. | TB
type nonrec nfs_on_device_service_configuration = {
  1. storage_unit : storage_unit option;
    (*

    The scale unit of the NFS storage on the device.

    Valid values: TB.

    *)
  2. storage_limit : int option;
    (*

    The maximum NFS storage for one Snow Family device.

    *)
}

An object that represents the metadata and configuration settings for the NFS (Network File System) service on an Amazon Web Services Snow Family device.

type nonrec tgw_on_device_service_configuration = {
  1. storage_unit : storage_unit option;
    (*

    The scale unit of the virtual tapes on the device.

    *)
  2. storage_limit : int option;
    (*

    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.

    *)
}

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.

type nonrec eks_on_device_service_configuration = {
  1. eks_anywhere_version : string option;
    (*

    The optional version of EKS Anywhere on the Snow Family device.

    *)
  2. kubernetes_version : string option;
    (*

    The Kubernetes version for EKS Anywhere on the Snow Family device.

    *)
}

An object representing the metadata and configuration settings of EKS Anywhere on the Snow Family device.

type nonrec s3_on_device_service_configuration = {
  1. fault_tolerance : int option;
    (*

    >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.

    *)
  2. service_size : int option;
    (*

    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.

    *)
  3. storage_unit : storage_unit option;
    (*

    Storage unit. Currently the only supported unit is TB.

    *)
  4. storage_limit : float option;
    (*

    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.

    *)
}

Amazon S3 compatible storage on Snow family devices configuration items.

type nonrec on_device_service_configuration = {
  1. s3_on_device_service : s3_on_device_service_configuration option;
    (*

    Configuration for Amazon S3 compatible storage on Snow family devices.

    *)
  2. eks_on_device_service : eks_on_device_service_configuration option;
    (*

    The configuration of EKS Anywhere on the Snow Family device.

    *)
  3. tgw_on_device_service : tgw_on_device_service_configuration option;
    (*

    Represents the Storage Gateway service Tape Gateway type on a Snow Family device.

    *)
  4. nfs_on_device_service : nfs_on_device_service_configuration option;
    (*

    Represents the NFS (Network File System) service on a Snow Family device.

    *)
}

An object that represents the metadata and configuration settings for services on an Amazon Web Services Snow Family device.

type nonrec shipping_option =
  1. | STANDARD
  2. | EXPRESS
  3. | NEXT_DAY
  4. | SECOND_DAY
type nonrec snowball_capacity =
  1. | T13
  2. | T240
  3. | NO_PREFERENCE
  4. | T32
  5. | T14
  6. | T8
  7. | T98
  8. | T42
  9. | T100
  10. | T80
  11. | T50
type nonrec pickup_details = {
  1. device_pickup_id : string option;
    (*

    The unique ID for a device that will be picked up.

    *)
  2. identification_issuing_org : string option;
    (*

    Organization that issued the credential identifying the person picking up the device.

    *)
  3. identification_expiration_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    Expiration date of the credential identifying the person picking up the device.

    *)
  4. identification_number : string option;
    (*

    The number on the credential identifying the person picking up the device.

    *)
  5. email : string option;
    (*

    The email address of the person picking up the device.

    *)
  6. phone_number : string option;
    (*

    The phone number of the person picking up the device.

    *)
  7. name : string option;
    (*

    The name of the person picking up the device.

    *)
}

Information identifying the person picking up the device.

type nonrec update_job_request = {
  1. pickup_details : pickup_details option;
  2. forwarding_address_id : string option;
    (*

    The updated ID for the forwarding address for a job. This field is not supported in most regions.

    *)
  3. snowball_capacity_preference : snowball_capacity option;
    (*

    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.

    *)
  4. description : string option;
    (*

    The updated description of this job's JobMetadata object.

    *)
  5. shipping_option : shipping_option option;
    (*

    The updated shipping option value of this job's ShippingDetails object.

    *)
  6. address_id : string option;
    (*

    The ID of the updated Address object.

    *)
  7. on_device_service_configuration : on_device_service_configuration option;
    (*

    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.

    *)
  8. resources : job_resource option;
    (*

    The updated JobResource object, or the updated JobResource object.

    *)
  9. notification : notification option;
    (*

    The new or updated Notification object.

    *)
  10. role_ar_n : string option;
    (*

    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.

    *)
  11. job_id : string;
    (*

    The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec kms_request_failed_exception = {
  1. message : string option;
}

The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

type nonrec invalid_input_combination_exception = {
  1. message : string option;
}

Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

type nonrec ec2_request_failed_exception = {
  1. message : string option;
}

Your user lacks the necessary Amazon EC2 permissions to perform the attempted action.

type nonrec cluster_limit_exceeded_exception = {
  1. message : string option;
}

Job creation failed. Currently, clusters support five nodes. If you have fewer than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five nodes.

type nonrec update_cluster_request = {
  1. forwarding_address_id : string option;
    (*

    The updated ID for the forwarding address for a cluster. This field is not supported in most regions.

    *)
  2. notification : notification option;
    (*

    The new or updated Notification object.

    *)
  3. shipping_option : shipping_option option;
    (*

    The updated shipping option value of this cluster's ShippingDetails object.

    *)
  4. address_id : string option;
    (*

    The ID of the updated Address object.

    *)
  5. on_device_service_configuration : on_device_service_configuration option;
    (*

    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).

    *)
  6. resources : job_resource option;
    (*

    The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

    *)
  7. description : string option;
    (*

    The updated description of this cluster.

    *)
  8. role_ar_n : string option;
    (*

    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).

    *)
  9. cluster_id : string;
    (*

    The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec unsupported_address_exception = {
  1. message : string option;
}

The address is either outside the serviceable area for your region, or an error occurred. Check the address with your region's carrier and try again. If the issue persists, contact Amazon Web Services Support.

type nonrec ind_tax_documents = {
  1. gsti_n : string option;
    (*

    The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.

    *)
}

The tax documents required in Amazon Web Services Region in India.

type nonrec tax_documents = {
  1. in_d : ind_tax_documents option;
}

The tax documents required in your Amazon Web Services Region.

type nonrec snowcone_device_configuration = {
  1. wireless_connection : wireless_connection option;
    (*

    Configures the wireless connection for the Snowcone device.

    *)
}

Specifies the device configuration for an Snowcone job.

type nonrec snowball_type =
  1. | RACK_5U_C
  2. | V3_5S
  3. | V3_5C
  4. | SNC1_SSD
  5. | SNC1_HDD
  6. | EDGE_S
  7. | EDGE_CG
  8. | EDGE_C
  9. | EDGE
  10. | STANDARD
type nonrec shipping_label_status =
  1. | FAILED
  2. | SUCCEEDED
  3. | TIMED_OUT
  4. | IN_PROGRESS
type nonrec shipment = {
  1. tracking_number : string option;
    (*

    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.

    *)
  2. status : string option;
    (*

    Status information for a shipment.

    *)
}

The Status and TrackingNumber information for an inbound or outbound shipment.

type nonrec shipping_details = {
  1. outbound_shipment : shipment option;
    (*

    The Status and TrackingNumber values for a Snow device being delivered to the address that you specified for a particular job.

    *)
  2. inbound_shipment : shipment option;
    (*

    The Status and TrackingNumber values for a Snow device being returned to Amazon Web Services for a particular job.

    *)
  3. shipping_option : shipping_option option;
    (*

    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:

    • 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.
    *)
}

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

type nonrec service_version = {
  1. version : string option;
    (*

    The version number of the requested service.

    *)
}

The version of the requested service.

type nonrec service_name =
  1. | EKS_ANYWHERE
  2. | KUBERNETES
type nonrec return_shipping_label_already_exists_exception = {
  1. message : string option;
}

You get this exception if you call CreateReturnShippingLabel and a valid return shipping label already exists. In this case, use DescribeReturnShippingLabel to get the URL.

type nonrec remote_management =
  1. | NOT_INSTALLED
  2. | INSTALLED_AUTOSTART
  3. | INSTALLED_ONLY
type nonrec long_term_pricing_type =
  1. | ONE_MONTH
  2. | THREE_YEAR
  3. | ONE_YEAR
type nonrec long_term_pricing_list_entry = {
  1. job_ids : string list option;
    (*

    The IDs of the jobs that are associated with a long-term pricing type.

    *)
  2. snowball_type : snowball_type option;
    (*

    The type of Snow Family devices associated with this long-term pricing job.

    *)
  3. long_term_pricing_status : string option;
    (*

    The status of the long-term pricing type.

    *)
  4. is_long_term_pricing_auto_renew : bool option;
    (*

    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.

    *)
  5. replacement_job : string option;
    (*

    A new device that replaces a device that is ordered with long-term pricing.

    *)
  6. current_active_job : string option;
    (*

    The current active jobs on the device the long-term pricing type.

    *)
  7. long_term_pricing_type : long_term_pricing_type option;
    (*

    The type of long-term pricing that was selected for the device.

    *)
  8. long_term_pricing_start_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The start date of the long-term pricing contract.

    *)
  9. long_term_pricing_end_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The end date the long-term pricing contract.

    *)
  10. long_term_pricing_id : string option;
    (*

    The ID of the long-term pricing type for the device.

    *)
}

Each LongTermPricingListEntry object contains information about a long-term pricing type.

type nonrec dependent_service = {
  1. service_version : service_version option;
    (*

    The version of the dependent service.

    *)
  2. service_name : service_name option;
    (*

    The name of the dependent service.

    *)
}

The name and version of the service dependant on the requested service.

type nonrec list_service_versions_result = {
  1. next_token : string option;
    (*

    Because HTTP requests are stateless, this is the starting point of the next list of returned ListServiceVersionsResult results.

    *)
  2. dependent_services : dependent_service list option;
    (*

    A list of names and versions of dependant services of the service for which the system provided supported versions.

    *)
  3. service_name : service_name;
    (*

    The name of the service for which the system provided supported versions.

    *)
  4. service_versions : service_version list;
    (*

    A list of supported versions.

    *)
}
type nonrec list_service_versions_request = {
  1. next_token : string option;
    (*

    Because HTTP requests are stateless, this is the starting point for the next list of returned ListServiceVersionsRequest versions.

    *)
  2. max_results : int option;
    (*

    The maximum number of ListServiceVersions objects to return.

    *)
  3. dependent_services : dependent_service list option;
    (*

    A list of names and versions of dependant services of the requested service.

    *)
  4. service_name : service_name;
    (*

    The name of the service for which you're requesting supported versions.

    *)
}
type nonrec invalid_next_token_exception = {
  1. message : string option;
}

The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

type nonrec address_type =
  1. | AWS_SHIP
  2. | CUST_PICKUP
type nonrec address = {
  1. type_ : address_type option;
    (*

    Differentiates between delivery address and pickup address in the customer account. Provided at job creation.

    *)
  2. is_restricted : bool option;
    (*

    If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

    *)
  3. phone_number : string option;
    (*

    The phone number associated with an address that a Snow device is to be delivered to.

    *)
  4. postal_code : string option;
    (*

    The postal code in an address that a Snow device is to be delivered to.

    *)
  5. country : string option;
    (*

    The country in an address that a Snow device is to be delivered to.

    *)
  6. landmark : string option;
    (*

    This field is no longer used and the value is ignored.

    *)
  7. prefecture_or_district : string option;
    (*

    This field is no longer used and the value is ignored.

    *)
  8. state_or_province : string option;
    (*

    The state or province in an address that a Snow device is to be delivered to.

    *)
  9. city : string option;
    (*

    The city in an address that a Snow device is to be delivered to.

    *)
  10. street3 : string option;
    (*

    The third line in a street address that a Snow device is to be delivered to.

    *)
  11. street2 : string option;
    (*

    The second line in a street address that a Snow device is to be delivered to.

    *)
  12. street1 : string option;
    (*

    The first line in a street address that a Snow device is to be delivered to.

    *)
  13. company : string option;
    (*

    The name of the company to receive a Snow device at an address.

    *)
  14. name : string option;
    (*

    The name of a person to receive a Snow device at an address.

    *)
  15. address_id : string option;
    (*

    The unique ID for an address.

    *)
}

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.

type nonrec list_pickup_locations_result = {
  1. next_token : string option;
    (*

    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.

    *)
  2. addresses : address list option;
    (*

    Information about the address of pickup locations.

    *)
}
type nonrec list_pickup_locations_request = {
  1. next_token : string option;
    (*

    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.

    *)
  2. max_results : int option;
    (*

    The maximum number of locations to list per page.

    *)
}
type nonrec list_long_term_pricing_result = {
  1. next_token : string option;
    (*

    Because HTTP requests are stateless, this is the starting point for your next list of returned ListLongTermPricing list.

    *)
  2. long_term_pricing_entries : long_term_pricing_list_entry list option;
    (*

    Each LongTermPricingEntry object contains a status, ID, and other information about the LongTermPricing type.

    *)
}
type nonrec list_long_term_pricing_request = {
  1. next_token : string option;
    (*

    Because HTTP requests are stateless, this is the starting point for your next list of ListLongTermPricing to return.

    *)
  2. max_results : int option;
    (*

    The maximum number of ListLongTermPricing objects to return.

    *)
}
type nonrec job_type =
  1. | LOCAL_USE
  2. | EXPORT
  3. | IMPORT
type nonrec job_list_entry = {
  1. description : string option;
    (*

    The optional description of this specific job, for example Important Photos 2016-08-11.

    *)
  2. creation_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The creation date for this job.

    *)
  3. snowball_type : snowball_type option;
    (*

    The type of device used with this job.

    *)
  4. job_type : job_type option;
    (*

    The type of job.

    *)
  5. is_master : bool option;
    (*

    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.

    *)
  6. job_state : job_state option;
    (*

    The current state of this job.

    *)
  7. job_id : string option;
    (*

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}

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.

type nonrec list_jobs_result = {
  1. next_token : string option;
    (*

    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.

    *)
  2. job_list_entries : job_list_entry list option;
    (*

    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.

    *)
}
type nonrec list_jobs_request = {
  1. next_token : string option;
    (*

    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.

    *)
  2. max_results : int option;
    (*

    The number of JobListEntry objects to return.

    *)
}
type nonrec compatible_image = {
  1. name : string option;
    (*

    The optional name of a compatible image.

    *)
  2. ami_id : string option;
    (*

    The unique identifier for an individual Snow device AMI.

    *)
}

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.

type nonrec list_compatible_images_result = {
  1. next_token : string option;
    (*

    Because HTTP requests are stateless, this is the starting point for your next list of returned images.

    *)
  2. compatible_images : compatible_image list option;
    (*

    A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snow device AMI.

    *)
}
type nonrec list_compatible_images_request = {
  1. next_token : string option;
    (*

    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.

    *)
  2. max_results : int option;
    (*

    The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.

    *)
}
type nonrec cluster_state =
  1. | CANCELLED
  2. | COMPLETE
  3. | IN_USE
  4. | PENDING
  5. | AWAITING_QUORUM
type nonrec cluster_list_entry = {
  1. description : string option;
    (*

    Defines an optional description of the cluster, for example Environmental Data Cluster-01.

    *)
  2. creation_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The creation date for this cluster.

    *)
  3. cluster_state : cluster_state option;
    (*

    The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.

    *)
  4. cluster_id : string option;
    (*

    The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.

    *)
}

Contains a cluster's state, a cluster's ID, and other important information.

type nonrec list_clusters_result = {
  1. next_token : string option;
    (*

    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.

    *)
  2. cluster_list_entries : cluster_list_entry list option;
    (*

    Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

    *)
}
type nonrec list_clusters_request = {
  1. next_token : string option;
    (*

    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.

    *)
  2. max_results : int option;
    (*

    The number of ClusterListEntry objects to return.

    *)
}
type nonrec list_cluster_jobs_result = {
  1. next_token : string option;
    (*

    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.

    *)
  2. job_list_entries : job_list_entry list option;
    (*

    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.

    *)
}
type nonrec list_cluster_jobs_request = {
  1. next_token : string option;
    (*

    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.

    *)
  2. max_results : int option;
    (*

    The number of JobListEntry objects to return.

    *)
  3. cluster_id : string;
    (*

    The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec data_transfer = {
  1. total_objects : int option;
    (*

    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.

    *)
  2. total_bytes : int option;
    (*

    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.

    *)
  3. objects_transferred : int option;
    (*

    The number of objects transferred between a Snow device and Amazon S3.

    *)
  4. bytes_transferred : int option;
    (*

    The number of bytes transferred between a Snow device and Amazon S3.

    *)
}

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.

type nonrec job_logs = {
  1. job_failure_log_ur_i : string option;
    (*

    A link to an Amazon S3 presigned URL where the job failure log is located.

    *)
  2. job_success_log_ur_i : string option;
    (*

    A link to an Amazon S3 presigned URL where the job success log is located.

    *)
  3. job_completion_report_ur_i : string option;
    (*

    A link to an Amazon S3 presigned URL where the job completion report is located.

    *)
}

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.

type nonrec device_configuration = {
  1. snowcone_device_configuration : snowcone_device_configuration option;
    (*

    Returns information about the device configuration for an Snowcone job.

    *)
}

The container for SnowconeDeviceConfiguration.

type nonrec impact_level =
  1. | IL99
  2. | IL6
  3. | IL5
  4. | IL4
  5. | IL2
type nonrec job_metadata = {
  1. snowball_id : string option;
    (*

    Unique ID associated with a device.

    *)
  2. pickup_details : pickup_details option;
    (*

    Information identifying the person picking up the device.

    *)
  3. impact_level : impact_level option;
    (*

    The highest impact level of data that will be stored or processed on the device, provided at job creation.

    *)
  4. on_device_service_configuration : on_device_service_configuration option;
    (*

    Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

    *)
  5. long_term_pricing_id : string option;
    (*

    The ID of the long-term pricing type for the device.

    *)
  6. remote_management : remote_management option;
    (*

    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.

    *)
  7. device_configuration : device_configuration option;
  8. tax_documents : tax_documents option;
    (*

    The metadata associated with the tax documents required in your Amazon Web Services Region.

    *)
  9. forwarding_address_id : string option;
    (*

    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.

    *)
  10. cluster_id : string option;
    (*

    The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

    *)
  11. job_log_info : job_logs option;
    (*

    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.

    *)
  12. data_transfer_progress : data_transfer option;
    (*

    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.

    *)
  13. notification : notification option;
    (*

    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.

    *)
  14. snowball_capacity_preference : snowball_capacity option;
    (*

    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.

    *)
  15. shipping_details : shipping_details option;
    (*

    A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

    *)
  16. address_id : string option;
    (*

    The ID for the address that you want the Snow device shipped to.

    *)
  17. role_ar_n : string option;
    (*

    The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.

    *)
  18. kms_key_ar_n : string option;
    (*

    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.

    *)
  19. description : string option;
    (*

    The description of the job, provided at job creation.

    *)
  20. resources : job_resource option;
    (*

    An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

    *)
  21. creation_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The creation date for this job.

    *)
  22. snowball_type : snowball_type option;
    (*

    The type of device used with this job.

    *)
  23. job_type : job_type option;
    (*

    The type of job.

    *)
  24. job_state : job_state option;
    (*

    The current status of the jobs.

    *)
  25. job_id : string option;
    (*

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}

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.

type nonrec invalid_address_exception = {
  1. message : string option;
}

The address provided was invalid. Check the address with your region's carrier, and try again.

type nonrec get_software_updates_result = {
  1. updates_ur_i : string option;
    (*

    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.

    *)
}
type nonrec get_software_updates_request = {
  1. job_id : string;
    (*

    The ID for a job that you want to get the software update file for, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec get_snowball_usage_result = {
  1. snowballs_in_use : int option;
    (*

    The number of Snow devices that this account is currently using.

    *)
  2. snowball_limit : int option;
    (*

    The service limit for number of Snow devices this account can have at once. The default service limit is 1 (one).

    *)
}
type nonrec get_job_unlock_code_result = {
  1. unlock_code : string option;
    (*

    The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 360 days after the job has been created.

    *)
}
type nonrec get_job_unlock_code_request = {
  1. job_id : string;
    (*

    The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec get_job_manifest_result = {
  1. manifest_ur_i : string option;
    (*

    The Amazon S3 presigned URL for the manifest file associated with the specified JobId value.

    *)
}
type nonrec get_job_manifest_request = {
  1. job_id : string;
    (*

    The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec describe_return_shipping_label_result = {
  1. return_shipping_label_ur_i : string option;
    (*

    The pre-signed Amazon S3 URI used to download the return shipping label.

    *)
  2. expiration_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The expiration date of the current return shipping label.

    *)
  3. status : shipping_label_status option;
    (*

    The status information of the task on a Snow device that is being returned to Amazon Web Services.

    *)
}
type nonrec describe_return_shipping_label_request = {
  1. job_id : string;
    (*

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec conflict_exception = {
  1. message : string option;
  2. conflict_resource : string option;
    (*

    You get this resource when you call CreateReturnShippingLabel more than once when other requests are not completed. .

    *)
}

You get this exception when you call CreateReturnShippingLabel more than once when other requests are not completed.

type nonrec describe_job_result = {
  1. sub_job_metadata : job_metadata list option;
    (*

    Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.

    *)
  2. job_metadata : job_metadata option;
    (*

    Information about a specific job, including shipping information, job status, and other important metadata.

    *)
}
type nonrec describe_job_request = {
  1. job_id : string;
    (*

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec cluster_metadata = {
  1. on_device_service_configuration : on_device_service_configuration option;
    (*

    Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

    *)
  2. tax_documents : tax_documents option;
    (*

    The tax documents required in your Amazon Web Services Region.

    *)
  3. forwarding_address_id : string option;
    (*

    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.

    *)
  4. notification : notification option;
    (*

    The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

    *)
  5. shipping_option : shipping_option option;
    (*

    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.
    *)
  6. address_id : string option;
    (*

    The automatically generated ID for a specific address.

    *)
  7. resources : job_resource option;
    (*

    The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

    *)
  8. creation_date : Smaws_Lib.CoreTypes.Timestamp.t option;
    (*

    The creation date for this cluster.

    *)
  9. snowball_type : snowball_type option;
    (*

    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.

    *)
  10. job_type : job_type option;
    (*

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

    *)
  11. cluster_state : cluster_state option;
    (*

    The current status of the cluster.

    *)
  12. role_ar_n : string option;
    (*

    The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).

    *)
  13. kms_key_ar_n : string option;
    (*

    The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in Key Management Service (KMS.

    *)
  14. description : string option;
    (*

    The optional description of the cluster.

    *)
  15. cluster_id : string option;
    (*

    The automatically generated ID for a cluster.

    *)
}

Contains metadata about a specific cluster.

type nonrec describe_cluster_result = {
  1. cluster_metadata : cluster_metadata option;
    (*

    Information about a specific cluster, including shipping information, cluster status, and other important metadata.

    *)
}
type nonrec describe_cluster_request = {
  1. cluster_id : string;
    (*

    The automatically generated ID for a cluster.

    *)
}
type nonrec describe_addresses_result = {
  1. next_token : string option;
    (*

    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.

    *)
  2. addresses : address list option;
    (*

    The Snow device shipping addresses that were created for this account.

    *)
}
type nonrec describe_addresses_request = {
  1. next_token : string option;
    (*

    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.

    *)
  2. max_results : int option;
    (*

    The number of ADDRESS objects to return.

    *)
}
type nonrec describe_address_result = {
  1. address : address option;
    (*

    The address that you want the Snow device(s) associated with a specific job to be shipped to.

    *)
}
type nonrec describe_address_request = {
  1. address_id : string;
    (*

    The automatically generated ID for a specific address.

    *)
}
type nonrec create_return_shipping_label_result = {
  1. status : shipping_label_status option;
    (*

    The status information of the task on a Snow device that is being returned to Amazon Web Services.

    *)
}
type nonrec create_return_shipping_label_request = {
  1. shipping_option : shipping_option option;
    (*

    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:

    *)
  2. job_id : string;
    (*

    The ID for a job that you want to create the return shipping label for; for example, JID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec create_long_term_pricing_result = {
  1. long_term_pricing_id : string option;
    (*

    The ID of the long-term pricing type for the device.

    *)
}
type nonrec create_long_term_pricing_request = {
  1. snowball_type : snowball_type;
    (*

    The type of Snow Family devices to use for the long-term pricing job.

    *)
  2. is_long_term_pricing_auto_renew : bool option;
    (*

    Specifies whether the current long-term pricing type for the device should be renewed.

    *)
  3. long_term_pricing_type : long_term_pricing_type;
    (*

    The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing.

    *)
}
type nonrec create_job_result = {
  1. job_id : string option;
    (*

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec create_job_request = {
  1. pickup_details : pickup_details option;
    (*

    Information identifying the person picking up the device.

    *)
  2. impact_level : impact_level option;
    (*

    The highest impact level of data that will be stored or processed on the device, provided at job creation.

    *)
  3. long_term_pricing_id : string option;
    (*

    The ID of the long-term pricing type for the device.

    *)
  4. remote_management : remote_management option;
    (*

    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.

    *)
  5. device_configuration : device_configuration option;
    (*

    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.

    *)
  6. tax_documents : tax_documents option;
    (*

    The tax documents required in your Amazon Web Services Region.

    *)
  7. forwarding_address_id : string option;
    (*

    The forwarding address ID for a job. This field is not supported in most Regions.

    *)
  8. snowball_type : snowball_type option;
    (*

    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.

    *)
  9. cluster_id : string option;
    (*

    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.

    *)
  10. notification : notification option;
    (*

    Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

    *)
  11. shipping_option : shipping_option option;
    (*

    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.
    *)
  12. snowball_capacity_preference : snowball_capacity option;
    (*

    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.

    *)
  13. role_ar_n : string option;
    (*

    The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole Identity and Access Management (IAM) API action.

    *)
  14. kms_key_ar_n : string option;
    (*

    The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey Key Management Service (KMS) API action.

    *)
  15. address_id : string option;
    (*

    The ID for the address that you want the Snow device shipped to.

    *)
  16. description : string option;
    (*

    Defines an optional description of this specific job, for example Important Photos 2016-08-11.

    *)
  17. on_device_service_configuration : on_device_service_configuration option;
    (*

    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.

    *)
  18. resources : job_resource option;
    (*

    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.

    *)
  19. job_type : job_type option;
    (*

    Defines the type of job that you're creating.

    *)
}
type nonrec create_cluster_result = {
  1. job_list_entries : job_list_entry list option;
    (*

    List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries in this guide.

    *)
  2. cluster_id : string option;
    (*

    The automatically generated ID for a cluster.

    *)
}
type nonrec create_cluster_request = {
  1. snowball_capacity_preference : snowball_capacity option;
    (*

    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.

    *)
  2. long_term_pricing_ids : string list option;
    (*

    Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.

    *)
  3. force_create_jobs : bool option;
    (*

    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.

    *)
  4. initial_cluster_size : int option;
    (*

    If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.

    *)
  5. remote_management : remote_management option;
    (*

    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.

    *)
  6. tax_documents : tax_documents option;
    (*

    The tax documents required in your Amazon Web Services Region.

    *)
  7. forwarding_address_id : string option;
    (*

    The forwarding address ID for a cluster. This field is not supported in most regions.

    *)
  8. notification : notification option;
    (*

    The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

    *)
  9. shipping_option : shipping_option;
    (*

    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.
    *)
  10. snowball_type : snowball_type;
    (*

    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.

    *)
  11. role_ar_n : string option;
    (*

    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).

    *)
  12. kms_key_ar_n : string option;
    (*

    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).

    *)
  13. address_id : string;
    (*

    The ID for the address that you want the cluster shipped to.

    *)
  14. description : string option;
    (*

    An optional description of this specific cluster, for example Environmental Data Cluster-01.

    *)
  15. on_device_service_configuration : on_device_service_configuration option;
    (*

    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).

    *)
  16. resources : job_resource option;
    (*

    The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.

    *)
  17. job_type : job_type;
    (*

    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.

    *)
}
type nonrec create_address_result = {
  1. address_id : string option;
    (*

    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.

    *)
}
type nonrec create_address_request = {
  1. address : address;
    (*

    The address that you want the Snow device shipped to.

    *)
}
type nonrec cancel_job_request = {
  1. job_id : string;
    (*

    The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.

    *)
}
type nonrec cancel_cluster_request = {
  1. cluster_id : string;
    (*

    The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000.

    *)
}

Builders

val make_wireless_connection : ?is_wifi_enabled:bool -> unit -> wireless_connection
val make_update_long_term_pricing_request : ?is_long_term_pricing_auto_renew:bool -> ?replacement_job:string -> long_term_pricing_id:string -> unit -> update_long_term_pricing_request
val make_update_job_shipment_state_request : shipment_state:shipment_state -> job_id:string -> unit -> update_job_shipment_state_request
val make_notification : ?device_pickup_sns_topic_ar_n:string -> ?notify_all:bool -> ?job_states_to_notify:job_state list -> ?sns_topic_ar_n:string -> unit -> notification
val make_key_range : ?end_marker:string -> ?begin_marker:string -> unit -> key_range
val make_target_on_device_service : ?transfer_option:transfer_option -> ?service_name:device_service_name -> unit -> target_on_device_service
val make_s3_resource : ?target_on_device_services:target_on_device_service list -> ?key_range:key_range -> ?bucket_arn:string -> unit -> s3_resource
val make_event_trigger_definition : ?event_resource_ar_n:string -> unit -> event_trigger_definition
val make_lambda_resource : ?event_triggers:event_trigger_definition list -> ?lambda_arn:string -> unit -> lambda_resource
val make_ec2_ami_resource : ?snowball_ami_id:string -> ami_id:string -> unit -> ec2_ami_resource
val make_job_resource : ?ec2_ami_resources:ec2_ami_resource list -> ?lambda_resources:lambda_resource list -> ?s3_resources:s3_resource list -> unit -> job_resource
val make_nfs_on_device_service_configuration : ?storage_unit:storage_unit -> ?storage_limit:int -> unit -> nfs_on_device_service_configuration
val make_tgw_on_device_service_configuration : ?storage_unit:storage_unit -> ?storage_limit:int -> unit -> tgw_on_device_service_configuration
val make_eks_on_device_service_configuration : ?eks_anywhere_version:string -> ?kubernetes_version:string -> unit -> eks_on_device_service_configuration
val make_s3_on_device_service_configuration : ?fault_tolerance:int -> ?service_size:int -> ?storage_unit:storage_unit -> ?storage_limit:float -> unit -> s3_on_device_service_configuration
val make_on_device_service_configuration : ?s3_on_device_service:s3_on_device_service_configuration -> ?eks_on_device_service:eks_on_device_service_configuration -> ?tgw_on_device_service:tgw_on_device_service_configuration -> ?nfs_on_device_service:nfs_on_device_service_configuration -> unit -> on_device_service_configuration
val make_pickup_details : ?device_pickup_id:string -> ?identification_issuing_org:string -> ?identification_expiration_date:Smaws_Lib.CoreTypes.Timestamp.t -> ?identification_number:string -> ?email:string -> ?phone_number:string -> ?name:string -> unit -> pickup_details
val make_update_job_request : ?pickup_details:pickup_details -> ?forwarding_address_id:string -> ?snowball_capacity_preference:snowball_capacity -> ?description:string -> ?shipping_option:shipping_option -> ?address_id:string -> ?on_device_service_configuration:on_device_service_configuration -> ?resources:job_resource -> ?notification:notification -> ?role_ar_n:string -> job_id:string -> unit -> update_job_request
val make_update_cluster_request : ?forwarding_address_id:string -> ?notification:notification -> ?shipping_option:shipping_option -> ?address_id:string -> ?on_device_service_configuration:on_device_service_configuration -> ?resources:job_resource -> ?description:string -> ?role_ar_n:string -> cluster_id:string -> unit -> update_cluster_request
val make_ind_tax_documents : ?gsti_n:string -> unit -> ind_tax_documents
val make_tax_documents : ?in_d:ind_tax_documents -> unit -> tax_documents
val make_snowcone_device_configuration : ?wireless_connection:wireless_connection -> unit -> snowcone_device_configuration
val make_shipment : ?tracking_number:string -> ?status:string -> unit -> shipment
val make_shipping_details : ?outbound_shipment:shipment -> ?inbound_shipment:shipment -> ?shipping_option:shipping_option -> unit -> shipping_details
val make_service_version : ?version:string -> unit -> service_version
val make_long_term_pricing_list_entry : ?job_ids:string list -> ?snowball_type:snowball_type -> ?long_term_pricing_status:string -> ?is_long_term_pricing_auto_renew:bool -> ?replacement_job:string -> ?current_active_job:string -> ?long_term_pricing_type:long_term_pricing_type -> ?long_term_pricing_start_date:Smaws_Lib.CoreTypes.Timestamp.t -> ?long_term_pricing_end_date:Smaws_Lib.CoreTypes.Timestamp.t -> ?long_term_pricing_id:string -> unit -> long_term_pricing_list_entry
val make_dependent_service : ?service_version:service_version -> ?service_name:service_name -> unit -> dependent_service
val make_list_service_versions_request : ?next_token:string -> ?max_results:int -> ?dependent_services:dependent_service list -> service_name:service_name -> unit -> list_service_versions_request
val make_address : ?type_:address_type -> ?is_restricted:bool -> ?phone_number:string -> ?postal_code:string -> ?country:string -> ?landmark:string -> ?prefecture_or_district:string -> ?state_or_province:string -> ?city:string -> ?street3:string -> ?street2:string -> ?street1:string -> ?company:string -> ?name:string -> ?address_id:string -> unit -> address
val make_list_pickup_locations_request : ?next_token:string -> ?max_results:int -> unit -> list_pickup_locations_request
val make_list_long_term_pricing_request : ?next_token:string -> ?max_results:int -> unit -> list_long_term_pricing_request
val make_job_list_entry : ?description:string -> ?creation_date:Smaws_Lib.CoreTypes.Timestamp.t -> ?snowball_type:snowball_type -> ?job_type:job_type -> ?is_master:bool -> ?job_state:job_state -> ?job_id:string -> unit -> job_list_entry
val make_list_jobs_request : ?next_token:string -> ?max_results:int -> unit -> list_jobs_request
val make_compatible_image : ?name:string -> ?ami_id:string -> unit -> compatible_image
val make_list_compatible_images_request : ?next_token:string -> ?max_results:int -> unit -> list_compatible_images_request
val make_cluster_list_entry : ?description:string -> ?creation_date:Smaws_Lib.CoreTypes.Timestamp.t -> ?cluster_state:cluster_state -> ?cluster_id:string -> unit -> cluster_list_entry
val make_list_clusters_request : ?next_token:string -> ?max_results:int -> unit -> list_clusters_request
val make_list_cluster_jobs_request : ?next_token:string -> ?max_results:int -> cluster_id:string -> unit -> list_cluster_jobs_request
val make_data_transfer : ?total_objects:int -> ?total_bytes:int -> ?objects_transferred:int -> ?bytes_transferred:int -> unit -> data_transfer
val make_job_logs : ?job_failure_log_ur_i:string -> ?job_success_log_ur_i:string -> ?job_completion_report_ur_i:string -> unit -> job_logs
val make_device_configuration : ?snowcone_device_configuration:snowcone_device_configuration -> unit -> device_configuration
val make_job_metadata : ?snowball_id:string -> ?pickup_details:pickup_details -> ?impact_level:impact_level -> ?on_device_service_configuration:on_device_service_configuration -> ?long_term_pricing_id:string -> ?remote_management:remote_management -> ?device_configuration:device_configuration -> ?tax_documents:tax_documents -> ?forwarding_address_id:string -> ?cluster_id:string -> ?job_log_info:job_logs -> ?data_transfer_progress:data_transfer -> ?notification:notification -> ?snowball_capacity_preference:snowball_capacity -> ?shipping_details:shipping_details -> ?address_id:string -> ?role_ar_n:string -> ?kms_key_ar_n:string -> ?description:string -> ?resources:job_resource -> ?creation_date:Smaws_Lib.CoreTypes.Timestamp.t -> ?snowball_type:snowball_type -> ?job_type:job_type -> ?job_state:job_state -> ?job_id:string -> unit -> job_metadata
val make_get_software_updates_request : job_id:string -> unit -> get_software_updates_request
val make_get_snowball_usage_request : unit -> unit
val make_get_job_unlock_code_request : job_id:string -> unit -> get_job_unlock_code_request
val make_get_job_manifest_request : job_id:string -> unit -> get_job_manifest_request
val make_describe_return_shipping_label_request : job_id:string -> unit -> describe_return_shipping_label_request
val make_describe_job_request : job_id:string -> unit -> describe_job_request
val make_cluster_metadata : ?on_device_service_configuration:on_device_service_configuration -> ?tax_documents:tax_documents -> ?forwarding_address_id:string -> ?notification:notification -> ?shipping_option:shipping_option -> ?address_id:string -> ?resources:job_resource -> ?creation_date:Smaws_Lib.CoreTypes.Timestamp.t -> ?snowball_type:snowball_type -> ?job_type:job_type -> ?cluster_state:cluster_state -> ?role_ar_n:string -> ?kms_key_ar_n:string -> ?description:string -> ?cluster_id:string -> unit -> cluster_metadata
val make_describe_cluster_request : cluster_id:string -> unit -> describe_cluster_request
val make_describe_addresses_request : ?next_token:string -> ?max_results:int -> unit -> describe_addresses_request
val make_describe_address_request : address_id:string -> unit -> describe_address_request
val make_create_return_shipping_label_request : ?shipping_option:shipping_option -> job_id:string -> unit -> create_return_shipping_label_request
val make_create_long_term_pricing_request : ?is_long_term_pricing_auto_renew:bool -> snowball_type:snowball_type -> long_term_pricing_type:long_term_pricing_type -> unit -> create_long_term_pricing_request
val make_create_job_request : ?pickup_details:pickup_details -> ?impact_level:impact_level -> ?long_term_pricing_id:string -> ?remote_management:remote_management -> ?device_configuration:device_configuration -> ?tax_documents:tax_documents -> ?forwarding_address_id:string -> ?snowball_type:snowball_type -> ?cluster_id:string -> ?notification:notification -> ?shipping_option:shipping_option -> ?snowball_capacity_preference:snowball_capacity -> ?role_ar_n:string -> ?kms_key_ar_n:string -> ?address_id:string -> ?description:string -> ?on_device_service_configuration:on_device_service_configuration -> ?resources:job_resource -> ?job_type:job_type -> unit -> create_job_request
val make_create_cluster_request : ?snowball_capacity_preference:snowball_capacity -> ?long_term_pricing_ids:string list -> ?force_create_jobs:bool -> ?initial_cluster_size:int -> ?remote_management:remote_management -> ?tax_documents:tax_documents -> ?forwarding_address_id:string -> ?notification:notification -> ?role_ar_n:string -> ?kms_key_ar_n:string -> ?description:string -> ?on_device_service_configuration:on_device_service_configuration -> ?resources:job_resource -> shipping_option:shipping_option -> snowball_type:snowball_type -> address_id:string -> job_type:job_type -> unit -> create_cluster_request
val make_create_address_request : address:address -> unit -> create_address_request
val make_cancel_job_request : job_id:string -> unit -> cancel_job_request
val make_cancel_cluster_request : cluster_id:string -> unit -> cancel_cluster_request

Operations

module CancelCluster : sig ... end

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.

module CancelJob : sig ... end

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.

module CreateAddress : sig ... end

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. If providing an address as a JSON file through the cli-input-json option, include the full file path. For example, --cli-input-json file://create-address.json.

module CreateCluster : sig ... end

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.

module CreateJob : sig ... end

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.

module CreateLongTermPricing : sig ... end

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.

module CreateReturnShippingLabel : sig ... end

Creates a shipping label that will be used to return the Snow device to Amazon Web Services.

module DescribeAddress : sig ... end

Takes an AddressId and returns specific details about that address in the form of an Address object.

module DescribeAddresses : sig ... end

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.

module DescribeCluster : sig ... end

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

module DescribeJob : sig ... end

Returns information about a specific job including shipping information, job status, and other important metadata.

module DescribeReturnShippingLabel : sig ... end

Information on the shipping label of a Snow device that is being returned to Amazon Web Services.

module GetJobManifest : sig ... end

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.

module GetJobUnlockCode : sig ... end

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.

module GetSnowballUsage : sig ... end

Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use.

module GetSoftwareUpdates : sig ... end

Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.

module ListClusterJobs : sig ... end

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.

module ListClusters : sig ... end

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.

module ListCompatibleImages : sig ... end

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.

module ListJobs : sig ... end

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.

module ListLongTermPricing : sig ... end

Lists all long-term pricing types.

module ListPickupLocations : sig ... end

A list of locations from which the customer can choose to pickup a device.

module ListServiceVersions : sig ... end

Lists all supported versions for Snow on-device services. Returns an array of ServiceVersion object containing the supported versions for a particular service.

module UpdateCluster : sig ... end

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.

module UpdateJob : sig ... end

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.

module UpdateJobShipmentState : sig ... end

Updates the state when a shipment state changes to a different state.

module UpdateLongTermPricing : sig ... end

Updates the long-term pricing type.