QuickSight / Client / describe_vpc_connection

describe_vpc_connection#

QuickSight.Client.describe_vpc_connection(**kwargs)#

Describes a VPC connection.

See also: AWS API Documentation

Request Syntax

response = client.describe_vpc_connection(
    AwsAccountId='string',
    VPCConnectionId='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'VPCConnection': {
        'VPCConnectionId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'VPCId': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'DnsResolvers': [
            'string',
        ],
        'Status': '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',
        'NetworkInterfaces': [
            {
                'SubnetId': 'string',
                'AvailabilityZone': 'string',
                'ErrorMessage': 'string',
                'Status': 'CREATING'|'AVAILABLE'|'CREATION_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETED'|'DELETION_FAILED'|'DELETION_SCHEDULED'|'ATTACHMENT_FAILED_ROLLBACK_FAILED',
                'NetworkInterfaceId': 'string'
            },
        ],
        'RoleArn': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1)
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • VPCConnection (dict) –

      A response object that provides information for the specified VPC connection.

      • VPCConnectionId (string) –

        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.

      • Arn (string) –

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

      • Name (string) –

        The display name for the VPC connection.

      • VPCId (string) –

        The Amazon EC2 VPC ID associated with the VPC connection.

      • SecurityGroupIds (list) –

        The Amazon EC2 security group IDs associated with the VPC connection.

        • (string) –

      • DnsResolvers (list) –

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

        • (string) –

      • Status (string) –

        The status of the VPC connection.

      • AvailabilityStatus (string) –

        The availability status of the VPC connection.

      • NetworkInterfaces (list) –

        A list of network interfaces.

        • (dict) –

          The structure that contains information about a network interface.

          • SubnetId (string) –

            The subnet ID associated with the network interface.

          • AvailabilityZone (string) –

            The availability zone that the network interface resides in.

          • ErrorMessage (string) –

            An error message.

          • Status (string) –

            The status of the network interface.

          • NetworkInterfaceId (string) –

            The network interface ID.

      • RoleArn (string) –

        The ARN of the IAM role associated with the VPC connection.

      • CreatedTime (datetime) –

        The time that the VPC connection was created.

      • LastUpdatedTime (datetime) –

        The time that the VPC connection was last updated.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions