Retrieve Environment Info

elasticbeanstalk_retrieve_environment_info

R Documentation

Retrieves the compiled information from a RequestEnvironmentInfo request¶

Description¶

Retrieves the compiled information from a request_environment_info request.

Usage¶

elasticbeanstalk_retrieve_environment_info(EnvironmentId,
  EnvironmentName, InfoType)

Arguments¶

EnvironmentId

The ID of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

EnvironmentName

The name of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

InfoType

[required] The type of information to retrieve.

Value¶

A list with the following syntax:

list(
  EnvironmentInfo = list(
    list(
      InfoType = "tail"|"bundle",
      Ec2InstanceId = "string",
      SampleTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      Message = "string"
    )
  )
)

Request syntax¶

svc$retrieve_environment_info(
  EnvironmentId = "string",
  EnvironmentName = "string",
  InfoType = "tail"|"bundle"
)

Examples¶

## Not run: 
# The following operation retrieves a link to logs from an environment
# named my-env:
svc$retrieve_environment_info(
  EnvironmentName = "my-env",
  InfoType = "tail"
)

## End(Not run)