libZSservicesZSamazonka-amplifyZSamazonka-amplify
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Amplify.ListJobs

Description

Lists the jobs for a branch of an Amplify app.

This operation returns paginated results.

Synopsis

Creating a Request

data ListJobs Source #

The request structure for the list jobs request.

See: newListJobs smart constructor.

Constructors

ListJobs' 

Fields

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

  • maxResults :: Maybe Natural

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

  • appId :: Text

    The unique ID for an Amplify app.

  • branchName :: Text

    The name for a branch.

Instances

Instances details
Eq ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Read ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Show ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Generic ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Associated Types

type Rep ListJobs :: Type -> Type #

Methods

from :: ListJobs -> Rep ListJobs x #

to :: Rep ListJobs x -> ListJobs #

NFData ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Methods

rnf :: ListJobs -> () #

Hashable ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Methods

hashWithSalt :: Int -> ListJobs -> Int #

hash :: ListJobs -> Int #

AWSPager ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

AWSRequest ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Associated Types

type AWSResponse ListJobs #

ToHeaders ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Methods

toHeaders :: ListJobs -> [Header] #

ToPath ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

ToQuery ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

type Rep ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

type Rep ListJobs = D1 ('MetaData "ListJobs" "Amazonka.Amplify.ListJobs" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" 'False) (C1 ('MetaCons "ListJobs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListJobs Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

newListJobs Source #

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:nextToken: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.

$sel:maxResults:ListJobs', listJobs_maxResults - The maximum number of records to list in a single response.

$sel:appId:ListJobs', listJobs_appId - The unique ID for an Amplify app.

$sel:branchName:ListJobs', listJobs_branchName - The name for a branch.

Request Lenses

listJobs_nextToken :: Lens' ListJobs (Maybe Text) Source #

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_maxResults :: Lens' ListJobs (Maybe Natural) Source #

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

listJobs_appId :: Lens' ListJobs Text Source #

The unique ID for an Amplify app.

listJobs_branchName :: Lens' ListJobs Text Source #

The name for a branch.

Destructuring the Response

data ListJobsResponse Source #

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

Instances details
Eq ListJobsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Read ListJobsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Show ListJobsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Generic ListJobsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Associated Types

type Rep ListJobsResponse :: Type -> Type #

NFData ListJobsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

Methods

rnf :: ListJobsResponse -> () #

type Rep ListJobsResponse Source # 
Instance details

Defined in Amazonka.Amplify.ListJobs

type Rep ListJobsResponse = D1 ('MetaData "ListJobsResponse" "Amazonka.Amplify.ListJobs" "libZSservicesZSamazonka-amplifyZSamazonka-amplify" '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 Source #

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:nextToken: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) Source #

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 Source #

The response's http status code.

listJobsResponse_jobSummaries :: Lens' ListJobsResponse [JobSummary] Source #

The result structure for the list job result request.