Skip to content

CreateActionConnectorRequest

Source code in docs_src/capo_quicksight/types/create_action_connector_request.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class CreateActionConnectorRequest(TypedDict, closed=True):
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId"
    """<p>The Amazon Web Services account ID associated with the action connector.</p>"""
    action_connector_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>A unique identifier for the action connector. This ID must be unique within the Amazon Web Services account. The <code>ActionConnectorId</code> must not start with the prefix <code>quicksuite-</code> </p>"""
    name: "capo_quicksight.types.action_connector_name.ActionConnectorName"
    """<p>A descriptive name for the action connector.</p>"""
    type: "capo_quicksight.types.action_connector_type.ActionConnectorType"
    """<p>The type of action connector.</p>"""
    authentication_config: "capo_quicksight.types.auth_config.AuthConfig"
    """<p>The authentication configuration for connecting to the external service. This includes the authentication type, base URL, and authentication metadata such as client credentials or API keys.</p>"""
    description: NotRequired[
        "capo_quicksight.types.action_connector_description.ActionConnectorDescription"
    ]
    """<p>An optional description of the action connector.</p>"""
    permissions: NotRequired[
        "capo_quicksight.types.resource_permission_list.ResourcePermissionList"
    ]
    """<p>The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.</p>"""
    vpc_connection_arn: NotRequired["capo_quicksight.types.arn.Arn"]
    """<p>The ARN of the VPC connection to use for secure connectivity to the external service.</p>"""
    tags: NotRequired["capo_quicksight.types.tag_list.TagList"]
    """<p>A list of tags to apply to the action connector for resource management and organization.</p>"""

action_connector_id instance-attribute 

action_connector_id: ShortRestrictiveResourceId

A unique identifier for the action connector. This ID must be unique within the Amazon Web Services account. The ActionConnectorId must not start with the prefix quicksuite-

authentication_config instance-attribute 

authentication_config: AuthConfig

The authentication configuration for connecting to the external service. This includes the authentication type, base URL, and authentication metadata such as client credentials or API keys.

aws_account_id instance-attribute 

aws_account_id: AwsAccountId

The Amazon Web Services account ID associated with the action connector.

description instance-attribute 

description: NotRequired[ActionConnectorDescription]

An optional description of the action connector.

name instance-attribute 

name: ActionConnectorName

A descriptive name for the action connector.

permissions instance-attribute 

permissions: NotRequired[ResourcePermissionList]

The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.

tags instance-attribute 

tags: NotRequired[TagList]

A list of tags to apply to the action connector for resource management and organization.

type instance-attribute 

type: ActionConnectorType

The type of action connector.

vpc_connection_arn instance-attribute 

vpc_connection_arn: NotRequired[Arn]

The ARN of the VPC connection to use for secure connectivity to the external service.