Module Awso_snowball_eioSource

include module type of struct include Awso_snowball.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval serviceAbbreviation : string
Sourceval targetPrefix : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

The container for the EventTriggerDefinition$EventResourceARN.

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

Sourcemodule EventTriggerDefinitionList = Awso_snowball.Values.EventTriggerDefinitionList

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.

Sourcemodule TargetOnDeviceServiceList = Awso_snowball.Values.TargetOnDeviceServiceList

Configures the wireless connection on an Snowball Edge device.

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.

Identifies

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.

Sourcemodule SnowconeDeviceConfiguration = Awso_snowball.Values.SnowconeDeviceConfiguration

Specifies the device configuration for an Snowball Edge job.

Sourcemodule EKSOnDeviceServiceConfiguration = Awso_snowball.Values.EKSOnDeviceServiceConfiguration

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

Sourcemodule NFSOnDeviceServiceConfiguration = Awso_snowball.Values.NFSOnDeviceServiceConfiguration

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

Sourcemodule S3OnDeviceServiceConfiguration = Awso_snowball.Values.S3OnDeviceServiceConfiguration

Amazon S3 compatible storage on Snow family devices configuration items.

Sourcemodule TGWOnDeviceServiceConfiguration = Awso_snowball.Values.TGWOnDeviceServiceConfiguration

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.

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

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

The version of the requested service.

Sourcemodule LongTermPricingAssociatedJobIdList = Awso_snowball.Values.LongTermPricingAssociatedJobIdList

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.

The container for SnowconeDeviceConfiguration.

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.

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.

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.

Sourcemodule OnDeviceServiceConfiguration = Awso_snowball.Values.OnDeviceServiceConfiguration

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

Information identifying the person picking up the device.

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

The tax documents required in your Amazon Web Services Region.

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

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.

Sourcemodule LongTermPricingListEntry = Awso_snowball.Values.LongTermPricingListEntry

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

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.

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.

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

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.

Sourcemodule InvalidResourceException = Awso_snowball.Values.InvalidResourceException

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

Sourcemodule InvalidJobStateException = Awso_snowball.Values.InvalidJobStateException

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

Sourcemodule ClusterLimitExceededException = Awso_snowball.Values.ClusterLimitExceededException

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.

Sourcemodule Ec2RequestFailedException = Awso_snowball.Values.Ec2RequestFailedException

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

Sourcemodule InvalidInputCombinationException = Awso_snowball.Values.InvalidInputCombinationException

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

Sourcemodule KMSRequestFailedException = Awso_snowball.Values.KMSRequestFailedException

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

Sourcemodule InvalidNextTokenException = Awso_snowball.Values.InvalidNextTokenException

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

Sourcemodule LongTermPricingEntryList = Awso_snowball.Values.LongTermPricingEntryList

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

Contains metadata about a specific cluster.

Sourcemodule ReturnShippingLabelAlreadyExistsException = Awso_snowball.Values.ReturnShippingLabelAlreadyExistsException

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.

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

Sourcemodule UnsupportedAddressException = Awso_snowball.Values.UnsupportedAddressException

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.

Sourcemodule UpdateLongTermPricingResult = Awso_snowball.Values.UpdateLongTermPricingResult

Updates the long-term pricing type.

Sourcemodule UpdateLongTermPricingRequest = Awso_snowball.Values.UpdateLongTermPricingRequest

Updates the long-term pricing type.

Sourcemodule UpdateJobShipmentStateResult = Awso_snowball.Values.UpdateJobShipmentStateResult

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

Sourcemodule UpdateJobShipmentStateRequest = Awso_snowball.Values.UpdateJobShipmentStateRequest

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

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.

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.

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.

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.

Sourcemodule ListServiceVersionsResult = Awso_snowball.Values.ListServiceVersionsResult

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

Sourcemodule ListServiceVersionsRequest = Awso_snowball.Values.ListServiceVersionsRequest

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

Sourcemodule ListPickupLocationsResult = Awso_snowball.Values.ListPickupLocationsResult

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

Sourcemodule ListPickupLocationsRequest = Awso_snowball.Values.ListPickupLocationsRequest

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

Sourcemodule ListLongTermPricingResult = Awso_snowball.Values.ListLongTermPricingResult

Lists all long-term pricing types.

