RequestEnvironmentInfo - Amazon Elastic Beanstalk
Request ParametersErrorsExamplesSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

RequestEnvironmentInfo

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

Request Parameters

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

EnvironmentId

The ID of the environment of the requested data.

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

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

Type: String

Required: No

EnvironmentName

The name of the environment of the requested data.

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

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

Type: String

Length Constraints: Minimum length of 4. Maximum length of 40.

Required: No

InfoType

The type of information to request.

Type: String

Valid Values: tail | bundle

Required: Yes

Errors

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

Examples

Example

This example illustrates one usage of RequestEnvironmentInfo.

Sample Request

https://elasticbeanstalk.us-west-2.amazonaws.com/?EnvironmentId=e-hc8mvnayrx
&EnvironmentName=SampleAppVersion
&InfoType=tail
&Operation=RequestEnvironmentInfo
&AuthParams

Sample Response

<RequestEnvironmentInfoResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <ResponseMetadata>
    <RequestId>126a4ff3-f28a-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</RequestEnvironmentInfoResponse>

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: