return_shipping_labels

Creates, updates, deletes, gets or lists a return_shipping_labels resource.

Overview

Name	return_shipping_labels
Type	Resource
Id	aws.snowball.return_shipping_labels

Fields

The following fields are returned by SELECT queries:

describe_return_shipping_label

Name	Datatype	Description
expiration_date	string (date-time)	The expiration date of the current return shipping label.
return_shipping_label_uri	string	The pre-signed Amazon S3 URI used to download the return shipping label. (pattern: <code>.*</code>)
status	string	The status information of the task on a Snow device that is being returned to Amazon Web Services. (InProgress, TimedOut, Succeeded, Failed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_return_shipping_label	select	region		Information on the shipping label of a Snow device that is being returned to Amazon Web Services.
create_return_shipping_label	insert	region, JobId		Creates a shipping label that will be used to return the Snow device to Amazon Web Services.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_return_shipping_label

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

SELECT
expiration_date,
return_shipping_label_uri,
status
FROM aws.snowball.return_shipping_labels
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_return_shipping_label

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

INSERT INTO aws.snowball.return_shipping_labels (
JobId,
ShippingOption,
region
)
SELECT 
'{{ JobId }}' /* required */,
'{{ ShippingOption }}',
'{{ region }}'
RETURNING
status
;

Manifest

# Description fields are for documentation purposes
- name: return_shipping_labels
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the return_shipping_labels resource.
  - name: JobId
    value: "{{ JobId }}"
    description: |
      The ID for a job that you want to create the return shipping label for; for example, JID123e4567-e89b-12d3-a456-426655440000.
  - name: ShippingOption
    value: "{{ ShippingOption }}"
    description: |
      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:
    valid_values: ['SECOND_DAY', 'NEXT_DAY', 'EXPRESS', 'STANDARD']