describe_loa `async` ¶

describe_loa(
    connection_id: ConnectionId,
    *,
    config_overrides: Optional[AsyncDirectConnectClientConfig] = None,
    provider_name: Optional[ProviderName] = None,
    loa_content_type: Optional[LoaContentType] = None,
) -> Loa

Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

Parameters:

connection_id (ConnectionId) –

The ID of a connection, LAG, or interconnect.
provider_name (Optional[ProviderName], default: None ) –

The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.
loa_content_type (Optional[LoaContentType], default: None ) –

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

Raises:

DirectConnectClientException –

One or more parameters are not valid.
DirectConnectServerException –

A server-side error occurred.
UnknownServiceError –

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

Source code in docs_src/capo_direct_connect/_services/async_direct_connect.py

async def describe_loa(
    self,
    connection_id: "capo_direct_connect.types.connection_id.ConnectionId",
    *,
    config_overrides: Optional[AsyncDirectConnectClientConfig] = None,
    provider_name: Optional[
        "capo_direct_connect.types.provider_name.ProviderName"
    ] = None,
    loa_content_type: Optional[
        "capo_direct_connect.types.loa_content_type.LoaContentType"
    ] = None,
) -> "capo_direct_connect.types.loa.Loa":
    """<p>Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see <a href="https://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html">Requesting Cross Connects at Direct Connect Locations</a> in the <i>Direct Connect User Guide</i>.</p>

    Args:
        connection_id: <p>The ID of a connection, LAG, or interconnect.</p>
        provider_name: <p>The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.</p>
        loa_content_type: <p>The standard media type for the LOA-CFA document. The only supported value is application/pdf.</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_loa_request.DescribeLoaRequest]",
    ) -> AsyncOperationResponse["capo_direct_connect.types.loa.Loa"]:
        import capo_direct_connect._operations.overture_service.describe_loa

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeLoa")
    )
    input_: capo_direct_connect.types.describe_loa_request.DescribeLoaRequest = {
        "connection_id": connection_id
    }
    if provider_name is not None:
        input_["provider_name"] = provider_name
    if loa_content_type is not None:
        input_["loa_content_type"] = loa_content_type

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

describe_loa async ¶

describe_loa `async` ¶