Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Creates a shipping label that will be used to return the Snow device to AWS.
Synopsis
- data CreateReturnShippingLabel = CreateReturnShippingLabel' {}
- newCreateReturnShippingLabel :: Text -> CreateReturnShippingLabel
- createReturnShippingLabel_shippingOption :: Lens' CreateReturnShippingLabel (Maybe ShippingOption)
- createReturnShippingLabel_jobId :: Lens' CreateReturnShippingLabel Text
- data CreateReturnShippingLabelResponse = CreateReturnShippingLabelResponse' {}
- newCreateReturnShippingLabelResponse :: Int -> CreateReturnShippingLabelResponse
- createReturnShippingLabelResponse_status :: Lens' CreateReturnShippingLabelResponse (Maybe ShippingLabelStatus)
- createReturnShippingLabelResponse_httpStatus :: Lens' CreateReturnShippingLabelResponse Int
Creating a Request
data CreateReturnShippingLabel Source #
See: newCreateReturnShippingLabel
smart constructor.
CreateReturnShippingLabel' | |
|
Instances
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.
CreateReturnShippingLabelResponse' | |
|
Instances
Eq CreateReturnShippingLabelResponse Source # | |
Read CreateReturnShippingLabelResponse Source # | |
Show CreateReturnShippingLabelResponse Source # | |
Generic CreateReturnShippingLabelResponse Source # | |
NFData CreateReturnShippingLabelResponse Source # | |
Defined in Amazonka.Snowball.CreateReturnShippingLabel rnf :: CreateReturnShippingLabelResponse -> () # | |
type Rep CreateReturnShippingLabelResponse Source # | |
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.
createReturnShippingLabelResponse_httpStatus :: Lens' CreateReturnShippingLabelResponse Int Source #
The response's http status code.