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.DescribeJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about a specific job including shipping information, job status, and other important metadata.

Creating a Request

data DescribeJob Source #

See: newDescribeJob smart constructor.

Constructors

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

Instances

Instances details

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

newDescribeJob Source #

Arguments

:: Text	`DescribeJob`
-> DescribeJob

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

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

Request Lenses

describeJob_jobId :: Lens' DescribeJob Text Source #

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

Destructuring the Response

data DescribeJobResponse Source #

See: newDescribeJobResponse smart constructor.

Constructors

DescribeJobResponse'
Fields jobMetadata :: Maybe JobMetadata Information about a specific job, including shipping information, job status, and other important metadata. subJobMetadata :: Maybe [JobMetadata] Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeJobResponse Source #

Arguments

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

Create a value of DescribeJobResponse 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:jobMetadata:DescribeJobResponse', describeJobResponse_jobMetadata - Information about a specific job, including shipping information, job status, and other important metadata.

$sel:subJobMetadata:DescribeJobResponse', describeJobResponse_subJobMetadata - Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.

$sel:httpStatus:DescribeJobResponse', describeJobResponse_httpStatus - The response's http status code.

Response Lenses

describeJobResponse_jobMetadata :: Lens' DescribeJobResponse (Maybe JobMetadata) Source #

Information about a specific job, including shipping information, job status, and other important metadata.

describeJobResponse_subJobMetadata :: Lens' DescribeJobResponse (Maybe [JobMetadata]) Source #

Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.

describeJobResponse_httpStatus :: Lens' DescribeJobResponse Int Source #

The response's http status code.