Skip to content

create_vpc_connection

create_vpc_connection(
    aws_account_id: AwsAccountId,
    vpc_connection_id: VPCConnectionResourceIdRestricted,
    name: ResourceName,
    subnet_ids: SubnetIdList,
    security_group_ids: SecurityGroupIdList,
    role_arn: RoleArn,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    dns_resolvers: Optional[DnsResolverList] = None,
    tags: Optional[TagList] = None,
) -> CreateVPCConnectionResponse

Creates a new VPC connection.

Parameters:

  • aws_account_id (AwsAccountId) –

    The Amazon Web Services account ID of the account where you want to create a new VPC connection.

  • vpc_connection_id (VPCConnectionResourceIdRestricted) –

    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.

  • name (ResourceName) –

    The display name for the VPC connection.

  • subnet_ids (SubnetIdList) –

    A list of subnet IDs for the VPC connection.

  • security_group_ids (SecurityGroupIdList) –

    A list of security group IDs for the VPC connection.

  • dns_resolvers (Optional[DnsResolverList], default: None ) –

    A list of IP addresses of DNS resolver endpoints for the VPC connection.

  • role_arn (RoleArn) –

    The IAM role to associate with the VPC connection.

  • tags (Optional[TagList], default: None ) –

    A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.

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.

  • ConflictException –

    Updating or deleting a resource can cause an inconsistent state.

  • InternalFailureException –

    An internal failure occurred.

  • InvalidParameterValueException –

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

  • LimitExceededException –

    A limit is exceeded.

  • ResourceExistsException –

    The resource specified already exists.

  • 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 create_vpc_connection(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    vpc_connection_id: "capo_quicksight.types.vpc_connection_resource_id_restricted.VPCConnectionResourceIdRestricted",
    name: "capo_quicksight.types.resource_name.ResourceName",
    subnet_ids: "capo_quicksight.types.subnet_id_list.SubnetIdList",
    security_group_ids: "capo_quicksight.types.security_group_id_list.SecurityGroupIdList",
    role_arn: "capo_quicksight.types.role_arn.RoleArn",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    dns_resolvers: Optional[
        "capo_quicksight.types.dns_resolver_list.DnsResolverList"
    ] = None,
    tags: Optional["capo_quicksight.types.tag_list.TagList"] = None,
) -> "capo_quicksight.types.create_vpc_connection_response.CreateVPCConnectionResponse":
    """<p>Creates a new VPC connection.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID of the account where you want to create a new VPC connection.</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>
        name: <p>The display name for the VPC connection.</p>
        subnet_ids: <p>A list of subnet IDs for the VPC connection.</p>
        security_group_ids: <p>A list of security group IDs for the VPC connection.</p>
        dns_resolvers: <p>A list of IP addresses of DNS resolver endpoints for the VPC connection.</p>
        role_arn: <p>The IAM role to associate with the VPC connection.</p>
        tags: <p>A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.</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.conflict_exception.ConflictException: <p>Updating or deleting a resource can cause an inconsistent state.</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.limit_exceeded_exception.LimitExceededException: <p>A limit is exceeded.</p>
        capo_quicksight.errors.resource_exists_exception.ResourceExistsException: <p>The resource specified already exists. </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.create_vpc_connection_request.CreateVPCConnectionRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.create_vpc_connection_response.CreateVPCConnectionResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.create_vpc_connection

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateVPCConnection")
    )
    input_: capo_quicksight.types.create_vpc_connection_request.CreateVPCConnectionRequest = {
        "aws_account_id": aws_account_id,
        "vpc_connection_id": vpc_connection_id,
        "name": name,
        "subnet_ids": subnet_ids,
        "security_group_ids": security_group_ids,
        "role_arn": role_arn,
    }
    if dns_resolvers is not None:
        input_["dns_resolvers"] = dns_resolvers
    if tags is not None:
        input_["tags"] = tags

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