list_environments ¶

def list_environments(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    project_identifier: "capo_datazone.types.project_id.ProjectId",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    aws_account_id: Optional[
        "capo_datazone.types.aws_account_id.AwsAccountId"
    ] = None,
    status: Optional[
        "capo_datazone.types.environment_status.EnvironmentStatus"
    ] = None,
    aws_account_region: Optional["capo_datazone.types.aws_region.AwsRegion"] = None,
    environment_profile_identifier: Optional[
        "capo_datazone.types.environment_profile_id.EnvironmentProfileId"
    ] = None,
    environment_blueprint_identifier: Optional[
        "capo_datazone.types.environment_blueprint_id.EnvironmentBlueprintId"
    ] = None,
    provider: Optional[str] = None,
    name: Optional[str] = None,
    max_results: Optional["capo_datazone.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_datazone.types.list_environments_output.ListEnvironmentsOutput":
    """<p>Lists Amazon DataZone environments.</p>

    Args:
        domain_identifier: <p>The identifier of the Amazon DataZone domain.</p>
        aws_account_id: <p>The identifier of the Amazon Web Services account where you want to list environments.</p>
        status: <p>The status of the environments that you want to list.</p>
        aws_account_region: <p>The Amazon Web Services region where you want to list environments.</p>
        project_identifier: <p>The identifier of the Amazon DataZone project.</p>
        environment_profile_identifier: <p>The identifier of the environment profile.</p>
        environment_blueprint_identifier: <p>The identifier of the Amazon DataZone blueprint.</p>
        provider: <p>The provider of the environment.</p>
        name: <p>The name of the environment.</p>
        max_results: <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: <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>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.list_environments_input.ListEnvironmentsInput]",
    ) -> OperationResponse[
        "capo_datazone.types.list_environments_output.ListEnvironmentsOutput"
    ]:
        import capo_datazone._operations.data_zone.list_environments

        output, http_response = (
            capo_datazone._operations.data_zone.list_environments.list_environments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_datazone.types.list_environments_output.ListEnvironmentsOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.list_environments_output

        return capo_datazone.types.list_environments_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListEnvironments", redact_output=_redact_output),
    )
    input_: capo_datazone.types.list_environments_input.ListEnvironmentsInput = {
        "domain_identifier": domain_identifier,
        "project_identifier": project_identifier,
    }
    if aws_account_id is not None:
        input_["aws_account_id"] = aws_account_id
    if status is not None:
        input_["status"] = status
    if aws_account_region is not None:
        input_["aws_account_region"] = aws_account_region
    if environment_profile_identifier is not None:
        input_["environment_profile_identifier"] = environment_profile_identifier
    if environment_blueprint_identifier is not None:
        input_["environment_blueprint_identifier"] = (
            environment_blueprint_identifier
        )
    if provider is not None:
        input_["provider"] = provider
    if name is not None:
        input_["name"] = name
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output