Amazonka.Snowball.ListJobs

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

This operation returns paginated results.

Creating a Request

data ListJobs

See: newListJobs smart constructor.

Constructors

ListJobs'

Fields

• maxResults :: Maybe Natural

  The number of JobListEntry objects to return.

• nextToken :: Maybe Text

  HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Instances

ToJSON ListJobs

Defined in Amazonka.Snowball.ListJobs

Methods

toJSON :: ListJobs -> Value

toEncoding :: ListJobs -> Encoding

toJSONList :: [ListJobs] -> Value

toEncodingList :: [ListJobs] -> Encoding

ToHeaders ListJobs

Defined in Amazonka.Snowball.ListJobs

Methods

toHeaders :: ListJobs -> [Header]

ToPath ListJobs

Defined in Amazonka.Snowball.ListJobs

Methods

toPath :: ListJobs -> ByteString

ToQuery ListJobs

Defined in Amazonka.Snowball.ListJobs

Methods

toQuery :: ListJobs -> QueryString

AWSPager ListJobs

Defined in Amazonka.Snowball.ListJobs

Methods

page :: ListJobs -> AWSResponse ListJobs -> Maybe ListJobs

AWSRequest ListJobs

Defined in Amazonka.Snowball.ListJobs

Associated Types

type AWSResponse ListJobs

Methods

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

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

Generic ListJobs

Defined in Amazonka.Snowball.ListJobs

Associated Types

type Rep ListJobs :: Type -> Type

Methods

from :: ListJobs -> Rep ListJobs x

to :: Rep ListJobs x -> ListJobs

Read ListJobs

Defined in Amazonka.Snowball.ListJobs

Methods

readsPrec :: Int -> ReadS ListJobs

readList :: ReadS [ListJobs]

readPrec :: ReadPrec ListJobs

readListPrec :: ReadPrec [ListJobs]

Show ListJobs

Defined in Amazonka.Snowball.ListJobs

Methods

showsPrec :: Int -> ListJobs -> ShowS

show :: ListJobs -> String

showList :: [ListJobs] -> ShowS

NFData ListJobs

Defined in Amazonka.Snowball.ListJobs

Methods

rnf :: ListJobs -> ()

Eq ListJobs

Defined in Amazonka.Snowball.ListJobs

Methods

(==) :: ListJobs -> ListJobs -> Bool

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

Hashable ListJobs

Defined in Amazonka.Snowball.ListJobs

Methods

hashWithSalt :: Int -> ListJobs -> Int

hash :: ListJobs -> Int

type AWSResponse ListJobs

Defined in Amazonka.Snowball.ListJobs

type AWSResponse ListJobs = ListJobsResponse

type Rep ListJobs

Defined in Amazonka.Snowball.ListJobs

type Rep ListJobs = D1 ('MetaData "ListJobs" "Amazonka.Snowball.ListJobs" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "ListJobs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListJobs :: ListJobs

Create a value of ListJobs 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:maxResults:ListJobs', listJobs_maxResults - The number of JobListEntry objects to return.

ListJobs, listJobs_nextToken - HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Request Lenses

listJobs_maxResults :: Lens' ListJobs (Maybe Natural)

The number of JobListEntry objects to return.

listJobs_nextToken :: Lens' ListJobs (Maybe Text)

HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Destructuring the Response

data ListJobsResponse

See: newListJobsResponse smart constructor.

Constructors

ListJobsResponse'

Fields

• jobListEntries :: Maybe [JobListEntry]

  Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.

• nextToken :: Maybe Text

  HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListJobsResponse

Defined in Amazonka.Snowball.ListJobs

Associated Types

type Rep ListJobsResponse :: Type -> Type

Methods

from :: ListJobsResponse -> Rep ListJobsResponse x

to :: Rep ListJobsResponse x -> ListJobsResponse

Read ListJobsResponse

Defined in Amazonka.Snowball.ListJobs

Methods

readsPrec :: Int -> ReadS ListJobsResponse

readList :: ReadS [ListJobsResponse]

readPrec :: ReadPrec ListJobsResponse

readListPrec :: ReadPrec [ListJobsResponse]

Show ListJobsResponse

Defined in Amazonka.Snowball.ListJobs

Methods

showsPrec :: Int -> ListJobsResponse -> ShowS

show :: ListJobsResponse -> String

showList :: [ListJobsResponse] -> ShowS

NFData ListJobsResponse

Defined in Amazonka.Snowball.ListJobs

Methods

rnf :: ListJobsResponse -> ()

Eq ListJobsResponse

Defined in Amazonka.Snowball.ListJobs

Methods

(==) :: ListJobsResponse -> ListJobsResponse -> Bool

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

type Rep ListJobsResponse

Defined in Amazonka.Snowball.ListJobs

type Rep ListJobsResponse = D1 ('MetaData "ListJobsResponse" "Amazonka.Snowball.ListJobs" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "ListJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobListEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [JobListEntry])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListJobsResponse

Arguments

:: Int

$sel:httpStatus:ListJobsResponse'

-> ListJobsResponse

Create a value of ListJobsResponse 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:jobListEntries:ListJobsResponse', listJobsResponse_jobListEntries - Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.

ListJobs, listJobsResponse_nextToken - HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.

$sel:httpStatus:ListJobsResponse', listJobsResponse_httpStatus - The response's http status code.

Response Lenses

listJobsResponse_jobListEntries :: Lens' ListJobsResponse (Maybe [JobListEntry])

Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)

HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int

The response's http status code.