Skip to content

/AWS1/CL_EBN=>DESCRIBEENVIRONMENTS()

About DescribeEnvironments

Returns descriptions for existing environments.

Method Signature

IMPORTING

Optional arguments:

IV_APPLICATIONNAME TYPE /AWS1/EBNAPPLICATIONNAME /AWS1/EBNAPPLICATIONNAME

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

IV_VERSIONLABEL TYPE /AWS1/EBNVERSIONLABEL /AWS1/EBNVERSIONLABEL

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

IT_ENVIRONMENTIDS TYPE /AWS1/CL_EBNENVIRONMENTIDLST_W=>TT_ENVIRONMENTIDLIST TT_ENVIRONMENTIDLIST

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

IT_ENVIRONMENTNAMES TYPE /AWS1/CL_EBNENVIRONMENTNAMES00=>TT_ENVIRONMENTNAMESLIST TT_ENVIRONMENTNAMESLIST

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

IV_INCLUDEDELETED TYPE /AWS1/EBNINCLUDEDELETED /AWS1/EBNINCLUDEDELETED

Indicates whether to include deleted environments:

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

false: Do not include deleted environments.

IV_INCLUDEDDELETEDBACKTO TYPE /AWS1/EBNINCLUDEDELETEDBACKTO /AWS1/EBNINCLUDEDELETEDBACKTO

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

IV_MAXRECORDS TYPE /AWS1/EBNMAXRECORDS /AWS1/EBNMAXRECORDS

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.

IV_NEXTTOKEN TYPE /AWS1/EBNTOKEN /AWS1/EBNTOKEN

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_EBNENVIRONMENTDSCSMSG /AWS1/CL_EBNENVIRONMENTDSCSMSG