Skip to content

ListEnvironmentsInput

Source code in docs_src/capo_datazone/types/list_environments_input.py
class ListEnvironmentsInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The identifier of the Amazon DataZone domain.</p>"""
    aws_account_id: NotRequired["capo_datazone.types.aws_account_id.AwsAccountId"]
    """<p>The identifier of the Amazon Web Services account where you want to list environments.</p>"""
    status: NotRequired["capo_datazone.types.environment_status.EnvironmentStatus"]
    """<p>The status of the environments that you want to list.</p>"""
    aws_account_region: NotRequired["capo_datazone.types.aws_region.AwsRegion"]
    """<p>The Amazon Web Services region where you want to list environments.</p>"""
    project_identifier: "capo_datazone.types.project_id.ProjectId"
    """<p>The identifier of the Amazon DataZone project.</p>"""
    environment_profile_identifier: NotRequired[
        "capo_datazone.types.environment_profile_id.EnvironmentProfileId"
    ]
    """<p>The identifier of the environment profile.</p>"""
    environment_blueprint_identifier: NotRequired[
        "capo_datazone.types.environment_blueprint_id.EnvironmentBlueprintId"
    ]
    """<p>The identifier of the Amazon DataZone blueprint.</p>"""
    provider: NotRequired["str"]
    """<p>The provider of the environment.</p>"""
    name: NotRequired["str"]
    """<p>The name of the environment.</p>"""
    max_results: NotRequired["capo_datazone.types.max_results.MaxResults"]
    """<p>The maximum number of environments to return in a single call to <code>ListEnvironments</code>. When the number of environments to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListEnvironments</code> to list the next set of environments.</p>"""
    next_token: NotRequired["capo_datazone.types.pagination_token.PaginationToken"]
    """<p>When the number of environments is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of environments, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListEnvironments</code> to list the next set of environments.</p>"""

aws_account_id instance-attribute

aws_account_id: NotRequired[AwsAccountId]

The identifier of the Amazon Web Services account where you want to list environments.

aws_account_region instance-attribute

aws_account_region: NotRequired[AwsRegion]

The Amazon Web Services region where you want to list environments.

domain_identifier instance-attribute

domain_identifier: DomainId

The identifier of the Amazon DataZone domain.

environment_blueprint_identifier instance-attribute

environment_blueprint_identifier: NotRequired[EnvironmentBlueprintId]

The identifier of the Amazon DataZone blueprint.

environment_profile_identifier instance-attribute

environment_profile_identifier: NotRequired[EnvironmentProfileId]

The identifier of the environment profile.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of environments to return in a single call to ListEnvironments. When the number of environments to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironments to list the next set of environments.

name instance-attribute

name: NotRequired[str]

The name of the environment.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

project_identifier instance-attribute

project_identifier: ProjectId

The identifier of the Amazon DataZone project.

provider instance-attribute

provider: NotRequired[str]

The provider of the environment.

status instance-attribute

status: NotRequired[EnvironmentStatus]

The status of the environments that you want to list.