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

Amazonka.ImportExport.GetShippingLabel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

Synopsis

data GetShippingLabel = GetShippingLabel' {
- street3 :: Maybe Text
- aPIVersion :: Maybe Text
- country :: Maybe Text
- stateOrProvince :: Maybe Text
- postalCode :: Maybe Text
- street2 :: Maybe Text
- name :: Maybe Text
- company :: Maybe Text
- phoneNumber :: Maybe Text
- city :: Maybe Text
- street1 :: Maybe Text
- jobIds :: [Text]
}
newGetShippingLabel :: GetShippingLabel
getShippingLabel_street3 :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_aPIVersion :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_country :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_stateOrProvince :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_postalCode :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_street2 :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_name :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_company :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_phoneNumber :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_city :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_street1 :: Lens' GetShippingLabel (Maybe Text)
getShippingLabel_jobIds :: Lens' GetShippingLabel [Text]
data GetShippingLabelResponse = GetShippingLabelResponse' {
- shippingLabelURL :: Maybe Text
- warning :: Maybe Text
- httpStatus :: Int
}
newGetShippingLabelResponse :: Int -> GetShippingLabelResponse
getShippingLabelResponse_shippingLabelURL :: Lens' GetShippingLabelResponse (Maybe Text)
getShippingLabelResponse_warning :: Lens' GetShippingLabelResponse (Maybe Text)
getShippingLabelResponse_httpStatus :: Lens' GetShippingLabelResponse Int

Creating a Request

data GetShippingLabel Source #

See: newGetShippingLabel smart constructor.

Constructors

GetShippingLabel'
Fields street3 :: Maybe Text aPIVersion :: Maybe Text country :: Maybe Text stateOrProvince :: Maybe Text postalCode :: Maybe Text street2 :: Maybe Text name :: Maybe Text company :: Maybe Text phoneNumber :: Maybe Text city :: Maybe Text street1 :: Maybe Text jobIds :: [Text]

Instances

Instances details

Eq GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods (==) :: GetShippingLabel -> GetShippingLabel -> Bool # (/=) :: GetShippingLabel -> GetShippingLabel -> Bool #
Read GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods readsPrec :: Int -> ReadS GetShippingLabel # readList :: ReadS [GetShippingLabel] # readPrec :: ReadPrec GetShippingLabel # readListPrec :: ReadPrec [GetShippingLabel] #
Show GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods showsPrec :: Int -> GetShippingLabel -> ShowS # show :: GetShippingLabel -> String # showList :: [GetShippingLabel] -> ShowS #
Generic GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Associated Types type Rep GetShippingLabel :: Type -> Type # Methods from :: GetShippingLabel -> Rep GetShippingLabel x # to :: Rep GetShippingLabel x -> GetShippingLabel #
NFData GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods rnf :: GetShippingLabel -> () #
Hashable GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods hashWithSalt :: Int -> GetShippingLabel -> Int # hash :: GetShippingLabel -> Int #
AWSRequest GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Associated Types type AWSResponse GetShippingLabel # Methods request :: GetShippingLabel -> Request GetShippingLabel # response :: MonadResource m => Logger -> Service -> Proxy GetShippingLabel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetShippingLabel))) #
ToHeaders GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods toHeaders :: GetShippingLabel -> [Header] #
ToPath GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods toPath :: GetShippingLabel -> ByteString #
ToQuery GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods toQuery :: GetShippingLabel -> QueryString #
type Rep GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel type Rep GetShippingLabel = D1 ('MetaData "GetShippingLabel" "Amazonka.ImportExport.GetShippingLabel" "libZSservicesZSamazonka-importexportZSamazonka-importexport" 'False) (C1 ('MetaCons "GetShippingLabel'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "street3") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "aPIVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "country") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "stateOrProvince") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "postalCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "street2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "company") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "phoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "city") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "street1") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))))
type AWSResponse GetShippingLabel Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel type AWSResponse GetShippingLabel = GetShippingLabelResponse

newGetShippingLabel :: GetShippingLabel Source #

Create a value of GetShippingLabel 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:street3:GetShippingLabel', getShippingLabel_street3 - Undocumented member.

