Skip to content

describe_vpc_connection

describe_vpc_connection(
    aws_account_id: AwsAccountId,
    vpc_connection_id: VPCConnectionResourceIdUnrestricted,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> DescribeVPCConnectionResponse

Describes a VPC connection.

Parameters:

  • aws_account_id (AwsAccountId) –

    The Amazon Web Services account ID of the account that contains the VPC connection that you want described.

  • vpc_connection_id (VPCConnectionResourceIdUnrestricted) –

    The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

Raises:

  • AccessDeniedException –

    You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

  • InternalFailureException –

    An internal failure occurred.

  • InvalidParameterValueException –

    One or more parameters has a value that isn't valid.

  • ResourceNotFoundException –

    One or more resources can't be found.

  • ThrottlingException –

    Access is throttled.

  • UnsupportedUserEditionException –

    This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

  • UnknownServiceError –

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

Source code in docs_src/capo_quicksight/_services/quick_sight.py
def describe_vpc_connection(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    vpc_connection_id: "capo_quicksight.types.vpc_connection_resource_id_unrestricted.VPCConnectionResourceIdUnrestricted",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
) -> "capo_quicksight.types.describe_vpc_connection_response.DescribeVPCConnectionResponse":
    """<p>Describes a VPC connection.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID of the account that contains the VPC connection that you want described.</p>
        vpc_connection_id: <p>The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.</p>

    Raises:
        capo_quicksight.errors.access_denied_exception.AccessDeniedException: <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
        capo_quicksight.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_quicksight.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameters has a value that isn't valid.</p>
        capo_quicksight.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_quicksight.errors.throttling_exception.ThrottlingException: <p>Access is throttled.</p>
        capo_quicksight.errors.unsupported_user_edition_exception.UnsupportedUserEditionException: <p>This error indicates that you are calling an operation on an Amazon Quick Suite subscription where the edition doesn't include support for that operation. Amazon Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>
        capo_quicksight.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.describe_vpc_connection_request.DescribeVPCConnectionRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.describe_vpc_connection_response.DescribeVPCConnectionResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.describe_vpc_connection

        output, http_response = (
            capo_quicksight._operations.quick_sight_20180401.describe_vpc_connection.describe_vpc_connection(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeVPCConnection")
    )
    input_: capo_quicksight.types.describe_vpc_connection_request.DescribeVPCConnectionRequest = {
        "aws_account_id": aws_account_id,
        "vpc_connection_id": vpc_connection_id,
    }

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