Skip to content

list_attach_points async

list_attach_points(
    environment_id: EnvironmentId,
    *,
    config_overrides: Optional[AsyncInterconnectClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListAttachPointsResponse

Lists all Attach Points the caller has access to that are valid for the specified Environment.

Parameters:

  • environment_id (EnvironmentId) –

    The identifier of the Environment for which to list valid Attach Points.

  • max_results (Optional[MaxResults], default: None ) –

    The max number of list results in a single paginated response.

  • next_token (Optional[NextToken], default: None ) –

    A pagination token from a previous paginated response indicating you wish to get the next page.

Raises:

Examples:

List Attach Points

>>> await client.list_attach_points(environment_id='mce-aws-acme-1')
Source code in docs_src/capo_interconnect/_services/async_interconnect.py
async def list_attach_points(
    self,
    environment_id: "capo_interconnect.types.environment_id.EnvironmentId",
    *,
    config_overrides: Optional[AsyncInterconnectClientConfig] = None,
    max_results: Optional["capo_interconnect.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_interconnect.types.next_token.NextToken"] = None,
) -> "capo_interconnect.types.list_attach_points_response.ListAttachPointsResponse":
    """<p>Lists all Attach Points the caller has access to that are valid for the specified <a>Environment</a>.</p>

    Args:
        environment_id: <p>The identifier of the <a>Environment</a> for which to list valid Attach Points.</p>
        max_results: <p>The max number of list results in a single paginated response.</p>
        next_token: <p>A pagination token from a previous paginated response indicating you wish to get the next page.</p>

    Raises:
        capo_interconnect.errors.access_denied_exception.AccessDeniedException: <p>The calling principal is not allowed to access the specified resource, or the resource does not exist.</p>
        capo_interconnect.errors.interconnect_client_exception.InterconnectClientException: <p>The request was denied due to incorrect client supplied parameters.</p>
        capo_interconnect.errors.interconnect_server_exception.InterconnectServerException: <p>The request resulted in an exception internal to the service.</p>
        capo_interconnect.errors.interconnect_validation_exception.InterconnectValidationException: <p>The input fails to satisfy the constraints specified.</p>
        capo_interconnect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request specifies a resource that does not exist on the server.</p>
        capo_interconnect.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The requested operation would result in the calling principal exceeding their allotted quota.</p>
        capo_interconnect.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_interconnect.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List Attach Points

        >>> await client.list_attach_points(environment_id='mce-aws-acme-1')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_interconnect.types.list_attach_points_request.ListAttachPointsRequest]",
    ) -> AsyncOperationResponse[
        "capo_interconnect.types.list_attach_points_response.ListAttachPointsResponse"
    ]:
        import capo_interconnect._operations.interconnect.list_attach_points

        (
            output,
            http_response,
        ) = await capo_interconnect._operations.interconnect.list_attach_points.async_list_attach_points(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAttachPoints")
    )
    input_: capo_interconnect.types.list_attach_points_request.ListAttachPointsRequest = {
        "environment_id": environment_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output