Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Snowball.DescribeReturnShippingLabel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data DescribeReturnShippingLabel Source #

See: newDescribeReturnShippingLabel smart constructor.

Constructors

DescribeReturnShippingLabel'
Fields jobId :: Text The automatically generated ID for a job, for example `JID123e4567-e89b-12d3-a456-426655440000`.

Instances

Instances details

ToJSON DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods toJSON :: DescribeReturnShippingLabel -> Value # toEncoding :: DescribeReturnShippingLabel -> Encoding # toJSONList :: [DescribeReturnShippingLabel] -> Value # toEncodingList :: [DescribeReturnShippingLabel] -> Encoding #
ToHeaders DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods toHeaders :: DescribeReturnShippingLabel -> [Header] #
ToPath DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods toPath :: DescribeReturnShippingLabel -> ByteString #
ToQuery DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods toQuery :: DescribeReturnShippingLabel -> QueryString #
AWSRequest DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Associated Types type AWSResponse DescribeReturnShippingLabel # Methods request :: (Service -> Service) -> DescribeReturnShippingLabel -> Request DescribeReturnShippingLabel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeReturnShippingLabel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeReturnShippingLabel))) #
Generic DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Associated Types type Rep DescribeReturnShippingLabel :: Type -> Type # Methods from :: DescribeReturnShippingLabel -> Rep DescribeReturnShippingLabel x # to :: Rep DescribeReturnShippingLabel x -> DescribeReturnShippingLabel #
Read DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods readsPrec :: Int -> ReadS DescribeReturnShippingLabel # readList :: ReadS [DescribeReturnShippingLabel] # readPrec :: ReadPrec DescribeReturnShippingLabel # readListPrec :: ReadPrec [DescribeReturnShippingLabel] #
Show DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods showsPrec :: Int -> DescribeReturnShippingLabel -> ShowS # show :: DescribeReturnShippingLabel -> String # showList :: [DescribeReturnShippingLabel] -> ShowS #
NFData DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods rnf :: DescribeReturnShippingLabel -> () #
Eq DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods (==) :: DescribeReturnShippingLabel -> DescribeReturnShippingLabel -> Bool # (/=) :: DescribeReturnShippingLabel -> DescribeReturnShippingLabel -> Bool #
Hashable DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods hashWithSalt :: Int -> DescribeReturnShippingLabel -> Int # hash :: DescribeReturnShippingLabel -> Int #
type AWSResponse DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel type AWSResponse DescribeReturnShippingLabel = DescribeReturnShippingLabelResponse
type Rep DescribeReturnShippingLabel Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel type Rep DescribeReturnShippingLabel = D1 ('MetaData "DescribeReturnShippingLabel" "Amazonka.Snowball.DescribeReturnShippingLabel" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "DescribeReturnShippingLabel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeReturnShippingLabel Source #

Arguments

:: Text	`DescribeReturnShippingLabel`
-> DescribeReturnShippingLabel

Create a value of DescribeReturnShippingLabel 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:

DescribeReturnShippingLabel, describeReturnShippingLabel_jobId - The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Request Lenses

describeReturnShippingLabel_jobId :: Lens' DescribeReturnShippingLabel Text Source #

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

Destructuring the Response

data DescribeReturnShippingLabelResponse Source #

See: newDescribeReturnShippingLabelResponse smart constructor.

Constructors

DescribeReturnShippingLabelResponse'
Fields expirationDate :: Maybe POSIX The expiration date of the current return shipping label. returnShippingLabelURI :: Maybe Text The pre-signed Amazon S3 URI used to download the return shipping label. status :: Maybe ShippingLabelStatus The status information of the task on a Snow device that is being returned to Amazon Web Services. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeReturnShippingLabelResponse Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Associated Types type Rep DescribeReturnShippingLabelResponse :: Type -> Type # Methods from :: DescribeReturnShippingLabelResponse -> Rep DescribeReturnShippingLabelResponse x # to :: Rep DescribeReturnShippingLabelResponse x -> DescribeReturnShippingLabelResponse #
Read DescribeReturnShippingLabelResponse Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods readsPrec :: Int -> ReadS DescribeReturnShippingLabelResponse # readList :: ReadS [DescribeReturnShippingLabelResponse] # readPrec :: ReadPrec DescribeReturnShippingLabelResponse # readListPrec :: ReadPrec [DescribeReturnShippingLabelResponse] #
Show DescribeReturnShippingLabelResponse Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods showsPrec :: Int -> DescribeReturnShippingLabelResponse -> ShowS # show :: DescribeReturnShippingLabelResponse -> String # showList :: [DescribeReturnShippingLabelResponse] -> ShowS #
NFData DescribeReturnShippingLabelResponse Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods rnf :: DescribeReturnShippingLabelResponse -> () #
Eq DescribeReturnShippingLabelResponse Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel Methods (==) :: DescribeReturnShippingLabelResponse -> DescribeReturnShippingLabelResponse -> Bool # (/=) :: DescribeReturnShippingLabelResponse -> DescribeReturnShippingLabelResponse -> Bool #
type Rep DescribeReturnShippingLabelResponse Source #
Instance details Defined in Amazonka.Snowball.DescribeReturnShippingLabel type Rep DescribeReturnShippingLabelResponse = D1 ('MetaData "DescribeReturnShippingLabelResponse" "Amazonka.Snowball.DescribeReturnShippingLabel" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "DescribeReturnShippingLabelResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "returnShippingLabelURI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShippingLabelStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeReturnShippingLabelResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeReturnShippingLabelResponse'`
-> DescribeReturnShippingLabelResponse

Create a value of DescribeReturnShippingLabelResponse 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:expirationDate:DescribeReturnShippingLabelResponse', describeReturnShippingLabelResponse_expirationDate - The expiration date of the current return shipping label.

$sel:returnShippingLabelURI:DescribeReturnShippingLabelResponse', describeReturnShippingLabelResponse_returnShippingLabelURI - The pre-signed Amazon S3 URI used to download the return shipping label.

DescribeReturnShippingLabelResponse, describeReturnShippingLabelResponse_status - The status information of the task on a Snow device that is being returned to Amazon Web Services.

$sel:httpStatus:DescribeReturnShippingLabelResponse', describeReturnShippingLabelResponse_httpStatus - The response's http status code.

Response Lenses

describeReturnShippingLabelResponse_expirationDate :: Lens' DescribeReturnShippingLabelResponse (Maybe UTCTime) Source #

The expiration date of the current return shipping label.

describeReturnShippingLabelResponse_returnShippingLabelURI :: Lens' DescribeReturnShippingLabelResponse (Maybe Text) Source #

The pre-signed Amazon S3 URI used to download the return shipping label.

describeReturnShippingLabelResponse_status :: Lens' DescribeReturnShippingLabelResponse (Maybe ShippingLabelStatus) Source #

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

describeReturnShippingLabelResponse_httpStatus :: Lens' DescribeReturnShippingLabelResponse Int Source #

The response's http status code.