libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk
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.ElasticBeanstalk.ListPlatformBranches

Description

Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.

For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

Synopsis

Creating a Request

data ListPlatformBranches Source #

See: newListPlatformBranches smart constructor.

Constructors

ListPlatformBranches' 

Fields

  • filters :: Maybe [SearchFilter]

    Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.

    The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.

    • Attribute = BranchName:

      • Operator: = | != | begins_with | ends_with | contains | in | not_in
    • Attribute = LifecycleState:

      • Operator: = | != | in | not_in
      • Values: beta | supported | deprecated | retired
    • Attribute = PlatformName:

      • Operator: = | != | begins_with | ends_with | contains | in | not_in
    • Attribute = TierType:

      • Operator: = | !=
      • Values: WebServer/Standard | Worker/SQS/HTTP

    Array size: limited to 10 SearchFilter objects.

    Within each SearchFilter item, the Values array is limited to 10 items.

  • nextToken :: Maybe Text

    For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

    If no NextToken is specified, the first page is retrieved.

  • maxRecords :: Maybe Natural

    The maximum number of platform branch values returned in one call.

Instances

Instances details
Eq ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

Read ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

Show ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

Generic ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

Associated Types

type Rep ListPlatformBranches :: Type -> Type #

NFData ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

Methods

rnf :: ListPlatformBranches -> () #

Hashable ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

AWSRequest ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

Associated Types

type AWSResponse ListPlatformBranches #

ToHeaders ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

ToPath ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

ToQuery ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

type Rep ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

type Rep ListPlatformBranches = D1 ('MetaData "ListPlatformBranches" "Amazonka.ElasticBeanstalk.ListPlatformBranches" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "ListPlatformBranches'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SearchFilter])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListPlatformBranches Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

newListPlatformBranches :: ListPlatformBranches Source #

Create a value of ListPlatformBranches 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:ListPlatformBranches', listPlatformBranches_filters - Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.

The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.

  • Attribute = BranchName:

    • Operator: = | != | begins_with | ends_with | contains | in | not_in
  • Attribute = LifecycleState:

    • Operator: = | != | in | not_in
    • Values: beta | supported | deprecated | retired
  • Attribute = PlatformName:

    • Operator: = | != | begins_with | ends_with | contains | in | not_in
  • Attribute = TierType:

    • Operator: = | !=
    • Values: WebServer/Standard | Worker/SQS/HTTP

Array size: limited to 10 SearchFilter objects.

Within each SearchFilter item, the Values array is limited to 10 items.

$sel:nextToken:ListPlatformBranches', listPlatformBranches_nextToken - For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

$sel:maxRecords:ListPlatformBranches', listPlatformBranches_maxRecords - The maximum number of platform branch values returned in one call.

Request Lenses

listPlatformBranches_filters :: Lens' ListPlatformBranches (Maybe [SearchFilter]) Source #

Criteria for restricting the resulting list of platform branches. The filter is evaluated as a logical conjunction (AND) of the separate SearchFilter terms.

The following list shows valid attribute values for each of the SearchFilter terms. Most operators take a single value. The in and not_in operators can take multiple values.

  • Attribute = BranchName:

    • Operator: = | != | begins_with | ends_with | contains | in | not_in
  • Attribute = LifecycleState:

    • Operator: = | != | in | not_in
    • Values: beta | supported | deprecated | retired
  • Attribute = PlatformName:

    • Operator: = | != | begins_with | ends_with | contains | in | not_in
  • Attribute = TierType:

    • Operator: = | !=
    • Values: WebServer/Standard | Worker/SQS/HTTP

Array size: limited to 10 SearchFilter objects.

Within each SearchFilter item, the Values array is limited to 10 items.

listPlatformBranches_nextToken :: Lens' ListPlatformBranches (Maybe Text) Source #

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

listPlatformBranches_maxRecords :: Lens' ListPlatformBranches (Maybe Natural) Source #

The maximum number of platform branch values returned in one call.

Destructuring the Response

data ListPlatformBranchesResponse Source #

See: newListPlatformBranchesResponse smart constructor.

Constructors

ListPlatformBranchesResponse' 

Fields

Instances

Instances details
Eq ListPlatformBranchesResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

Read ListPlatformBranchesResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

Show ListPlatformBranchesResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

Generic ListPlatformBranchesResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

Associated Types

type Rep ListPlatformBranchesResponse :: Type -> Type #

NFData ListPlatformBranchesResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

type Rep ListPlatformBranchesResponse Source # 
Instance details

Defined in Amazonka.ElasticBeanstalk.ListPlatformBranches

type Rep ListPlatformBranchesResponse = D1 ('MetaData "ListPlatformBranchesResponse" "Amazonka.ElasticBeanstalk.ListPlatformBranches" "libZSservicesZSamazonka-elasticbeanstalkZSamazonka-elasticbeanstalk" 'False) (C1 ('MetaCons "ListPlatformBranchesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "platformBranchSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformBranchSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPlatformBranchesResponse Source #

Create a value of ListPlatformBranchesResponse 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:platformBranchSummaryList:ListPlatformBranchesResponse', listPlatformBranchesResponse_platformBranchSummaryList - Summary information about the platform branches.

$sel:nextToken:ListPlatformBranches', listPlatformBranchesResponse_nextToken - In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.

$sel:httpStatus:ListPlatformBranchesResponse', listPlatformBranchesResponse_httpStatus - The response's http status code.

Response Lenses

listPlatformBranchesResponse_nextToken :: Lens' ListPlatformBranchesResponse (Maybe Text) Source #

In a paginated request, if this value isn't null, it's the token that you can pass in a subsequent request to get the next response page.