Update Action Connector

quicksight_update_action_connector

R Documentation

Updates an existing action connector with new configuration details, authentication settings, or enabled actions

Description

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.

Usage

quicksight_update_action_connector(AwsAccountId, ActionConnectorId,
  Name, AuthenticationConfig, Description, VpcConnectionArn)

Arguments

AwsAccountId	[required] The Amazon Web Services account ID that contains the action connector to update.
ActionConnectorId	[required] The unique identifier of the action connector to update.
Name	[required] The new name for the action connector.
AuthenticationConfig	[required] The updated authentication configuration for connecting to the external service.
Description	The updated description of the action connector.
VpcConnectionArn	The updated ARN of the VPC connection to use for secure connectivity.

Value

A list with the following syntax:

list(
  Arn = "string",
  ActionConnectorId = "string",
  RequestId = "string",
  UpdateStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED",
  Status = 123
)

Request syntax

svc$update_action_connector(
  AwsAccountId = "string",
  ActionConnectorId = "string",
  Name = "string",
  AuthenticationConfig = list(
    AuthenticationType = "BASIC"|"API_KEY"|"OAUTH2_CLIENT_CREDENTIALS"|"NONE"|"IAM"|"OAUTH2_AUTHORIZATION_CODE",
    AuthenticationMetadata = list(
      AuthorizationCodeGrantMetadata = list(
        BaseEndpoint = "string",
        RedirectUrl = "string",
        AuthorizationCodeGrantCredentialsSource = "PLAIN_CREDENTIALS",
        AuthorizationCodeGrantCredentialsDetails = list(
          AuthorizationCodeGrantDetails = list(
            ClientId = "string",
            ClientSecret = "string",
            TokenEndpoint = "string",
            AuthorizationEndpoint = "string"
          )
        )
      ),
      ClientCredentialsGrantMetadata = list(
        BaseEndpoint = "string",
        ClientCredentialsSource = "PLAIN_CREDENTIALS",
        ClientCredentialsDetails = list(
          ClientCredentialsGrantDetails = list(
            ClientId = "string",
            ClientSecret = "string",
            TokenEndpoint = "string"
          )
        )
      ),
      BasicAuthConnectionMetadata = list(
        BaseEndpoint = "string",
        Username = "string",
        Password = "string"
      ),
      ApiKeyConnectionMetadata = list(
        BaseEndpoint = "string",
        ApiKey = "string",
        Email = "string"
      ),
      NoneConnectionMetadata = list(
        BaseEndpoint = "string"
      ),
      IamConnectionMetadata = list(
        RoleArn = "string"
      )
    )
  ),
  Description = "string",
  VpcConnectionArn = "string"
)