:doc:`QuickSight <../../quicksight>` / Client / describe_action_connector

*************************
describe_action_connector
*************************



.. py:method:: QuickSight.Client.describe_action_connector(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeActionConnector>`_  


  **Request Syntax**
  ::

    response = client.describe_action_connector(
        AwsAccountId='string',
        ActionConnectorId='string'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

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

    

  
  :type ActionConnectorId: string
  :param ActionConnectorId: **[REQUIRED]** 

    The unique identifier of the action connector to describe.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ActionConnector': {
              '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': datetime(2015, 1, 1),
              'LastUpdatedTime': datetime(2015, 1, 1),
              'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
              'Error': {
                  'Message': 'string',
                  'Type': 'INTERNAL_FAILURE'
              },
              'Description': 'string',
              'AuthenticationConfig': {
                  'AuthenticationType': 'BASIC'|'API_KEY'|'OAUTH2_CLIENT_CREDENTIALS'|'NONE'|'IAM'|'OAUTH2_AUTHORIZATION_CODE',
                  'AuthenticationMetadata': {
                      'AuthorizationCodeGrantMetadata': {
                          'BaseEndpoint': 'string',
                          'RedirectUrl': 'string',
                          'ReadAuthorizationCodeGrantCredentialsDetails': {
                              'ReadAuthorizationCodeGrantDetails': {
                                  'ClientId': 'string',
                                  'TokenEndpoint': 'string',
                                  'AuthorizationEndpoint': 'string'
                              }
                          },
                          'AuthorizationCodeGrantCredentialsSource': 'PLAIN_CREDENTIALS'
                      },
                      'ClientCredentialsGrantMetadata': {
                          'BaseEndpoint': 'string',
                          'ReadClientCredentialsDetails': {
                              'ReadClientCredentialsGrantDetails': {
                                  'ClientId': 'string',
                                  'TokenEndpoint': 'string'
                              }
                          },
                          'ClientCredentialsSource': 'PLAIN_CREDENTIALS'
                      },
                      'BasicAuthConnectionMetadata': {
                          'BaseEndpoint': 'string',
                          'Username': 'string'
                      },
                      'ApiKeyConnectionMetadata': {
                          'BaseEndpoint': 'string',
                          'Email': 'string'
                      },
                      'NoneConnectionMetadata': {
                          'BaseEndpoint': 'string'
                      },
                      'IamConnectionMetadata': {
                          'RoleArn': 'string',
                          'SourceArn': 'string'
                      }
                  }
              },
              'EnabledActions': [
                  'string',
              ],
              'VpcConnectionArn': 'string'
          },
          'RequestId': 'string',
          'Status': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ActionConnector** *(dict) --* 

        The detailed information about the action connector, including its configuration and current state.

        
        

        - **Arn** *(string) --* 

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

          
        

        - **ActionConnectorId** *(string) --* 

          The unique identifier of the action connector.

          
        

        - **Type** *(string) --* 

          The type of action connector.

          
        

        - **Name** *(string) --* 

          The name of the action connector.

          
        

        - **CreatedTime** *(datetime) --* 

          The timestamp when the action connector was created.

          
        

        - **LastUpdatedTime** *(datetime) --* 

          The date and time when the action connector was last updated.

          
        

        - **Status** *(string) --* 

          The current status of the action connector.

          
        

        - **Error** *(dict) --* 

          Error information if the action connector is in an error state.

          
          

          - **Message** *(string) --* 

            The error message describing what went wrong with the action connector.

            
          

          - **Type** *(string) --* 

            The type or category of the error.

            
      
        

        - **Description** *(string) --* 

          The description of the action connector.

          
        

        - **AuthenticationConfig** *(dict) --* 

          The authentication configuration used to connect to the external service.

          
          

          - **AuthenticationType** *(string) --* 

            The type of authentication being used (BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, or OAUTH2_AUTHORIZATION_CODE).

            
          

          - **AuthenticationMetadata** *(dict) --* 

            The authentication metadata containing configuration details specific to the authentication type.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``AuthorizationCodeGrantMetadata``, ``ClientCredentialsGrantMetadata``, ``BasicAuthConnectionMetadata``, ``ApiKeyConnectionMetadata``, ``NoneConnectionMetadata``, ``IamConnectionMetadata``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

            - **AuthorizationCodeGrantMetadata** *(dict) --* 

              Read-only metadata for OAuth2 authorization code grant flow configuration.

              
              

              - **BaseEndpoint** *(string) --* 

                The base endpoint URL for the OAuth2 authorization code grant flow.

                
              

              - **RedirectUrl** *(string) --* 

                The redirect URL where the authorization server will send the user after authorization.

                
              

              - **ReadAuthorizationCodeGrantCredentialsDetails** *(dict) --* 

                The read-only credentials details for the authorization code grant flow.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``ReadAuthorizationCodeGrantDetails``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


              
                

                - **ReadAuthorizationCodeGrantDetails** *(dict) --* 

                  The read-only authorization code grant configuration details.

                  
                  

                  - **ClientId** *(string) --* 

                    The client identifier for the OAuth2 authorization code grant flow.

                    
                  

                  - **TokenEndpoint** *(string) --* 

                    The authorization server endpoint used to obtain access tokens via the authorization code grant flow.

                    
                  

                  - **AuthorizationEndpoint** *(string) --* 

                    The authorization server endpoint used to obtain authorization codes from the resource owner.

                    
              
            
              

              - **AuthorizationCodeGrantCredentialsSource** *(string) --* 

                The source of credentials for the authorization code grant flow.

                
          
            

            - **ClientCredentialsGrantMetadata** *(dict) --* 

              Read-only metadata for OAuth2 client credentials grant flow configuration.

              
              

              - **BaseEndpoint** *(string) --* 

                The base endpoint URL for the OAuth2 client credentials grant flow.

                
              

              - **ReadClientCredentialsDetails** *(dict) --* 

                The read-only client credentials configuration details.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``ReadClientCredentialsGrantDetails``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                                'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


              
                

                - **ReadClientCredentialsGrantDetails** *(dict) --* 

                  The read-only client credentials grant configuration details.

                  
                  

                  - **ClientId** *(string) --* 

                    The client identifier for the OAuth2 client credentials grant flow.

                    
                  

                  - **TokenEndpoint** *(string) --* 

                    The authorization server endpoint used to obtain access tokens via the client credentials grant flow.

                    
              
            
              

              - **ClientCredentialsSource** *(string) --* 

                The source of client credentials for the OAuth2 client credentials grant flow.

                
          
            

            - **BasicAuthConnectionMetadata** *(dict) --* 

              Read-only metadata for basic authentication configuration.

              
              

              - **BaseEndpoint** *(string) --* 

                The base endpoint URL for basic authentication.

                
              

              - **Username** *(string) --* 

                The username used for basic authentication.

                
          
            

            - **ApiKeyConnectionMetadata** *(dict) --* 

              Read-only metadata for API key authentication configuration.

              
              

              - **BaseEndpoint** *(string) --* 

                The base endpoint URL for API key authentication.

                
              

              - **Email** *(string) --* 

                The email address associated with the API key authentication.

                
          
            

            - **NoneConnectionMetadata** *(dict) --* 

              Read-only metadata for connections that do not require authentication.

              
              

              - **BaseEndpoint** *(string) --* 

                The base endpoint URL for connections that do not require authentication.

                
          
            

            - **IamConnectionMetadata** *(dict) --* 

              Read-only metadata for IAM-based authentication configuration.

              
              

              - **RoleArn** *(string) --* 

                The Amazon Resource Name (ARN) of the IAM role to assume for authentication.

                
              

              - **SourceArn** *(string) --* 

                The Amazon Resource Name (ARN) of the source resource for IAM authentication.

                
          
        
      
        

        - **EnabledActions** *(list) --* 

          The list of actions that are enabled for this connector.

          
          

          - *(string) --* 
      
        

        - **VpcConnectionArn** *(string) --* 

          The ARN of the VPC connection used for secure connectivity to the external service.

          
    
      

      - **RequestId** *(string) --* 

        The Amazon Web Services request ID for this operation.

        
      

      - **Status** *(integer) --* 

        The HTTP status code of the request.

        
  
  **Exceptions**
  
  *   :py:class:`QuickSight.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  
  *   :py:class:`QuickSight.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  