describe_web_app `async` ¶

describe_web_app(
    web_app_id: WebAppId,
    *,
    config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> DescribeWebAppResponse

Describes the web app that's identified by WebAppId. The response includes endpoint configuration details such as whether the web app is publicly accessible or VPC hosted.

For more information about using VPC endpoints with Transfer Family, see Create a Transfer Family web app in a VPC.

Parameters:

web_app_id (WebAppId) –

Provide the unique identifier for the web app.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServiceError –

This exception is thrown when an error occurs in the Transfer Family service.
InvalidRequestException –

This exception is thrown when the client submits a malformed request.
ResourceNotFoundException –

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ThrottlingException –

The request was denied due to request throttling.
UnknownServiceError –

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

Source code in docs_src/capo_transfer/_services/async_transfer.py

async def describe_web_app(
    self,
    web_app_id: "capo_transfer.types.web_app_id.WebAppId",
    *,
    config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> "capo_transfer.types.describe_web_app_response.DescribeWebAppResponse":
    """<p>Describes the web app that's identified by <code>WebAppId</code>. The response includes endpoint configuration details such as whether the web app is publicly accessible or VPC hosted.</p> <p>For more information about using VPC endpoints with Transfer Family, see <a href="https://docs.aws.amazon.com/transfer/latest/userguide/create-webapp-in-vpc.html">Create a Transfer Family web app in a VPC</a>.</p>

    Args:
        web_app_id: <p>Provide the unique identifier for the web app.</p>

    Raises:
        capo_transfer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_transfer.types.describe_web_app_request.DescribeWebAppRequest]",
    ) -> AsyncOperationResponse[
        "capo_transfer.types.describe_web_app_response.DescribeWebAppResponse"
    ]:
        import capo_transfer._operations.transfer_service.describe_web_app

        (
            output,
            http_response,
        ) = await capo_transfer._operations.transfer_service.describe_web_app.async_describe_web_app(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeWebApp")
    )
    input_: capo_transfer.types.describe_web_app_request.DescribeWebAppRequest = {
        "web_app_id": web_app_id
    }

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

describe_web_app async ¶

describe_web_app `async` ¶