SecurityHub / Client / get_connector_v2

get_connector_v2¶

SecurityHub.Client.get_connector_v2(**kwargs)¶

Grants permission to retrieve details for a connectorV2 based on connector id.

Request Syntax

response = client.get_connector_v2(
    ConnectorId='string'
)

Parameters:

ConnectorId (string) –

[REQUIRED]

The UUID of the connectorV2 to identify connectorV2 resource.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectorArn': 'string',
    'ConnectorId': 'string',
    'Name': 'string',
    'Description': 'string',
    'KmsKeyArn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'LastUpdatedAt': datetime(2015, 1, 1),
    'Health': {
        'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
        'Message': 'string',
        'LastCheckedAt': datetime(2015, 1, 1),
        'Issues': [
            {
                'Code': 'AUTHENTICATION_FAILURE'|'STREAM_AUTHORIZATION_FAILURE'|'DISCOVERY_FAILURE'|'STREAM_LIMIT_EXCEEDED'|'STREAM_DISCONNECTED'|'RECORDING_FAILURE'|'NO_HEALTH_DATA',
                'Message': 'string'
            },
        ]
    },
    'ProviderDetail': {
        'JiraCloud': {
            'CloudId': 'string',
            'ProjectKey': 'string',
            'Domain': 'string',
            'AuthUrl': 'string',
            'AuthStatus': 'ACTIVE'|'FAILED'
        },
        'ServiceNow': {
            'InstanceName': 'string',
            'SecretArn': 'string',
            'AuthStatus': 'ACTIVE'|'FAILED'
        },
        'Azure': {
            'AWSConfigConnectorArn': 'string',
            'ScopeConfiguration': {
                'ScopeType': 'TENANT'|'SUBSCRIPTION',
                'ScopeValues': [
                    'string',
                ]
            },
            'AzureRegions': [
                'string',
            ]
        }
    },
    'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'FAILED_TO_DELETE',
    'EnablementStatusReason': 'string'
}

Response Structure

(dict) –
- ConnectorArn (string) –
  
  The Amazon Resource Name (ARN) of the connectorV2.
- ConnectorId (string) –
  
  The UUID of the connectorV2 to identify connectorV2 resource.
- Name (string) –
  
  The name of the connectorV2.
- Description (string) –
  
  The description of the connectorV2.
- KmsKeyArn (string) –
  
  The Amazon Resource Name (ARN) of KMS key used for the connectorV2.
- CreatedAt (datetime) –
  
  ISO 8601 UTC timestamp for the time create the connectorV2.
- LastUpdatedAt (datetime) –
  
  ISO 8601 UTC timestamp for the time update the connectorV2 connectorStatus.
- Health (dict) –
  
  The current health status for connectorV2
  - ConnectorStatus (string) –
    
    The status of the connectorV2.
  - Message (string) –
    
    The message for the reason of connectorStatus change.
  - LastCheckedAt (datetime) –
    
    ISO 8601 UTC timestamp for the time check the health status of the connectorV2.
  - Issues (list) –
    
    A list of health issues associated with the connector, including error codes and messages.
    - (dict) –
      
      Represents a specific health issue detected for a connector.
      - Code (string) –
        
        The error code that identifies the type of health issue.
      - Message (string) –
        
        A human-readable message that describes the health issue.
- ProviderDetail (dict) –
  
  The third-party provider detail for a service configuration.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: JiraCloud, ServiceNow, Azure. 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'}
  - JiraCloud (dict) –
    
    Details about a Jira Cloud integration.
    - CloudId (string) –
      
      The cloud id of the Jira Cloud.
    - ProjectKey (string) –
      
      The projectKey of Jira Cloud.
    - Domain (string) –
      
      The URL domain of your Jira Cloud instance.
    - AuthUrl (string) –
      
      The URL to provide to customers for OAuth auth code flow.
    - AuthStatus (string) –
      
      The status of the authorization between Jira Cloud and the service.
  - ServiceNow (dict) –
    
    Details about a ServiceNow ITSM integration.
    - InstanceName (string) –
      
      The instanceName of ServiceNow ITSM.
    - SecretArn (string) –
      
      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the ServiceNow credentials.
    - AuthStatus (string) –
      
      The status of the authorization between ServiceNow and the service.
  - Azure (dict) –
    
    Details about a Microsoft Azure CSPM integration.
    - AWSConfigConnectorArn (string) –
      
      The ARN of the multi-cloud configuration connector used to establish the connection to Azure.
    - ScopeConfiguration (dict) –
      
      The scope configuration that defines which Azure resources are monitored.
      - ScopeType (string) –
        
        The type of scope. Valid values are tenant and subscription.
      - ScopeValues (list) –
        
        The list of scope values, such as subscription IDs, when the scope type is subscription.
        
        (string) –
    - AzureRegions (list) –
      
      The list of Azure regions being monitored.
      - (string) –
- EnablementStatus (string) –
  
  The enablement status of the connector.
- EnablementStatusReason (string) –
  
  The reason for the current enablement status. Provides additional context when the connector is in a failed state.

Exceptions

SecurityHub.Client.exceptions.AccessDeniedException
SecurityHub.Client.exceptions.InternalServerException
SecurityHub.Client.exceptions.ValidationException
SecurityHub.Client.exceptions.ThrottlingException
SecurityHub.Client.exceptions.ConflictException
SecurityHub.Client.exceptions.ResourceNotFoundException