list_environment_account_connections ¶

list_environment_account_connections(
    requested_by: EnvironmentAccountConnectionRequesterAccountType,
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    environment_name: Optional[ResourceName] = None,
    statuses: Optional[EnvironmentAccountConnectionStatusList] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxPageResults] = None,
) -> ListEnvironmentAccountConnectionsOutput

View a list of environment account connections.

For more information, see Environment account connections in the Proton User guide.

Parameters:

requested_by (EnvironmentAccountConnectionRequesterAccountType) –

The type of account making the ListEnvironmentAccountConnections request.
environment_name (Optional[ResourceName], default: None ) –

The environment name that's associated with each listed environment account connection.
statuses (Optional[EnvironmentAccountConnectionStatusList], default: None ) –

The status details for each listed environment account connection.
next_token (Optional[NextToken], default: None ) –

A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.
max_results (Optional[MaxPageResults], default: None ) –

The maximum number of environment account connections to list.

Raises:

AccessDeniedException –

There isn't sufficient access for performing this action.
InternalServerException –

The request failed to register with the service.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input is invalid or an out-of-range value was supplied for the input parameter.
UnknownServiceError –

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

Source code in docs_src/capo_proton/_services/proton.py

def list_environment_account_connections(
    self,
    requested_by: "capo_proton.types.environment_account_connection_requester_account_type.EnvironmentAccountConnectionRequesterAccountType",
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    environment_name: Optional[
        "capo_proton.types.resource_name.ResourceName"
    ] = None,
    statuses: Optional[
        "capo_proton.types.environment_account_connection_status_list.EnvironmentAccountConnectionStatusList"
    ] = None,
    next_token: Optional["capo_proton.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_proton.types.max_page_results.MaxPageResults"
    ] = None,
) -> "capo_proton.types.list_environment_account_connections_output.ListEnvironmentAccountConnectionsOutput":
    """<p>View a list of environment account connections.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton User guide</i>.</p>

    Args:
        requested_by: <p>The type of account making the <code>ListEnvironmentAccountConnections</code> request.</p>
        environment_name: <p>The environment name that's associated with each listed environment account connection.</p>
        statuses: <p>The status details for each listed environment account connection.</p>
        next_token: <p>A token that indicates the location of the next environment account connection in the array of environment account connections, after the list of environment account connections that was previously requested.</p>
        max_results: <p>The maximum number of environment account connections to list.</p>

    Raises:
        capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
        capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
        capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
        capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_proton.types.list_environment_account_connections_input.ListEnvironmentAccountConnectionsInput]",
    ) -> OperationResponse[
        "capo_proton.types.list_environment_account_connections_output.ListEnvironmentAccountConnectionsOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.list_environment_account_connections

        output, http_response = (
            capo_proton._operations.aws_proton20200720.list_environment_account_connections.list_environment_account_connections(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEnvironmentAccountConnections")
    )
    input_: capo_proton.types.list_environment_account_connections_input.ListEnvironmentAccountConnectionsInput = {
        "requested_by": requested_by
    }
    if environment_name is not None:
        input_["environment_name"] = environment_name
    if statuses is not None:
        input_["statuses"] = statuses
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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