amazonka-batch-2.0: Amazon Batch SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Batch.ListSchedulingPolicies

Description

Returns a list of Batch scheduling policies.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSchedulingPolicies Source #

Contains the parameters for ListSchedulingPolicies.

See: newListSchedulingPolicies smart constructor.

Constructors

ListSchedulingPolicies' 

Fields

  • maxResults :: Maybe Int

    The maximum number of results that's returned by ListSchedulingPolicies in paginated output. When this parameter is used, ListSchedulingPolicies only returns maxResults results in a single page and a nextToken response element. You can see the remaining results of the initial request by sending another ListSchedulingPolicies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, ListSchedulingPolicies returns up to 100 results and a nextToken value if applicable.

  • nextToken :: Maybe Text

    The nextToken value that's returned from a previous paginated ListSchedulingPolicies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

    Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Instances

Instances details
ToJSON ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

ToHeaders ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

ToPath ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

ToQuery ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

AWSPager ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

AWSRequest ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Associated Types

type AWSResponse ListSchedulingPolicies #

Generic ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Associated Types

type Rep ListSchedulingPolicies :: Type -> Type #

Read ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Show ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

NFData ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Methods

rnf :: ListSchedulingPolicies -> () #

Eq ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Hashable ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

type AWSResponse ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

type Rep ListSchedulingPolicies Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

type Rep ListSchedulingPolicies = D1 ('MetaData "ListSchedulingPolicies" "Amazonka.Batch.ListSchedulingPolicies" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ListSchedulingPolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListSchedulingPolicies :: ListSchedulingPolicies Source #

Create a value of ListSchedulingPolicies 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:ListSchedulingPolicies', listSchedulingPolicies_maxResults - The maximum number of results that's returned by ListSchedulingPolicies in paginated output. When this parameter is used, ListSchedulingPolicies only returns maxResults results in a single page and a nextToken response element. You can see the remaining results of the initial request by sending another ListSchedulingPolicies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, ListSchedulingPolicies returns up to 100 results and a nextToken value if applicable.

ListSchedulingPolicies, listSchedulingPolicies_nextToken - The nextToken value that's returned from a previous paginated ListSchedulingPolicies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Request Lenses

listSchedulingPolicies_maxResults :: Lens' ListSchedulingPolicies (Maybe Int) Source #

The maximum number of results that's returned by ListSchedulingPolicies in paginated output. When this parameter is used, ListSchedulingPolicies only returns maxResults results in a single page and a nextToken response element. You can see the remaining results of the initial request by sending another ListSchedulingPolicies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, ListSchedulingPolicies returns up to 100 results and a nextToken value if applicable.

listSchedulingPolicies_nextToken :: Lens' ListSchedulingPolicies (Maybe Text) Source #

The nextToken value that's returned from a previous paginated ListSchedulingPolicies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Destructuring the Response

data ListSchedulingPoliciesResponse Source #

See: newListSchedulingPoliciesResponse smart constructor.

Constructors

ListSchedulingPoliciesResponse' 

Fields

  • nextToken :: Maybe Text

    The nextToken value to include in a future ListSchedulingPolicies request. When the results of a ListSchedulingPolicies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

  • schedulingPolicies :: Maybe [SchedulingPolicyListingDetail]

    A list of scheduling policies that match the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Associated Types

type Rep ListSchedulingPoliciesResponse :: Type -> Type #

Read ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Show ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

NFData ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

Eq ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

type Rep ListSchedulingPoliciesResponse Source # 
Instance details

Defined in Amazonka.Batch.ListSchedulingPolicies

type Rep ListSchedulingPoliciesResponse = D1 ('MetaData "ListSchedulingPoliciesResponse" "Amazonka.Batch.ListSchedulingPolicies" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "ListSchedulingPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "schedulingPolicies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SchedulingPolicyListingDetail])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSchedulingPoliciesResponse Source #

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

ListSchedulingPolicies, listSchedulingPoliciesResponse_nextToken - The nextToken value to include in a future ListSchedulingPolicies request. When the results of a ListSchedulingPolicies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:schedulingPolicies:ListSchedulingPoliciesResponse', listSchedulingPoliciesResponse_schedulingPolicies - A list of scheduling policies that match the request.

$sel:httpStatus:ListSchedulingPoliciesResponse', listSchedulingPoliciesResponse_httpStatus - The response's http status code.

Response Lenses

listSchedulingPoliciesResponse_nextToken :: Lens' ListSchedulingPoliciesResponse (Maybe Text) Source #

The nextToken value to include in a future ListSchedulingPolicies request. When the results of a ListSchedulingPolicies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.