Skip to content

DescribeEnvironmentsMessage

Source code in docs_src/capo_elastic_beanstalk/types/describe_environments_message.py
class DescribeEnvironmentsMessage(TypedDict, closed=True):
    application_name: NotRequired[
        "capo_elastic_beanstalk.types.application_name.ApplicationName"
    ]
    """<p>If specified, Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.</p>"""
    version_label: NotRequired[
        "capo_elastic_beanstalk.types.version_label.VersionLabel"
    ]
    """<p>If specified, Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.</p>"""
    environment_ids: NotRequired[
        "capo_elastic_beanstalk.types.environment_id_list.EnvironmentIdList"
    ]
    """<p>If specified, Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.</p>"""
    environment_names: NotRequired[
        "capo_elastic_beanstalk.types.environment_names_list.EnvironmentNamesList"
    ]
    """<p>If specified, Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.</p>"""
    include_deleted: NotRequired[
        "capo_elastic_beanstalk.types.include_deleted.IncludeDeleted"
    ]
    """<p>Indicates whether to include deleted environments:</p> <p> <code>true</code>: Environments that have been deleted after <code>IncludedDeletedBackTo</code> are displayed.</p> <p> <code>false</code>: Do not include deleted environments.</p>"""
    included_deleted_back_to: NotRequired[
        "capo_elastic_beanstalk.types.include_deleted_back_to.IncludeDeletedBackTo"
    ]
    """<p> If specified when <code>IncludeDeleted</code> is set to <code>true</code>, then environments deleted after this date are displayed. </p>"""
    max_records: NotRequired["capo_elastic_beanstalk.types.max_records.MaxRecords"]
    """<p>For a paginated request. Specify a maximum number of environments to include in each response.</p> <p>If no <code>MaxRecords</code> is specified, all available environments are retrieved in a single response.</p>"""
    next_token: NotRequired["capo_elastic_beanstalk.types.token.Token"]
    """<p>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.</p> <p>If no <code>NextToken</code> is specified, the first page is retrieved.</p>"""

application_name instance-attribute

application_name: NotRequired[ApplicationName]

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

environment_ids instance-attribute

environment_ids: NotRequired[EnvironmentIdList]

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

environment_names instance-attribute

environment_names: NotRequired[EnvironmentNamesList]

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

include_deleted instance-attribute

include_deleted: NotRequired[IncludeDeleted]

Indicates whether to include deleted environments:

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

false: Do not include deleted environments.

included_deleted_back_to instance-attribute

included_deleted_back_to: NotRequired[IncludeDeletedBackTo]

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

max_records instance-attribute

max_records: NotRequired[MaxRecords]

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.

next_token instance-attribute

next_token: NotRequired[Token]

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.

version_label instance-attribute

version_label: NotRequired[VersionLabel]

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