CloudWatchLogs / Client / get_integration

get_integration#

CloudWatchLogs.Client.get_integration(**kwargs)#

Returns information about one integration between CloudWatch Logs and OpenSearch Service.

Request Syntax

response = client.get_integration(
    integrationName='string'
)

Parameters:

integrationName (string) –

[REQUIRED]

The name of the integration that you want to find information about. To find the name of your integration, use ListIntegrations

Return type:

dict

Returns:

Response Syntax

{
    'integrationName': 'string',
    'integrationType': 'OPENSEARCH',
    'integrationStatus': 'PROVISIONING'|'ACTIVE'|'FAILED',
    'integrationDetails': {
        'openSearchIntegrationDetails': {
            'dataSource': {
                'dataSourceName': 'string',
                'status': {
                    'status': 'ACTIVE'|'NOT_FOUND'|'ERROR',
                    'statusMessage': 'string'
                }
            },
            'application': {
                'applicationEndpoint': 'string',
                'applicationArn': 'string',
                'applicationId': 'string',
                'status': {
                    'status': 'ACTIVE'|'NOT_FOUND'|'ERROR',
                    'statusMessage': 'string'
                }
            },
            'collection': {
                'collectionEndpoint': 'string',
                'collectionArn': 'string',
                'status': {
                    'status': 'ACTIVE'|'NOT_FOUND'|'ERROR',
                    'statusMessage': 'string'
                }
            },
            'workspace': {
                'workspaceId': 'string',
                'status': {
                    'status': 'ACTIVE'|'NOT_FOUND'|'ERROR',
                    'statusMessage': 'string'
                }
            },
            'encryptionPolicy': {
                'policyName': 'string',
                'status': {
                    'status': 'ACTIVE'|'NOT_FOUND'|'ERROR',
                    'statusMessage': 'string'
                }
            },
            'networkPolicy': {
                'policyName': 'string',
                'status': {
                    'status': 'ACTIVE'|'NOT_FOUND'|'ERROR',
                    'statusMessage': 'string'
                }
            },
            'accessPolicy': {
                'policyName': 'string',
                'status': {
                    'status': 'ACTIVE'|'NOT_FOUND'|'ERROR',
                    'statusMessage': 'string'
                }
            },
            'lifecyclePolicy': {
                'policyName': 'string',
                'status': {
                    'status': 'ACTIVE'|'NOT_FOUND'|'ERROR',
                    'statusMessage': 'string'
                }
            }
        }
    }
}

Response Structure

(dict) –
- integrationName (string) –
  
  The name of the integration.
- integrationType (string) –
  
  The type of integration. Integrations with OpenSearch Service have the type OPENSEARCH.
- integrationStatus (string) –
  
  The current status of this integration.
