DescribeEnvironmentsMessage

import type { DescribeEnvironmentsMessage } from "https://aws-api.deno.dev/v0.4/services/elasticbeanstalk.ts?docs=full";

Request to describe one or more environments.

interface DescribeEnvironmentsMessage {

ApplicationName?: string | null;

EnvironmentIds?: string[] | null;

EnvironmentNames?: string[] | null;

IncludedDeletedBackTo?: Date | number | null;

IncludeDeleted?: boolean | null;

MaxRecords?: number | null;

NextToken?: string | null;

VersionLabel?: string | null;

}

§Properties

ApplicationName?: string | null

[src]

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

EnvironmentIds?: string[] | null

[src]

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

EnvironmentNames?: string[] | null

[src]

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

IncludedDeletedBackTo?: Date | number | null

[src]

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

IncludeDeleted?: boolean | null

[src]

Indicates whether to include deleted environments:

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

false: Do not include deleted environments.

MaxRecords?: number | null

[src]

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?: string | null

[src]

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.

VersionLabel?: string | null

[src]

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