libZSservicesZSamazonka-snowballZSamazonka-snowball
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Snowball.CreateReturnShippingLabel

Description

Creates a shipping label that will be used to return the Snow device to AWS.

Synopsis

Creating a Request

data CreateReturnShippingLabel Source #

See: newCreateReturnShippingLabel smart constructor.

Constructors

CreateReturnShippingLabel' 

Fields

  • shippingOption :: Maybe ShippingOption

    The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to AWS. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:

  • jobId :: Text

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

Instances

Instances details
Eq CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

Read CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

Show CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

Generic CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

Associated Types

type Rep CreateReturnShippingLabel :: Type -> Type #

NFData CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

Hashable CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

ToJSON CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

AWSRequest CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

ToHeaders CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

ToPath CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

ToQuery CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

type Rep CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

type Rep CreateReturnShippingLabel = D1 ('MetaData "CreateReturnShippingLabel" "Amazonka.Snowball.CreateReturnShippingLabel" "libZSservicesZSamazonka-snowballZSamazonka-snowball" 'False) (C1 ('MetaCons "CreateReturnShippingLabel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shippingOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShippingOption)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateReturnShippingLabel Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

newCreateReturnShippingLabel Source #

Create a value of CreateReturnShippingLabel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:shippingOption:CreateReturnShippingLabel', createReturnShippingLabel_shippingOption - The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to AWS. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:

$sel:jobId:CreateReturnShippingLabel', createReturnShippingLabel_jobId - The ID for a job that you want to create the return shipping label for; for example, JID123e4567-e89b-12d3-a456-426655440000.

Request Lenses

createReturnShippingLabel_shippingOption :: Lens' CreateReturnShippingLabel (Maybe ShippingOption) Source #

The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to AWS. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:

createReturnShippingLabel_jobId :: Lens' CreateReturnShippingLabel Text Source #

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

Destructuring the Response

data CreateReturnShippingLabelResponse Source #

See: newCreateReturnShippingLabelResponse smart constructor.

Constructors

CreateReturnShippingLabelResponse' 

Fields

Instances

Instances details
Eq CreateReturnShippingLabelResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

Read CreateReturnShippingLabelResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

Show CreateReturnShippingLabelResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

Generic CreateReturnShippingLabelResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

Associated Types

type Rep CreateReturnShippingLabelResponse :: Type -> Type #

NFData CreateReturnShippingLabelResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

type Rep CreateReturnShippingLabelResponse Source # 
Instance details

Defined in Amazonka.Snowball.CreateReturnShippingLabel

type Rep CreateReturnShippingLabelResponse = D1 ('MetaData "CreateReturnShippingLabelResponse" "Amazonka.Snowball.CreateReturnShippingLabel" "libZSservicesZSamazonka-snowballZSamazonka-snowball" 'False) (C1 ('MetaCons "CreateReturnShippingLabelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShippingLabelStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateReturnShippingLabelResponse Source #

Create a value of CreateReturnShippingLabelResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:CreateReturnShippingLabelResponse', createReturnShippingLabelResponse_status - The status information of the task on a Snow device that is being returned to AWS.

$sel:httpStatus:CreateReturnShippingLabelResponse', createReturnShippingLabelResponse_httpStatus - The response's http status code.

Response Lenses

createReturnShippingLabelResponse_status :: Lens' CreateReturnShippingLabelResponse (Maybe ShippingLabelStatus) Source #

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