QuickSight / Client / create_action_connector

create_action_connector¶

QuickSight.Client.create_action_connector(**kwargs)¶

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.

Request Syntax

response = client.create_action_connector(
    AwsAccountId='string',
    ActionConnectorId='string',
    Name='string',
    Type='GENERIC_HTTP'|'SERVICENOW_NOW_PLATFORM'|'SALESFORCE_CRM'|'MICROSOFT_OUTLOOK'|'PAGERDUTY_ADVANCE'|'JIRA_CLOUD'|'ATLASSIAN_CONFLUENCE'|'AMAZON_S3'|'AMAZON_BEDROCK_AGENT_RUNTIME'|'AMAZON_BEDROCK_RUNTIME'|'AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME'|'AMAZON_TEXTRACT'|'AMAZON_COMPREHEND'|'AMAZON_COMPREHEND_MEDICAL'|'MICROSOFT_ONEDRIVE'|'MICROSOFT_SHAREPOINT'|'MICROSOFT_TEAMS'|'SAP_BUSINESSPARTNER'|'SAP_PRODUCTMASTERDATA'|'SAP_PHYSICALINVENTORY'|'SAP_BILLOFMATERIALS'|'SAP_MATERIALSTOCK'|'ZENDESK_SUITE'|'SMARTSHEET'|'SLACK'|'ASANA'|'BAMBOO_HR',
    AuthenticationConfig={
        'AuthenticationType': 'BASIC'|'API_KEY'|'OAUTH2_CLIENT_CREDENTIALS'|'NONE'|'IAM'|'OAUTH2_AUTHORIZATION_CODE',
        'AuthenticationMetadata': {
            'AuthorizationCodeGrantMetadata': {
                'BaseEndpoint': 'string',
                'RedirectUrl': 'string',
                'AuthorizationCodeGrantCredentialsSource': 'PLAIN_CREDENTIALS',
                'AuthorizationCodeGrantCredentialsDetails': {
                    'AuthorizationCodeGrantDetails': {
                        'ClientId': 'string',
                        'ClientSecret': 'string',
                        'TokenEndpoint': 'string',
                        'AuthorizationEndpoint': 'string'
                    }
                }
            },
            'ClientCredentialsGrantMetadata': {
                'BaseEndpoint': 'string',
                'ClientCredentialsSource': 'PLAIN_CREDENTIALS',
                'ClientCredentialsDetails': {
                    'ClientCredentialsGrantDetails': {
                        'ClientId': 'string',
                        'ClientSecret': 'string',
                        'TokenEndpoint': 'string'
                    }
                }
            },
            'BasicAuthConnectionMetadata': {
                'BaseEndpoint': 'string',
                'Username': 'string',
                'Password': 'string'
            },
            'ApiKeyConnectionMetadata': {
                'BaseEndpoint': 'string',
                'ApiKey': 'string',
                'Email': 'string'
            },
            'NoneConnectionMetadata': {
                'BaseEndpoint': 'string'
            },
            'IamConnectionMetadata': {
                'RoleArn': 'string'
            }
        }
    },
    Description='string',
    Permissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    VpcConnectionArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The Amazon Web Services account ID associated with the action connector.
ActionConnectorId (string) –
[REQUIRED]

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

A descriptive name for the action connector.
Type (string) –
[REQUIRED]

The type of action connector.
AuthenticationConfig (dict) –
[REQUIRED]

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.
- AuthenticationType (string) – [REQUIRED]
  
  The type of authentication method.
- AuthenticationMetadata (dict) – [REQUIRED]
  
  The authentication metadata containing the specific configuration for the chosen authentication type.
  
  Note
  This is a Tagged Union structure. Only one of the following top level keys can be set: AuthorizationCodeGrantMetadata, ClientCredentialsGrantMetadata, BasicAuthConnectionMetadata, ApiKeyConnectionMetadata, NoneConnectionMetadata, IamConnectionMetadata.
  - AuthorizationCodeGrantMetadata (dict) –
    
    OAuth 2.0 authorization code grant authentication metadata.
    - BaseEndpoint (string) – [REQUIRED]
      
      The base URL endpoint for the external service.
    - RedirectUrl (string) – [REQUIRED]
      
      The redirect URL for the OAuth authorization flow.
    - AuthorizationCodeGrantCredentialsSource (string) –
      
      The source of the authorization code grant credentials.
    - AuthorizationCodeGrantCredentialsDetails (dict) –
      
      The detailed credentials configuration for authorization code grant.
      
      Note
      This is a Tagged Union structure. Only one of the following top level keys can be set: AuthorizationCodeGrantDetails.
      - AuthorizationCodeGrantDetails (dict) –
        
        The authorization code grant configuration details.
        
        ClientId (string) – [REQUIRED]
        
        The client ID for the OAuth application.
        
        ClientSecret (string) – [REQUIRED]
        
        The client secret for the OAuth application.
        
        TokenEndpoint (string) – [REQUIRED]
        
        The token endpoint URL for obtaining access tokens.
        
        AuthorizationEndpoint (string) – [REQUIRED]
        
        The authorization endpoint URL for the OAuth flow.
  - ClientCredentialsGrantMetadata (dict) –
    
    OAuth 2.0 client credentials grant authentication metadata.
    - BaseEndpoint (string) – [REQUIRED]
      
      The base endpoint URL for the external service.
    - ClientCredentialsSource (string) –
      
      The source of the client credentials configuration.
    - ClientCredentialsDetails (dict) –
      
      The detailed client credentials configuration including client ID, client secret, and token endpoint.
      
      Note
      This is a Tagged Union structure. Only one of the following top level keys can be set: ClientCredentialsGrantDetails.
      - ClientCredentialsGrantDetails (dict) –
        
        The OAuth2 client credentials grant configuration details for authentication.
        
        ClientId (string) – [REQUIRED]
        
        The client identifier issued to the client during the registration process with the authorization server.
        
        ClientSecret (string) – [REQUIRED]
        
        The client secret issued to the client during the registration process with the authorization server.
        
        TokenEndpoint (string) – [REQUIRED]
        
        The authorization server endpoint used to obtain access tokens via the client credentials grant flow.
  - BasicAuthConnectionMetadata (dict) –
    
    Basic authentication metadata using username and password.
    - BaseEndpoint (string) – [REQUIRED]
      
      The base URL endpoint for the external service.
    - Username (string) – [REQUIRED]
      
      The username for basic authentication.
    - Password (string) – [REQUIRED]
      
      The password for basic authentication.
  - ApiKeyConnectionMetadata (dict) –
    
    API key authentication metadata.
    - BaseEndpoint (string) – [REQUIRED]
      
      The base URL endpoint for the external service.
    - ApiKey (string) – [REQUIRED]
      
      The API key used for authentication.
    - Email (string) –
      
      The email address associated with the API key, if required.
  - NoneConnectionMetadata (dict) –
    
    No authentication metadata for services that don’t require authentication.
    - BaseEndpoint (string) – [REQUIRED]
      
      The base endpoint URL for connections that do not require authentication.
  - IamConnectionMetadata (dict) –
    
    IAM role-based authentication metadata for Amazon Web Services services.
    - RoleArn (string) – [REQUIRED]
      
      The Amazon Resource Name (ARN) of the IAM role to assume for authentication with Amazon Web Services services. This IAM role should be in the same account as Quick Sight.
Description (string) – An optional description of the action connector.
Permissions (list) –
The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.
- (dict) –
  
  Permission for the resource.
  - Principal (string) – [REQUIRED]
    
    The Amazon Resource Name (ARN) of the principal. This can be one of the following:
    - The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
    - The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
    - The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
  - Actions (list) – [REQUIRED]
    
    The IAM action to grant or revoke permissions on.
    - (string) –
VpcConnectionArn (string) – The ARN of the VPC connection to use for secure connectivity to the external service.
Tags (list) –
A list of tags to apply to the action connector for resource management and organization.
- (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',
    'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'ActionConnectorId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) –
- Arn (string) –
  
  The Amazon Resource Name (ARN) of the created action connector.
- CreationStatus (string) –
  
  The creation status of the action connector.
- ActionConnectorId (string) –
  
  The unique identifier of the created action connector.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.
- Status (integer) –
  
  The HTTP status code of the request.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.ResourceExistsException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.AccessDeniedException
QuickSight.Client.exceptions.ConflictException