Smaws_Client_Snowball (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_wireless_connection : 
  ?is_wifi_enabled:Types.boolean_ ->
  unit ->
  Types.wireless_connection

val make_update_long_term_pricing_request : 
  ?is_long_term_pricing_auto_renew:Types.java_boolean ->
  ?replacement_job:Types.job_id ->
  long_term_pricing_id:Types.long_term_pricing_id ->
  unit ->
  Types.update_long_term_pricing_request

val make_update_job_shipment_state_request : 
  shipment_state:Types.shipment_state ->
  job_id:Types.job_id ->
  unit ->
  Types.update_job_shipment_state_request

val make_notification : 
  ?device_pickup_sns_topic_ar_n:Types.sns_topic_ar_n ->
  ?notify_all:Types.boolean_ ->
  ?job_states_to_notify:Types.job_state_list ->
  ?sns_topic_ar_n:Types.sns_topic_ar_n ->
  unit ->
  Types.notification

val make_key_range : 
  ?end_marker:Types.string_ ->
  ?begin_marker:Types.string_ ->
  unit ->
  Types.key_range

val make_target_on_device_service : 
  ?transfer_option:Types.transfer_option ->
  ?service_name:Types.device_service_name ->
  unit ->
  Types.target_on_device_service

val make_s3_resource : 
  ?target_on_device_services:Types.target_on_device_service_list ->
  ?key_range:Types.key_range ->
  ?bucket_arn:Types.resource_ar_n ->
  unit ->
  Types.s3_resource

val make_event_trigger_definition : 
  ?event_resource_ar_n:Types.resource_ar_n ->
  unit ->
  Types.event_trigger_definition

val make_lambda_resource : 
  ?event_triggers:Types.event_trigger_definition_list ->
  ?lambda_arn:Types.resource_ar_n ->
  unit ->
  Types.lambda_resource

val make_ec2_ami_resource : 
  ?snowball_ami_id:Types.string_ ->
  ami_id:Types.ami_id ->
  unit ->
  Types.ec2_ami_resource

val make_job_resource : 
  ?ec2_ami_resources:Types.ec2_ami_resource_list ->
  ?lambda_resources:Types.lambda_resource_list ->
  ?s3_resources:Types.s3_resource_list ->
  unit ->
  Types.job_resource

val make_nfs_on_device_service_configuration : 
  ?storage_unit:Types.storage_unit ->
  ?storage_limit:Types.storage_limit ->
  unit ->
  Types.nfs_on_device_service_configuration

val make_tgw_on_device_service_configuration : 
  ?storage_unit:Types.storage_unit ->
  ?storage_limit:Types.storage_limit ->
  unit ->
  Types.tgw_on_device_service_configuration

val make_eks_on_device_service_configuration : 
  ?eks_anywhere_version:Types.string_ ->
  ?kubernetes_version:Types.string_ ->
  unit ->
  Types.eks_on_device_service_configuration

val make_s3_on_device_service_configuration : 
  ?fault_tolerance:Types.node_fault_tolerance ->
  ?service_size:Types.service_size ->
  ?storage_unit:Types.storage_unit ->
  ?storage_limit:Types.s3_storage_limit ->
  unit ->
  Types.s3_on_device_service_configuration

val make_on_device_service_configuration : 
  ?s3_on_device_service:Types.s3_on_device_service_configuration ->
  ?eks_on_device_service:Types.eks_on_device_service_configuration ->
  ?tgw_on_device_service:Types.tgw_on_device_service_configuration ->
  ?nfs_on_device_service:Types.nfs_on_device_service_configuration ->
  unit ->
  Types.on_device_service_configuration

val make_pickup_details : 
  ?device_pickup_id:Types.device_pickup_id ->
  ?identification_issuing_org:Types.string_ ->
  ?identification_expiration_date:Types.timestamp ->
  ?identification_number:Types.string_ ->
  ?email:Types.email ->
  ?phone_number:Types.phone_number ->
  ?name:Types.string_ ->
  unit ->
  Types.pickup_details

val make_update_job_request : 
  ?pickup_details:Types.pickup_details ->
  ?forwarding_address_id:Types.address_id ->
  ?snowball_capacity_preference:Types.snowball_capacity ->
  ?description:Types.string_ ->
  ?shipping_option:Types.shipping_option ->
  ?address_id:Types.address_id ->
  ?on_device_service_configuration:Types.on_device_service_configuration ->
  ?resources:Types.job_resource ->
  ?notification:Types.notification ->
  ?role_ar_n:Types.role_ar_n ->
  job_id:Types.job_id ->
  unit ->
  Types.update_job_request

val make_update_cluster_request : 
  ?forwarding_address_id:Types.address_id ->
  ?notification:Types.notification ->
  ?shipping_option:Types.shipping_option ->
  ?address_id:Types.address_id ->
  ?on_device_service_configuration:Types.on_device_service_configuration ->
  ?resources:Types.job_resource ->
  ?description:Types.string_ ->
  ?role_ar_n:Types.role_ar_n ->
  cluster_id:Types.cluster_id ->
  unit ->
  Types.update_cluster_request

val make_ind_tax_documents : 
  ?gsti_n:Types.gsti_n ->
  unit ->
  Types.ind_tax_documents

val make_tax_documents : 
  ?in_d:Types.ind_tax_documents ->
  unit ->
  Types.tax_documents

val make_snowcone_device_configuration : 
  ?wireless_connection:Types.wireless_connection ->
  unit ->
  Types.snowcone_device_configuration

val make_shipment : 
  ?tracking_number:Types.string_ ->
  ?status:Types.string_ ->
  unit ->
  Types.shipment

val make_shipping_details : 
  ?outbound_shipment:Types.shipment ->
  ?inbound_shipment:Types.shipment ->
  ?shipping_option:Types.shipping_option ->
  unit ->
  Types.shipping_details

val make_service_version : 
  ?version:Types.string_ ->
  unit ->
  Types.service_version

val make_long_term_pricing_list_entry : 
  ?job_ids:Types.long_term_pricing_associated_job_id_list ->
  ?snowball_type:Types.snowball_type ->
  ?long_term_pricing_status:Types.string_ ->
  ?is_long_term_pricing_auto_renew:Types.java_boolean ->
  ?replacement_job:Types.job_id ->
  ?current_active_job:Types.job_id ->
  ?long_term_pricing_type:Types.long_term_pricing_type ->
  ?long_term_pricing_start_date:Types.timestamp ->
  ?long_term_pricing_end_date:Types.timestamp ->
  ?long_term_pricing_id:Types.long_term_pricing_id ->
  unit ->
  Types.long_term_pricing_list_entry

val make_dependent_service : 
  ?service_version:Types.service_version ->
  ?service_name:Types.service_name ->
  unit ->
  Types.dependent_service

val make_list_service_versions_request : 
  ?next_token:Types.string_ ->
  ?max_results:Types.list_limit ->
  ?dependent_services:Types.dependent_service_list ->
  service_name:Types.service_name ->
  unit ->
  Types.list_service_versions_request

val make_address : 
  ?type_:Types.address_type ->
  ?is_restricted:Types.boolean_ ->
  ?phone_number:Types.string_ ->
  ?postal_code:Types.string_ ->
  ?country:Types.string_ ->
  ?landmark:Types.string_ ->
  ?prefecture_or_district:Types.string_ ->
  ?state_or_province:Types.string_ ->
  ?city:Types.string_ ->
  ?street3:Types.string_ ->
  ?street2:Types.string_ ->
  ?street1:Types.string_ ->
  ?company:Types.string_ ->
  ?name:Types.string_ ->
  ?address_id:Types.address_id ->
  unit ->
  Types.address

val make_list_pickup_locations_request : 
  ?next_token:Types.string_ ->
  ?max_results:Types.list_limit ->
  unit ->
  Types.list_pickup_locations_request

val make_list_long_term_pricing_request : 
  ?next_token:Types.string_ ->
  ?max_results:Types.list_limit ->
  unit ->
  Types.list_long_term_pricing_request

val make_job_list_entry : 
  ?description:Types.string_ ->
  ?creation_date:Types.timestamp ->
  ?snowball_type:Types.snowball_type ->
  ?job_type:Types.job_type ->
  ?is_master:Types.boolean_ ->
  ?job_state:Types.job_state ->
  ?job_id:Types.string_ ->
  unit ->
  Types.job_list_entry

val make_list_jobs_request : 
  ?next_token:Types.string_ ->
  ?max_results:Types.list_limit ->
  unit ->
  Types.list_jobs_request

val make_compatible_image : 
  ?name:Types.string_ ->
  ?ami_id:Types.string_ ->
  unit ->
  Types.compatible_image

val make_list_compatible_images_request : 
  ?next_token:Types.string_ ->
  ?max_results:Types.list_limit ->
  unit ->
  Types.list_compatible_images_request

val make_cluster_list_entry : 
  ?description:Types.string_ ->
  ?creation_date:Types.timestamp ->
  ?cluster_state:Types.cluster_state ->
  ?cluster_id:Types.string_ ->
  unit ->
  Types.cluster_list_entry

val make_list_clusters_request : 
  ?next_token:Types.string_ ->
  ?max_results:Types.list_limit ->
  unit ->
  Types.list_clusters_request

val make_list_cluster_jobs_request : 
  ?next_token:Types.string_ ->
  ?max_results:Types.list_limit ->
  cluster_id:Types.cluster_id ->
  unit ->
  Types.list_cluster_jobs_request

val make_data_transfer : 
  ?total_objects:Types.long ->
  ?total_bytes:Types.long ->
  ?objects_transferred:Types.long ->
  ?bytes_transferred:Types.long ->
  unit ->
  Types.data_transfer

val make_job_logs : 
  ?job_failure_log_ur_i:Types.string_ ->
  ?job_success_log_ur_i:Types.string_ ->
  ?job_completion_report_ur_i:Types.string_ ->
  unit ->
  Types.job_logs

val make_device_configuration : 
  ?snowcone_device_configuration:Types.snowcone_device_configuration ->
  unit ->
  Types.device_configuration

val make_job_metadata : 
  ?snowball_id:Types.string_ ->
  ?pickup_details:Types.pickup_details ->
  ?impact_level:Types.impact_level ->
  ?on_device_service_configuration:Types.on_device_service_configuration ->
  ?long_term_pricing_id:Types.long_term_pricing_id ->
  ?remote_management:Types.remote_management ->
  ?device_configuration:Types.device_configuration ->
  ?tax_documents:Types.tax_documents ->
  ?forwarding_address_id:Types.address_id ->
  ?cluster_id:Types.string_ ->
  ?job_log_info:Types.job_logs ->
  ?data_transfer_progress:Types.data_transfer ->
  ?notification:Types.notification ->
  ?snowball_capacity_preference:Types.snowball_capacity ->
  ?shipping_details:Types.shipping_details ->
  ?address_id:Types.address_id ->
  ?role_ar_n:Types.role_ar_n ->
  ?kms_key_ar_n:Types.kms_key_ar_n ->
  ?description:Types.string_ ->
  ?resources:Types.job_resource ->
  ?creation_date:Types.timestamp ->
  ?snowball_type:Types.snowball_type ->
  ?job_type:Types.job_type ->
  ?job_state:Types.job_state ->
  ?job_id:Types.string_ ->
  unit ->
  Types.job_metadata

val make_get_software_updates_request : 
  job_id:Types.job_id ->
  unit ->
  Types.get_software_updates_request

val make_get_snowball_usage_request : unit -> unit

val make_get_job_unlock_code_request : 
  job_id:Types.job_id ->
  unit ->
  Types.get_job_unlock_code_request

val make_get_job_manifest_request : 
  job_id:Types.job_id ->
  unit ->
  Types.get_job_manifest_request

val make_describe_return_shipping_label_request : 
  job_id:Types.job_id ->
  unit ->
  Types.describe_return_shipping_label_request

val make_describe_job_request : 
  job_id:Types.job_id ->
  unit ->
  Types.describe_job_request

val make_cluster_metadata : 
  ?on_device_service_configuration:Types.on_device_service_configuration ->
  ?tax_documents:Types.tax_documents ->
  ?forwarding_address_id:Types.address_id ->
  ?notification:Types.notification ->
  ?shipping_option:Types.shipping_option ->
  ?address_id:Types.address_id ->
  ?resources:Types.job_resource ->
  ?creation_date:Types.timestamp ->
  ?snowball_type:Types.snowball_type ->
  ?job_type:Types.job_type ->
  ?cluster_state:Types.cluster_state ->
  ?role_ar_n:Types.role_ar_n ->
  ?kms_key_ar_n:Types.kms_key_ar_n ->
  ?description:Types.string_ ->
  ?cluster_id:Types.string_ ->
  unit ->
  Types.cluster_metadata

val make_describe_cluster_request : 
  cluster_id:Types.cluster_id ->
  unit ->
  Types.describe_cluster_request

val make_describe_addresses_request : 
  ?next_token:Types.string_ ->
  ?max_results:Types.list_limit ->
  unit ->
  Types.describe_addresses_request

val make_describe_address_request : 
  address_id:Types.address_id ->
  unit ->
  Types.describe_address_request

val make_create_return_shipping_label_request : 
  ?shipping_option:Types.shipping_option ->
  job_id:Types.job_id ->
  unit ->
  Types.create_return_shipping_label_request

val make_create_long_term_pricing_request : 
  ?is_long_term_pricing_auto_renew:Types.java_boolean ->
  snowball_type:Types.snowball_type ->
  long_term_pricing_type:Types.long_term_pricing_type ->
  unit ->
  Types.create_long_term_pricing_request

val make_create_job_request : 
  ?pickup_details:Types.pickup_details ->
  ?impact_level:Types.impact_level ->
  ?long_term_pricing_id:Types.long_term_pricing_id ->
  ?remote_management:Types.remote_management ->
  ?device_configuration:Types.device_configuration ->
  ?tax_documents:Types.tax_documents ->
  ?forwarding_address_id:Types.address_id ->
  ?snowball_type:Types.snowball_type ->
  ?cluster_id:Types.cluster_id ->
  ?notification:Types.notification ->
  ?shipping_option:Types.shipping_option ->
  ?snowball_capacity_preference:Types.snowball_capacity ->
  ?role_ar_n:Types.role_ar_n ->
  ?kms_key_ar_n:Types.kms_key_ar_n ->
  ?address_id:Types.address_id ->
  ?description:Types.string_ ->
  ?on_device_service_configuration:Types.on_device_service_configuration ->
  ?resources:Types.job_resource ->
  ?job_type:Types.job_type ->
  unit ->
  Types.create_job_request

val make_create_cluster_request : 
  ?snowball_capacity_preference:Types.snowball_capacity ->
  ?long_term_pricing_ids:Types.long_term_pricing_id_list ->
  ?force_create_jobs:Types.boolean_ ->
  ?initial_cluster_size:Types.initial_cluster_size ->
  ?remote_management:Types.remote_management ->
  ?tax_documents:Types.tax_documents ->
  ?forwarding_address_id:Types.address_id ->
  ?notification:Types.notification ->
  ?role_ar_n:Types.role_ar_n ->
  ?kms_key_ar_n:Types.kms_key_ar_n ->
  ?description:Types.string_ ->
  ?on_device_service_configuration:Types.on_device_service_configuration ->
  ?resources:Types.job_resource ->
  shipping_option:Types.shipping_option ->
  snowball_type:Types.snowball_type ->
  address_id:Types.address_id ->
  job_type:Types.job_type ->
  unit ->
  Types.create_cluster_request

val make_create_address_request : 
  address:Types.address ->
  unit ->
  Types.create_address_request

val make_cancel_job_request : 
  job_id:Types.job_id ->
  unit ->
  Types.cancel_job_request

val make_cancel_cluster_request : 
  cluster_id:Types.cluster_id ->
  unit ->
  Types.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.

module Json_serializers : sig ... end

module Json_deserializers : sig ... end