QuickSight / Client / update_action_connector

update_action_connector

QuickSight.Client.update_action_connector(**kwargs)

Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector’s name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.

See also: AWS API Documentation

Request Syntax

response = client.update_action_connector(
    AwsAccountId='string',
    ActionConnectorId='string',
    Name='string',
    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',
    VpcConnectionArn='string'
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The Amazon Web Services account ID that contains the action connector to update.

• ActionConnectorId (string) –

  [REQUIRED]

  The unique identifier of the action connector to update.

• Name (string) –

  [REQUIRED]

  The new name for the action connector.

• AuthenticationConfig (dict) –

  [REQUIRED]

  The updated authentication configuration for connecting to the external service.

  • 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) – The updated description of the action connector.

• VpcConnectionArn (string) – The updated ARN of the VPC connection to use for secure connectivity.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'ActionConnectorId': 'string',
    'RequestId': 'string',
    'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'Status': 123
}

Response Structure

• (dict) –

  • Arn (string) –

    The Amazon Resource Name (ARN) of the updated action connector.

  • ActionConnectorId (string) –

    The unique identifier of the updated action connector.

  • RequestId (string) –

    The Amazon Web Services request ID for this operation.

  • UpdateStatus (string) –

    The status of the update operation.

  • Status (integer) –

    The HTTP status code of the request.

Exceptions

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.InternalFailureException

• QuickSight.Client.exceptions.ResourceNotFoundException

• QuickSight.Client.exceptions.AccessDeniedException

• QuickSight.Client.exceptions.ConflictException