- integrationDetails (dict) –
  
  A structure that contains information about the integration configuration. For an integration with OpenSearch Service, this includes information about OpenSearch Service resources such as the collection, the workspace, and policies.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: openSearchIntegrationDetails. 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'}
  - openSearchIntegrationDetails (dict) –
    
    This structure contains complete information about one integration between CloudWatch Logs and OpenSearch Service.
    - dataSource (dict) –
      
      This structure contains information about the OpenSearch Service data source used for this integration. This data source was created as part of the integration setup. An OpenSearch Service data source defines the source and destination for OpenSearch Service queries. It includes the role required to execute queries and write to collections.
      
      For more information about OpenSearch Service data sources , see Creating OpenSearch Service data source integrations with Amazon S3.
      - dataSourceName (string) –
        
        The name of the OpenSearch Service data source.
      - status (dict) –
        
        This structure contains information about the status of this OpenSearch Service resource.
        
        status (string) –
        
        The current status of this resource.
        
        statusMessage (string) –
        
        A message with additional information about the status of this resource.
    - application (dict) –
      
      This structure contains information about the OpenSearch Service application used for this integration. An OpenSearch Service application is the web application that was created by the integration with CloudWatch Logs. It hosts the vended logs dashboards.
      - applicationEndpoint (string) –
        
        The endpoint of the application.
      - applicationArn (string) –
        
        The Amazon Resource Name (ARN) of the application.
      - applicationId (string) –
        
        The ID of the application.
      - status (dict) –
        
        This structure contains information about the status of this OpenSearch Service resource.
        
        status (string) –
        
        The current status of this resource.
        
        statusMessage (string) –
        
        A message with additional information about the status of this resource.
    - collection (dict) –
      
      This structure contains information about the OpenSearch Service collection used for this integration. This collection was created as part of the integration setup. An OpenSearch Service collection is a logical grouping of one or more indexes that represent an analytics workload. For more information, see Creating and managing OpenSearch Service Serverless collections.
      - collectionEndpoint (string) –
        
        The endpoint of the collection.
      - collectionArn (string) –
        
        The ARN of the collection.
      - status (dict) –
        
        This structure contains information about the status of this OpenSearch Service resource.
        
        status (string) –
        
        The current status of this resource.
        
        statusMessage (string) –
        
        A message with additional information about the status of this resource.
    - workspace (dict) –
      
      This structure contains information about the OpenSearch Service workspace used for this integration. An OpenSearch Service workspace is the collection of dashboards along with other OpenSearch Service tools. This workspace was created automatically as part of the integration setup. For more information, see Centralized OpenSearch user interface (Dashboards) with OpenSearch Service.
      - workspaceId (string) –
        
        The ID of this workspace.
      - status (dict) –
        
        This structure contains information about the status of an OpenSearch Service resource.
        
        status (string) –
        
        The current status of this resource.
        
        statusMessage (string) –
        
        A message with additional information about the status of this resource.
    - encryptionPolicy (dict) –
      
      This structure contains information about the OpenSearch Service encryption policy used for this integration. The encryption policy was created automatically when you created the integration. For more information, see Encryption policies in the OpenSearch Service Developer Guide.
      - policyName (string) –
        
        The name of the encryption policy.
      - status (dict) –
        
        This structure contains information about the status of this OpenSearch Service resource.
        
        status (string) –
        
        The current status of this resource.
        
        statusMessage (string) –
        
        A message with additional information about the status of this resource.
    - networkPolicy (dict) –
      
      This structure contains information about the OpenSearch Service network policy used for this integration. The network policy assigns network access settings to collections. For more information, see Network policies in the OpenSearch Service Developer Guide.
      - policyName (string) –
        
        The name of the network policy.
      - status (dict) –
        
        This structure contains information about the status of this OpenSearch Service resource.
        
        status (string) –
        
        The current status of this resource.
        
        statusMessage (string) –
        
        A message with additional information about the status of this resource.
    - accessPolicy (dict) –
      
      This structure contains information about the OpenSearch Service data access policy used for this integration. The access policy defines the access controls for the collection. This data access policy was automatically created as part of the integration setup. For more information about OpenSearch Service data access policies, see Data access control for Amazon OpenSearch Serverless in the OpenSearch Service Developer Guide.
      - policyName (string) –
        
        The name of the data access policy.
      - status (dict) –
        
        This structure contains information about the status of this OpenSearch Service resource.
        
        status (string) –
        
        The current status of this resource.
        
        statusMessage (string) –
        
        A message with additional information about the status of this resource.
    - lifecyclePolicy (dict) –
      
      This structure contains information about the OpenSearch Service data lifecycle policy used for this integration. The lifecycle policy determines the lifespan of the data in the collection. It was automatically created as part of the integration setup.
      
      For more information, see Using data lifecycle policies with OpenSearch Service Serverless in the OpenSearch Service Developer Guide.
      - policyName (string) –
        
        The name of the lifecycle policy.
      - status (dict) –
        
        This structure contains information about the status of this OpenSearch Service resource.
        
        status (string) –
        
        The current status of this resource.
        
        statusMessage (string) –
        
        A message with additional information about the status of this resource.

Exceptions

CloudWatchLogs.Client.exceptions.InvalidParameterException
CloudWatchLogs.Client.exceptions.ServiceUnavailableException
CloudWatchLogs.Client.exceptions.ResourceNotFoundException