Skip to content

create_action_connector

create_action_connector(
    aws_account_id: AwsAccountId,
    action_connector_id: ShortRestrictiveResourceId,
    name: ActionConnectorName,
    type: ActionConnectorType,
    authentication_config: AuthConfig,
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    description: Optional[ActionConnectorDescription] = None,
    permissions: Optional[ResourcePermissionList] = None,
    vpc_connection_arn: Optional[Arn] = None,
    tags: Optional[TagList] = None,
) -> CreateActionConnectorResponse

Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.

Parameters:

  • aws_account_id (AwsAccountId) –

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

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

  • name (ActionConnectorName) –

    A descriptive name for the action connector.

  • type (ActionConnectorType) –

    The type of action connector.

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

  • description (Optional[ActionConnectorDescription], default: None ) –

    An optional description of the action connector.

  • permissions (Optional[ResourcePermissionList], default: None ) –

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

  • vpc_connection_arn (Optional[Arn], default: None ) –

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

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

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

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.

  • ResourceExistsException –

    The resource specified already exists.

  • ThrottlingException –

    Access is throttled.

  • 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_action_connector(
    self,
    aws_account_id: "capo_quicksight.types.aws_account_id.AwsAccountId",
    action_connector_id: "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId",
    name: "capo_quicksight.types.action_connector_name.ActionConnectorName",
    type: "capo_quicksight.types.action_connector_type.ActionConnectorType",
    authentication_config: "capo_quicksight.types.auth_config.AuthConfig",
    *,
    config_overrides: Optional[QuickSightClientConfig] = None,
    description: Optional[
        "capo_quicksight.types.action_connector_description.ActionConnectorDescription"
    ] = None,
    permissions: Optional[
        "capo_quicksight.types.resource_permission_list.ResourcePermissionList"
    ] = None,
    vpc_connection_arn: Optional["capo_quicksight.types.arn.Arn"] = None,
    tags: Optional["capo_quicksight.types.tag_list.TagList"] = None,
) -> "capo_quicksight.types.create_action_connector_response.CreateActionConnectorResponse":
    """<p>Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.</p>

    Args:
        aws_account_id: <p>The Amazon Web Services account ID associated with the action connector.</p>
        action_connector_id: <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: <p>A descriptive name for the action connector.</p>
        type: <p>The type of action connector.</p>
        authentication_config: <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: <p>An optional description of the action connector.</p>
        permissions: <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: <p>The ARN of the VPC connection to use for secure connectivity to the external service.</p>
        tags: <p>A list of tags to apply to the action connector for resource management and organization.</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.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.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_quicksight.types.create_action_connector_request.CreateActionConnectorRequest]",
    ) -> OperationResponse[
        "capo_quicksight.types.create_action_connector_response.CreateActionConnectorResponse"
    ]:
        import capo_quicksight._operations.quick_sight_20180401.create_action_connector

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

    def _redact_input(
        input_: "capo_quicksight.types.create_action_connector_request.CreateActionConnectorRequest",
    ) -> dict[str, Any]:
        import capo_quicksight.types.create_action_connector_request

        return (
            capo_quicksight.types.create_action_connector_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateActionConnector", redact_input=_redact_input),
    )
    input_: capo_quicksight.types.create_action_connector_request.CreateActionConnectorRequest = {
        "aws_account_id": aws_account_id,
        "action_connector_id": action_connector_id,
        "name": name,
        "type": type,
        "authentication_config": authentication_config,
    }
    if description is not None:
        input_["description"] = description
    if permissions is not None:
        input_["permissions"] = permissions
    if vpc_connection_arn is not None:
        input_["vpc_connection_arn"] = vpc_connection_arn
    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