Skip to content

Returns descriptions for existing environments

Description

Returns descriptions for existing environments.

This action only returns information about environments 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 environments. When the user calls the DescribeEnvironments action, the response will only include the one environment that the user has permission to access instead of all three environments. If the user doesn’t have access to any of the environments an empty result is returned.

The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk environments. 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_describe_environments(ApplicationName, VersionLabel,
  EnvironmentIds, EnvironmentNames, IncludeDeleted, IncludedDeletedBackTo,
  MaxRecords, NextToken)

Arguments

  • ApplicationName

    If specified, Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

  • VersionLabel

    If specified, Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

  • EnvironmentIds

    If specified, Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

  • EnvironmentNames

    If specified, Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

  • IncludeDeleted

    Indicates whether to include deleted environments:

    true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

    false: Do not include deleted environments.

  • IncludedDeletedBackTo

    If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

  • MaxRecords

    For a paginated request. Specify a maximum number of environments to include in each response.

    If no MaxRecords is specified, all available environments are retrieved in a single response.

  • 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(
  Environments = list(
    list(
      EnvironmentName = "string",
      EnvironmentId = "string",
      ApplicationName = "string",
      VersionLabel = "string",
      SolutionStackName = "string",
      PlatformArn = "string",
      TemplateName = "string",
      Description = "string",
      EndpointURL = "string",
      CNAME = "string",
      DateCreated = as.POSIXct(
        "2015-01-01"
      ),
      DateUpdated = as.POSIXct(
        "2015-01-01"
      ),
      Status = "Aborting"|"Launching"|"Updating"|"LinkingFrom"|"LinkingTo"|"Ready"|"Terminating"|"Terminated",
      AbortableOperationInProgress = TRUE|FALSE,
      Health = "Green"|"Yellow"|"Red"|"Grey",
      HealthStatus = "NoData"|"Unknown"|"Pending"|"Ok"|"Info"|"Warning"|"Degraded"|"Severe"|"Suspended",
      Resources = list(
        LoadBalancer = list(
          LoadBalancerName = "string",
          Domain = "string",
          Listeners = list(
            list(
              Protocol = "string",
              Port = 123
            )
          )
        )
      ),
      Tier = list(
        Name = "string",
        Type = "string",
        Version = "string"
      ),
      EnvironmentLinks = list(
        list(
          LinkName = "string",
          EnvironmentName = "string"
        )
      ),
      EnvironmentArn = "string",
      OperationsRole = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_environments(
  ApplicationName = "string",
  VersionLabel = "string",
  EnvironmentIds = list(
    "string"
  ),
  EnvironmentNames = list(
    "string"
  ),
  IncludeDeleted = TRUE|FALSE,
  IncludedDeletedBackTo = as.POSIXct(
    "2015-01-01"
  ),
  MaxRecords = 123,
  NextToken = "string"
)

Examples

# The following operation retrieves information about an environment named
# my-env:
svc$describe_environments(
  EnvironmentNames = list(
    "my-env"
  )
)