Lists the platform branches available for your account in an Amazon Web Services Region¶

Description¶

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

For definitions of platform branch and other platform-related terms, see 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.

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

Usage¶

elasticbeanstalk_list_platform_branches(Filters, MaxRecords, NextToken)

Arguments¶

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

• MaxRecords

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

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

Value¶

A list with the following syntax:

list(
  PlatformBranchSummaryList = list(
    list(
      PlatformName = "string",
      BranchName = "string",
      LifecycleState = "string",
      BranchOrder = 123,
      SupportedTierList = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_platform_branches(
  Filters = list(
    list(
      Attribute = "string",
      Operator = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  NextToken = "string"
)