Sourcemodule ListLongTermPricingRequest = Awso_snowball.Values.ListLongTermPricingRequest

Lists all long-term pricing types.

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.

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.

Sourcemodule ListCompatibleImagesResult = Awso_snowball.Values.ListCompatibleImagesResult

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.

Sourcemodule ListCompatibleImagesRequest = Awso_snowball.Values.ListCompatibleImagesRequest

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.

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.

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.

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.

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.

Sourcemodule GetSoftwareUpdatesResult = Awso_snowball.Values.GetSoftwareUpdatesResult

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

Sourcemodule GetSoftwareUpdatesRequest = Awso_snowball.Values.GetSoftwareUpdatesRequest

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

Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use. The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.

Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use. The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support.

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is WithCustomer as the manifest and Unlock code values are used for securing your device and should only be used when you have the device. As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 360 days after the associated job has been created. The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is WithCustomer as the manifest and Unlock code values are used for securing your device and should only be used when you have the device. As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job.

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action. The manifest is an encrypted file that you can download after your job enters the WithCustomer status. This is the only valid status for calling this API as the manifest and UnlockCode code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snow device through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action. The manifest is an encrypted file that you can download after your job enters the WithCustomer status. This is the only valid status for calling this API as the manifest and UnlockCode code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snow device through the Snowball client when the client is started for the first time. As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job. The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created.

Sourcemodule DescribeReturnShippingLabelResult = Awso_snowball.Values.DescribeReturnShippingLabelResult

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

Sourcemodule DescribeReturnShippingLabelRequest = Awso_snowball.Values.DescribeReturnShippingLabelRequest

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

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

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

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

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

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.

Sourcemodule DescribeAddressesRequest = Awso_snowball.Values.DescribeAddressesRequest

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.

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

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

Sourcemodule CreateReturnShippingLabelResult = Awso_snowball.Values.CreateReturnShippingLabelResult

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

Sourcemodule CreateReturnShippingLabelRequest = Awso_snowball.Values.CreateReturnShippingLabelRequest

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

Sourcemodule CreateLongTermPricingResult = Awso_snowball.Values.CreateLongTermPricingResult

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.

Sourcemodule CreateLongTermPricingRequest = Awso_snowball.Values.CreateLongTermPricingRequest

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.

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster. Only the Snowball; Edge device type is supported when ordering clustered jobs. The device capacity is optional. Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services. Snow Family devices and their capacities. Device type: SNC1_SSD Capacity: T14 Description: Snowcone Device type: SNC1_HDD Capacity: T8 Description: Snowcone Device type: EDGE_S Capacity: T98 Description: Snowball Edge Storage Optimized for data transfer only Device type: EDGE_CG Capacity: T42 Description: Snowball Edge Compute Optimized with GPU Device type: EDGE_C Capacity: T42 Description: Snowball Edge Compute Optimized without GPU Device type: EDGE Capacity: T100 Description: Snowball Edge Storage Optimized with EC2 Compute This device is replaced with T98. Device type: STANDARD Capacity: T50 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region Device type: STANDARD Capacity: T80 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region. Snow Family device type: RACK_5U_C Capacity: T13 Description: Snowblade. Device type: V3_5S Capacity: T240 Description: Snowball Edge Storage Optimized 210TB

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster. Only the Snowball; Edge device type is supported when ordering clustered jobs. The device capacity is optional. Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services. Snow Family devices and their capacities. Device type: SNC1_SSD Capacity: T14 Description: Snowcone Device type: SNC1_HDD Capacity: T8 Description: Snowcone Device type: EDGE_S Capacity: T98 Description: Snowball Edge Storage Optimized for data transfer only Device type: EDGE_CG Capacity: T42 Description: Snowball Edge Compute Optimized with GPU Device type: EDGE_C Capacity: T42 Description: Snowball Edge Compute Optimized without GPU Device type: EDGE Capacity: T100 Description: Snowball Edge Storage Optimized with EC2 Compute This device is replaced with T98. Device type: STANDARD Capacity: T50 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region Device type: STANDARD Capacity: T80 Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region. Snow Family device type: RACK_5U_C Capacity: T13 Description: Snowblade. Device type: V3_5S Capacity: T240 Description: Snowball Edge Storage Optimized 210TB

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.

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.

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.

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.

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.

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.

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.

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.