Amazonka.DrS.DescribeJobs

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to *Support* and only used in response to relevant support tickets.

This operation returns paginated results.

Creating a Request

data DescribeJobs

See: newDescribeJobs smart constructor.

Constructors

DescribeJobs'

Fields

• filters :: Maybe DescribeJobsRequestFilters

  A set of filters by which to return Jobs.

• maxResults :: Maybe Natural

  Maximum number of Jobs to retrieve.

• nextToken :: Maybe Text

  The token of the next Job to retrieve.

Instances

ToJSON DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Methods

toJSON :: DescribeJobs -> Value

toEncoding :: DescribeJobs -> Encoding

toJSONList :: [DescribeJobs] -> Value

toEncodingList :: [DescribeJobs] -> Encoding

ToHeaders DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Methods

toHeaders :: DescribeJobs -> [Header]

ToPath DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Methods

toPath :: DescribeJobs -> ByteString

ToQuery DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Methods

toQuery :: DescribeJobs -> QueryString

AWSPager DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Methods

page :: DescribeJobs -> AWSResponse DescribeJobs -> Maybe DescribeJobs

AWSRequest DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Associated Types

type AWSResponse DescribeJobs

Methods

request :: (Service -> Service) -> DescribeJobs -> Request DescribeJobs

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeJobs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeJobs)))

Generic DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Associated Types

type Rep DescribeJobs :: Type -> Type

Methods

from :: DescribeJobs -> Rep DescribeJobs x

to :: Rep DescribeJobs x -> DescribeJobs

Read DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Methods

readsPrec :: Int -> ReadS DescribeJobs

readList :: ReadS [DescribeJobs]

readPrec :: ReadPrec DescribeJobs

readListPrec :: ReadPrec [DescribeJobs]

Show DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Methods

showsPrec :: Int -> DescribeJobs -> ShowS

show :: DescribeJobs -> String

showList :: [DescribeJobs] -> ShowS

NFData DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Methods

rnf :: DescribeJobs -> ()

Eq DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Methods

(==) :: DescribeJobs -> DescribeJobs -> Bool

(/=) :: DescribeJobs -> DescribeJobs -> Bool

Hashable DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

Methods

hashWithSalt :: Int -> DescribeJobs -> Int

hash :: DescribeJobs -> Int

type AWSResponse DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

type AWSResponse DescribeJobs = DescribeJobsResponse

type Rep DescribeJobs

Defined in Amazonka.DrS.DescribeJobs

type Rep DescribeJobs = D1 ('MetaData "DescribeJobs" "Amazonka.DrS.DescribeJobs" "amazonka-drs-2.0-Jcy074h2jPgFhWHQx96blx" 'False) (C1 ('MetaCons "DescribeJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DescribeJobsRequestFilters)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeJobs :: DescribeJobs

Create a value of DescribeJobs 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:filters:DescribeJobs', describeJobs_filters - A set of filters by which to return Jobs.

$sel:maxResults:DescribeJobs', describeJobs_maxResults - Maximum number of Jobs to retrieve.

DescribeJobs, describeJobs_nextToken - The token of the next Job to retrieve.

Request Lenses

describeJobs_filters :: Lens' DescribeJobs (Maybe DescribeJobsRequestFilters)

A set of filters by which to return Jobs.

describeJobs_maxResults :: Lens' DescribeJobs (Maybe Natural)

Maximum number of Jobs to retrieve.

describeJobs_nextToken :: Lens' DescribeJobs (Maybe Text)

The token of the next Job to retrieve.

Destructuring the Response

data DescribeJobsResponse

See: newDescribeJobsResponse smart constructor.

Constructors

DescribeJobsResponse'

Fields

• items :: Maybe [Job]

  An array of Jobs.

• nextToken :: Maybe Text

  The token of the next Job to retrieve.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeJobsResponse

Defined in Amazonka.DrS.DescribeJobs

Associated Types

type Rep DescribeJobsResponse :: Type -> Type

Methods

from :: DescribeJobsResponse -> Rep DescribeJobsResponse x

to :: Rep DescribeJobsResponse x -> DescribeJobsResponse

Show DescribeJobsResponse

Defined in Amazonka.DrS.DescribeJobs

Methods

showsPrec :: Int -> DescribeJobsResponse -> ShowS

show :: DescribeJobsResponse -> String

showList :: [DescribeJobsResponse] -> ShowS

NFData DescribeJobsResponse

Defined in Amazonka.DrS.DescribeJobs

Methods

rnf :: DescribeJobsResponse -> ()

Eq DescribeJobsResponse

Defined in Amazonka.DrS.DescribeJobs

Methods

(==) :: DescribeJobsResponse -> DescribeJobsResponse -> Bool

(/=) :: DescribeJobsResponse -> DescribeJobsResponse -> Bool

type Rep DescribeJobsResponse

Defined in Amazonka.DrS.DescribeJobs

type Rep DescribeJobsResponse = D1 ('MetaData "DescribeJobsResponse" "Amazonka.DrS.DescribeJobs" "amazonka-drs-2.0-Jcy074h2jPgFhWHQx96blx" 'False) (C1 ('MetaCons "DescribeJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Job])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeJobsResponse

Arguments

:: Int

$sel:httpStatus:DescribeJobsResponse'

-> DescribeJobsResponse

Create a value of DescribeJobsResponse 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:items:DescribeJobsResponse', describeJobsResponse_items - An array of Jobs.

DescribeJobs, describeJobsResponse_nextToken - The token of the next Job to retrieve.

$sel:httpStatus:DescribeJobsResponse', describeJobsResponse_httpStatus - The response's http status code.

Response Lenses

describeJobsResponse_items :: Lens' DescribeJobsResponse (Maybe [Job])

An array of Jobs.

describeJobsResponse_nextToken :: Lens' DescribeJobsResponse (Maybe Text)

The token of the next Job to retrieve.

describeJobsResponse_httpStatus :: Lens' DescribeJobsResponse Int

The response's http status code.