QuickSight / Client / create_vpc_connection

create_vpc_connection#

QuickSight.Client.create_vpc_connection(**kwargs)#

Creates a new VPC connection.

See also: AWS API Documentation

Request Syntax

response = client.create_vpc_connection(
    AwsAccountId='string',
    VPCConnectionId='string',
    Name='string',
    SubnetIds=[
        'string',
    ],
    SecurityGroupIds=[
        'string',
    ],
    DnsResolvers=[
        'string',
    ],
    RoleArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • VPCConnectionId (string) –

    [REQUIRED]

    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 (string) –

    [REQUIRED]

    The display name for the VPC connection.

  • SubnetIds (list) –

    [REQUIRED]

    A list of subnet IDs for the VPC connection.

    • (string) –

  • SecurityGroupIds (list) –

    [REQUIRED]

    A list of security group IDs for the VPC connection.

    • (string) –

  • DnsResolvers (list) –

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

    • (string) –

  • RoleArn (string) –

    [REQUIRED]

    The IAM role to associate with the VPC connection.

  • Tags (list) –

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

    • (dict) –

      The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.

      • Key (string) – [REQUIRED]

        Tag key.

      • Value (string) – [REQUIRED]

        Tag value.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'VPCConnectionId': 'string',
    'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETION_IN_PROGRESS'|'DELETION_FAILED'|'DELETED',
    'AvailabilityStatus': 'AVAILABLE'|'UNAVAILABLE'|'PARTIALLY_AVAILABLE',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the VPC connection.

    • VPCConnectionId (string) –

      The ID for the VPC connection that you’re creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

    • CreationStatus (string) –

      The status of the creation of the VPC connection.

    • AvailabilityStatus (string) –

      The availability status of the VPC connection.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions