Amazonka.Amplify.ListJobs

Lists the jobs for a branch of an Amplify app.

This operation returns paginated results.

Creating a Request

data ListJobs

The request structure for the list jobs request.

See: newListJobs smart constructor.

Constructors

ListJobs'

Fields

• maxResults :: Maybe Natural

  The maximum number of records to list in a single response.

• nextToken :: Maybe Text

  A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.

• appId :: Text

  The unique ID for an Amplify app.

• branchName :: Text

  The name for a branch.

Instances

ToHeaders ListJobs

Defined in Amazonka.Amplify.ListJobs

Methods

toHeaders :: ListJobs -> [Header]

ToPath ListJobs

Defined in Amazonka.Amplify.ListJobs

Methods

toPath :: ListJobs -> ByteString

ToQuery ListJobs

Defined in Amazonka.Amplify.ListJobs

Methods

toQuery :: ListJobs -> QueryString

AWSPager ListJobs

Defined in Amazonka.Amplify.ListJobs

Methods

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

AWSRequest ListJobs

Defined in Amazonka.Amplify.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.Amplify.ListJobs

Associated Types

type Rep ListJobs :: Type -> Type

Methods

from :: ListJobs -> Rep ListJobs x

to :: Rep ListJobs x -> ListJobs

Read ListJobs

Defined in Amazonka.Amplify.ListJobs

Methods

readsPrec :: Int -> ReadS ListJobs

readList :: ReadS [ListJobs]

readPrec :: ReadPrec ListJobs

readListPrec :: ReadPrec [ListJobs]

Show ListJobs

Defined in Amazonka.Amplify.ListJobs

Methods

showsPrec :: Int -> ListJobs -> ShowS

show :: ListJobs -> String

showList :: [ListJobs] -> ShowS

NFData ListJobs

Defined in Amazonka.Amplify.ListJobs

Methods

rnf :: ListJobs -> ()

Eq ListJobs

Defined in Amazonka.Amplify.ListJobs

Methods

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

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

Hashable ListJobs

Defined in Amazonka.Amplify.ListJobs

Methods

hashWithSalt :: Int -> ListJobs -> Int

hash :: ListJobs -> Int

type AWSResponse ListJobs

Defined in Amazonka.Amplify.ListJobs

type AWSResponse ListJobs = ListJobsResponse

type Rep ListJobs

Defined in Amazonka.Amplify.ListJobs

type Rep ListJobs = D1 ('MetaData "ListJobs" "Amazonka.Amplify.ListJobs" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" '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))) :*: (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListJobs

Arguments

:: Text

ListJobs

-> Text

ListJobs

-> 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 maximum number of records to list in a single response.

ListJobs, listJobs_nextToken - A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.

ListJobs, listJobs_appId - The unique ID for an Amplify app.

ListJobs, listJobs_branchName - The name for a branch.

Request Lenses

listJobs_maxResults :: Lens' ListJobs (Maybe Natural)

The maximum number of records to list in a single response.

listJobs_nextToken :: Lens' ListJobs (Maybe Text)

A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.

listJobs_appId :: Lens' ListJobs Text

The unique ID for an Amplify app.

listJobs_branchName :: Lens' ListJobs Text

The name for a branch.

Destructuring the Response

data ListJobsResponse

The maximum number of records to list in a single response.

See: newListJobsResponse smart constructor.

Constructors

ListJobsResponse'

Fields

• nextToken :: Maybe Text

  A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

• httpStatus :: Int

  The response's http status code.

• jobSummaries :: [JobSummary]

  The result structure for the list job result request.

Instances

Generic ListJobsResponse

Defined in Amazonka.Amplify.ListJobs

Associated Types

type Rep ListJobsResponse :: Type -> Type

Methods

from :: ListJobsResponse -> Rep ListJobsResponse x

to :: Rep ListJobsResponse x -> ListJobsResponse

Read ListJobsResponse

Defined in Amazonka.Amplify.ListJobs

Methods

readsPrec :: Int -> ReadS ListJobsResponse

readList :: ReadS [ListJobsResponse]

readPrec :: ReadPrec ListJobsResponse

readListPrec :: ReadPrec [ListJobsResponse]

Show ListJobsResponse

Defined in Amazonka.Amplify.ListJobs

Methods

showsPrec :: Int -> ListJobsResponse -> ShowS

show :: ListJobsResponse -> String

showList :: [ListJobsResponse] -> ShowS

NFData ListJobsResponse

Defined in Amazonka.Amplify.ListJobs

Methods

rnf :: ListJobsResponse -> ()

Eq ListJobsResponse

Defined in Amazonka.Amplify.ListJobs

Methods

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

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

type Rep ListJobsResponse

Defined in Amazonka.Amplify.ListJobs

type Rep ListJobsResponse = D1 ('MetaData "ListJobsResponse" "Amazonka.Amplify.ListJobs" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "ListJobsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [JobSummary]))))

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:

ListJobs, listJobsResponse_nextToken - A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

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

$sel:jobSummaries:ListJobsResponse', listJobsResponse_jobSummaries - The result structure for the list job result request.

Response Lenses

listJobsResponse_nextToken :: Lens' ListJobsResponse (Maybe Text)

A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

listJobsResponse_httpStatus :: Lens' ListJobsResponse Int

The response's http status code.

listJobsResponse_jobSummaries :: Lens' ListJobsResponse [JobSummary]

The result structure for the list job result request.