Skip to content

/AWS1/IF_EBN=>REQUESTENVIRONMENTINFO()

About 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

Method Signature

METHODS /AWS1/IF_EBN~REQUESTENVIRONMENTINFO
  IMPORTING
    !IV_ENVIRONMENTID TYPE /AWS1/EBNENVIRONMENTID OPTIONAL
    !IV_ENVIRONMENTNAME TYPE /AWS1/EBNENVIRONMENTNAME OPTIONAL
    !IV_INFOTYPE TYPE /AWS1/EBNENVIRONMENTINFOTYPE OPTIONAL
  RAISING
    /AWS1/CX_EBNCLIENTEXC
    /AWS1/CX_EBNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_infotype TYPE /AWS1/EBNENVIRONMENTINFOTYPE /AWS1/EBNENVIRONMENTINFOTYPE

The type of information to request.

Optional arguments:

iv_environmentid TYPE /AWS1/EBNENVIRONMENTID /AWS1/EBNENVIRONMENTID

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, AWS Elastic Beanstalk returns MissingRequiredParameter error.

iv_environmentname TYPE /AWS1/EBNENVIRONMENTNAME /AWS1/EBNENVIRONMENTNAME

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, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->requestenvironmentinfo(
  iv_environmentid = |string|
  iv_environmentname = |string|
  iv_infotype = |string|
).

To request tailed logs

The following operation requests logs from an environment named my-env:

lo_client->requestenvironmentinfo(
  iv_environmentname = |my-env|
  iv_infotype = |tail|
).