$sel:aPIVersion:GetShippingLabel', getShippingLabel_aPIVersion - Undocumented member.

$sel:country:GetShippingLabel', getShippingLabel_country - Undocumented member.

$sel:stateOrProvince:GetShippingLabel', getShippingLabel_stateOrProvince - Undocumented member.

$sel:postalCode:GetShippingLabel', getShippingLabel_postalCode - Undocumented member.

$sel:street2:GetShippingLabel', getShippingLabel_street2 - Undocumented member.

$sel:name:GetShippingLabel', getShippingLabel_name - Undocumented member.

$sel:company:GetShippingLabel', getShippingLabel_company - Undocumented member.

$sel:phoneNumber:GetShippingLabel', getShippingLabel_phoneNumber - Undocumented member.

$sel:city:GetShippingLabel', getShippingLabel_city - Undocumented member.

$sel:street1:GetShippingLabel', getShippingLabel_street1 - Undocumented member.

$sel:jobIds:GetShippingLabel', getShippingLabel_jobIds - Undocumented member.

Request Lenses

getShippingLabel_street3 :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_aPIVersion :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_country :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_stateOrProvince :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_postalCode :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_street2 :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_name :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_company :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_phoneNumber :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_city :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_street1 :: Lens' GetShippingLabel (Maybe Text) Source #

Undocumented member.

getShippingLabel_jobIds :: Lens' GetShippingLabel [Text] Source #

Undocumented member.

Destructuring the Response

data GetShippingLabelResponse Source #

See: newGetShippingLabelResponse smart constructor.

Constructors

GetShippingLabelResponse'
Fields shippingLabelURL :: Maybe Text warning :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetShippingLabelResponse Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods (==) :: GetShippingLabelResponse -> GetShippingLabelResponse -> Bool # (/=) :: GetShippingLabelResponse -> GetShippingLabelResponse -> Bool #
Read GetShippingLabelResponse Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods readsPrec :: Int -> ReadS GetShippingLabelResponse # readList :: ReadS [GetShippingLabelResponse] # readPrec :: ReadPrec GetShippingLabelResponse # readListPrec :: ReadPrec [GetShippingLabelResponse] #
Show GetShippingLabelResponse Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods showsPrec :: Int -> GetShippingLabelResponse -> ShowS # show :: GetShippingLabelResponse -> String # showList :: [GetShippingLabelResponse] -> ShowS #
Generic GetShippingLabelResponse Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Associated Types type Rep GetShippingLabelResponse :: Type -> Type # Methods from :: GetShippingLabelResponse -> Rep GetShippingLabelResponse x # to :: Rep GetShippingLabelResponse x -> GetShippingLabelResponse #
NFData GetShippingLabelResponse Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel Methods rnf :: GetShippingLabelResponse -> () #
type Rep GetShippingLabelResponse Source #
Instance details Defined in Amazonka.ImportExport.GetShippingLabel type Rep GetShippingLabelResponse = D1 ('MetaData "GetShippingLabelResponse" "Amazonka.ImportExport.GetShippingLabel" "libZSservicesZSamazonka-importexportZSamazonka-importexport" 'False) (C1 ('MetaCons "GetShippingLabelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "shippingLabelURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "warning") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetShippingLabelResponse Source #

Arguments

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

Create a value of GetShippingLabelResponse 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:shippingLabelURL:GetShippingLabelResponse', getShippingLabelResponse_shippingLabelURL - Undocumented member.

$sel:warning:GetShippingLabelResponse', getShippingLabelResponse_warning - Undocumented member.

$sel:httpStatus:GetShippingLabelResponse', getShippingLabelResponse_httpStatus - The response's http status code.

Response Lenses

getShippingLabelResponse_shippingLabelURL :: Lens' GetShippingLabelResponse (Maybe Text) Source #

Undocumented member.

getShippingLabelResponse_warning :: Lens' GetShippingLabelResponse (Maybe Text) Source #

Undocumented member.

getShippingLabelResponse_httpStatus :: Lens' GetShippingLabelResponse Int Source #

The response's http status code.