createActionConnector method

Future<CreateActionConnectorResponse> createActionConnector({ required String actionConnectorId, required AuthConfig authenticationConfig, required String awsAccountId, required String name, required ActionConnectorType type, String? description, List<ResourcePermission>? permissions, List<Tag>? tags, String? vpcConnectionArn, })

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.

May throw AccessDeniedException. May throw ConflictException. May throw InternalFailureException. May throw InvalidParameterValueException. May throw ResourceExistsException. May throw ThrottlingException.

Parameter actionConnectorId : 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-

Parameter authenticationConfig : 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.

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

Parameter name : A descriptive name for the action connector.

Parameter type : The type of action connector.

Parameter description : An optional description of the action connector.

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

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

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

Implementation

Future<CreateActionConnectorResponse> createActionConnector({
  required String actionConnectorId,
  required AuthConfig authenticationConfig,
  required String awsAccountId,
  required String name,
  required ActionConnectorType type,
  String? description,
  List<ResourcePermission>? permissions,
  List<Tag>? tags,
  String? vpcConnectionArn,
}) async {
  final $payload = <String, dynamic>{
    'ActionConnectorId': actionConnectorId,
    'AuthenticationConfig': authenticationConfig,
    'Name': name,
    'Type': type.value,
    if (description != null) 'Description': description,
    if (permissions != null) 'Permissions': permissions,
    if (tags != null) 'Tags': tags,
    if (vpcConnectionArn != null) 'VpcConnectionArn': vpcConnectionArn,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/accounts/${Uri.encodeComponent(awsAccountId)}/action-connectors',
    exceptionFnMap: _exceptionFns,
  );
  return CreateActionConnectorResponse.fromJson(response);
}