list_environments ¶

list_environments(
    application_id: Name,
    *,
    config_overrides: Optional[AppConfigClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> Environments

Lists the environments for an application.

Parameters:

application_id (Name) –

The application ID.
max_results (Optional[MaxResults], default: None ) –

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
next_token (Optional[NextToken], default: None ) –

A token to start the list. Use this token to get the next set of results.

Raises:

BadRequestException –

The input fails to satisfy the constraints specified by an Amazon Web Services service.
InternalServerException –

There was an internal failure in the AppConfig service.
ResourceNotFoundException –

The requested resource could not be found.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To list the available environments The following list-environments example lists the available environments in your AWS account for the specified application.

>>> client.list_environments(application_id='339ohji')

Source code in docs_src/capo_appconfig/_services/app_config.py

def list_environments(
    self,
    application_id: "capo_appconfig.types.name.Name",
    *,
    config_overrides: Optional[AppConfigClientConfig] = None,
    max_results: Optional["capo_appconfig.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_appconfig.types.next_token.NextToken"] = None,
) -> "capo_appconfig.types.environments.Environments":
    """<p>Lists the environments for an application.</p>

    Args:
        application_id: <p>The application ID.</p>
        max_results: <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
        next_token: <p>A token to start the list. Use this token to get the next set of results.</p>

    Raises:
        capo_appconfig.errors.bad_request_exception.BadRequestException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_appconfig.errors.internal_server_exception.InternalServerException: <p>There was an internal failure in the AppConfig service.</p>
        capo_appconfig.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource could not be found.</p>
        capo_appconfig.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To list the available environments
        The following list-environments example lists the available environments in your AWS account for the specified application.

        >>> client.list_environments(application_id='339ohji')
    """

    def _handler(
        req: "OperationRequest[capo_appconfig.types.list_environments_request.ListEnvironmentsRequest]",
    ) -> OperationResponse["capo_appconfig.types.environments.Environments"]:
        import capo_appconfig._operations.amazon_app_config.list_environments

        output, http_response = (
            capo_appconfig._operations.amazon_app_config.list_environments.list_environments(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEnvironments")
    )
    input_: capo_appconfig.types.list_environments_request.ListEnvironmentsRequest = {
        "application_id": application_id
    }
    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