Describe Action Connector

quicksight_describe_action_connector

R Documentation

Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status

Description

Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.

Usage

quicksight_describe_action_connector(AwsAccountId, ActionConnectorId)

Arguments

AwsAccountId	[required] The Amazon Web Services account ID that contains the action connector.
ActionConnectorId	[required] The unique identifier of the action connector to describe.

Value

A list with the following syntax:

list(
  ActionConnector = list(
    Arn = "string",
    ActionConnectorId = "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",
    Name = "string",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    Status = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED",
    Error = list(
      Message = "string",
      Type = "INTERNAL_FAILURE"
    ),
    Description = "string",
    AuthenticationConfig = list(
      AuthenticationType = "BASIC"|"API_KEY"|"OAUTH2_CLIENT_CREDENTIALS"|"NONE"|"IAM"|"OAUTH2_AUTHORIZATION_CODE",
      AuthenticationMetadata = list(
        AuthorizationCodeGrantMetadata = list(
          BaseEndpoint = "string",
          RedirectUrl = "string",
          ReadAuthorizationCodeGrantCredentialsDetails = list(
            ReadAuthorizationCodeGrantDetails = list(
              ClientId = "string",
              TokenEndpoint = "string",
              AuthorizationEndpoint = "string"
            )
          ),
          AuthorizationCodeGrantCredentialsSource = "PLAIN_CREDENTIALS"
        ),
        ClientCredentialsGrantMetadata = list(
          BaseEndpoint = "string",
          ReadClientCredentialsDetails = list(
            ReadClientCredentialsGrantDetails = list(
              ClientId = "string",
              TokenEndpoint = "string"
            )
          ),
          ClientCredentialsSource = "PLAIN_CREDENTIALS"
        ),
        BasicAuthConnectionMetadata = list(
          BaseEndpoint = "string",
          Username = "string"
        ),
        ApiKeyConnectionMetadata = list(
          BaseEndpoint = "string",
          Email = "string"
        ),
        NoneConnectionMetadata = list(
          BaseEndpoint = "string"
        ),
        IamConnectionMetadata = list(
          RoleArn = "string",
          SourceArn = "string"
        )
      )
    ),
    EnabledActions = list(
      "string"
    ),
    VpcConnectionArn = "string"
  ),
  RequestId = "string",
  Status = 123
)

Request syntax

svc$describe_action_connector(
  AwsAccountId = "string",
  ActionConnectorId = "string"
)