Skip to content

describe_direct_connect_gateway_association_proposals async

describe_direct_connect_gateway_association_proposals(
    *,
    config_overrides: Optional[AsyncDirectConnectClientConfig] = None,
    direct_connect_gateway_id: Optional[DirectConnectGatewayId] = None,
    proposal_id: Optional[DirectConnectGatewayAssociationProposalId] = None,
    associated_gateway_id: Optional[AssociatedGatewayId] = None,
    max_results: Optional[MaxResultSetSize] = None,
    next_token: Optional[PaginationToken] = None,
) -> DescribeDirectConnectGatewayAssociationProposalsResult

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

Parameters:

Raises:

Source code in docs_src/capo_direct_connect/_services/async_direct_connect.py
async def describe_direct_connect_gateway_association_proposals(
    self,
    *,
    config_overrides: Optional[AsyncDirectConnectClientConfig] = None,
    direct_connect_gateway_id: Optional[
        "capo_direct_connect.types.direct_connect_gateway_id.DirectConnectGatewayId"
    ] = None,
    proposal_id: Optional[
        "capo_direct_connect.types.direct_connect_gateway_association_proposal_id.DirectConnectGatewayAssociationProposalId"
    ] = None,
    associated_gateway_id: Optional[
        "capo_direct_connect.types.associated_gateway_id.AssociatedGatewayId"
    ] = None,
    max_results: Optional[
        "capo_direct_connect.types.max_result_set_size.MaxResultSetSize"
    ] = None,
    next_token: Optional[
        "capo_direct_connect.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_direct_connect.types.describe_direct_connect_gateway_association_proposals_result.DescribeDirectConnectGatewayAssociationProposalsResult":
    """<p>Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway. </p>

    Args:
        direct_connect_gateway_id: <p>The ID of the Direct Connect gateway.</p>
        proposal_id: <p>The ID of the proposal.</p>
        associated_gateway_id: <p>The ID of the associated gateway.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p> <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are returned.</p>
        next_token: <p>The token for the next page of results.</p>

    Raises:
        capo_direct_connect.errors.direct_connect_client_exception.DirectConnectClientException: <p>One or more parameters are not valid.</p>
        capo_direct_connect.errors.direct_connect_server_exception.DirectConnectServerException: <p>A server-side error occurred.</p>
        capo_direct_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_direct_connect.types.describe_direct_connect_gateway_association_proposals_request.DescribeDirectConnectGatewayAssociationProposalsRequest]",
    ) -> AsyncOperationResponse[
        "capo_direct_connect.types.describe_direct_connect_gateway_association_proposals_result.DescribeDirectConnectGatewayAssociationProposalsResult"
    ]:
        import capo_direct_connect._operations.overture_service.describe_direct_connect_gateway_association_proposals

        (
            output,
            http_response,
        ) = await capo_direct_connect._operations.overture_service.describe_direct_connect_gateway_association_proposals.async_describe_direct_connect_gateway_association_proposals(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeDirectConnectGatewayAssociationProposals"),
    )
    input_: capo_direct_connect.types.describe_direct_connect_gateway_association_proposals_request.DescribeDirectConnectGatewayAssociationProposalsRequest = {}
    if direct_connect_gateway_id is not None:
        input_["direct_connect_gateway_id"] = direct_connect_gateway_id
    if proposal_id is not None:
        input_["proposal_id"] = proposal_id
    if associated_gateway_id is not None:
        input_["associated_gateway_id"] = associated_gateway_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