Request Parameters Response Elements Errors Examples See Also

ListPlatformBranches

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

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

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

Note

The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see Managing Elastic Beanstalk user policies in the Amazon Elastic Beanstalk Developer Guide. For detailed instructions to attach a policy to a user or group, see the section Controlling access with managed policies in the same topic.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Filters.member.N

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.

Type: Array of SearchFilter objects

Required: No

MaxRecords

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

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.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

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.

Type: String

PlatformBranchSummaryList.member.N

Summary information about the platform branches.

Type: Array of PlatformBranchSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

The following example requests the list of PHP platform branches that are in the Normal Maintenance state.

The request has some URL-encoded characters. %3D is the equals sign (=), and %20 is the space character.

Example

This example illustrates one usage of ListPlatformBranches.

Sample Request


https://elasticbeanstalk.us-west-2.amazonaws.com/?Filters.member.1.Attribute=PlatformName
&Filters.member.1.Operator=%3D
&Filters.member.1.Values.member.1=PHP
&Filters.member.1.Attribute=LifecycleState
&Filters.member.1.Operator=%3D
&Filters.member.1.Values.member.1=Supported
&Operation=ListPlatformBranches
&AuthParams

Sample Response


<ListPlatformBranches xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ListPlatformBranchesResult>
    <PlatformBranchSummaryList>
      <member>
        <BranchName>PHP 7.3</BranchName>
        <LifecycleState>Supported</BranchName>
        <PlatformName>PHP</BranchName>
      </member>
      <member>
        <BranchName>PHP 7.2</BranchName>
        <LifecycleState>Supported</BranchName>
        <PlatformName>PHP</BranchName>
      </member>
    </PlatformBranchSummaryList>
  </ListPlatformBranchesResult>
  <ResponseMetadata>
    <RequestId>7705f0bc-f28e-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</ListPlatformBranchesResponse>