OpenSearchService / Client / get_application

get_application¶

OpenSearchService.Client.get_application(**kwargs)¶

Retrieves the configuration and status of an existing OpenSearch application.

Request Syntax

response = client.get_application(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

The unique identifier of the OpenSearch application to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'name': 'string',
    'endpoint': 'string',
    'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
    'iamIdentityCenterOptions': {
        'enabled': True|False,
        'iamIdentityCenterInstanceArn': 'string',
        'iamRoleForIdentityCenterApplicationArn': 'string',
        'iamIdentityCenterApplicationArn': 'string'
    },
    'dataSources': [
        {
            'dataSourceArn': 'string',
            'dataSourceDescription': 'string'
        },
    ],
    'appConfigs': [
        {
            'key': 'opensearchDashboards.dashboardAdmin.users'|'opensearchDashboards.dashboardAdmin.groups',
            'value': 'string'
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- id (string) –
  
  The unique identifier of the OpenSearch application.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.
- name (string) –
  
  The name of the OpenSearch application.
- endpoint (string) –
  
  The endpoint URL of the OpenSearch application.
- status (string) –
  
  The current status of the OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.
- iamIdentityCenterOptions (dict) –
  
  The IAM Identity Center settings configured for the OpenSearch application.
  - enabled (boolean) –
    
    Indicates whether IAM Identity Center is enabled for the OpenSearch Application.
  - iamIdentityCenterInstanceArn (string) –
    
    The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.
  - iamRoleForIdentityCenterApplicationArn (string) –
    
    The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch Application.
  - iamIdentityCenterApplicationArn (string) –
    
    The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.
- dataSources (list) –
  
  The data sources associated with the OpenSearch application.
  - (dict) –
    
    Data sources that are associated with an OpenSearch Application.
    - dataSourceArn (string) –
      
      The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.
    - dataSourceDescription (string) –
      
      Detailed description of a data source.
- appConfigs (list) –
  
  The configuration settings of the OpenSearch application.
  - (dict) –
    
    Configuration settings for an OpenSearch application. For more information, see see Using the OpenSearch user interface in Amazon OpenSearch Service.
    - key (string) –
      
      The configuration item to set, such as the admin role for the OpenSearch application.
    - value (string) –
      
      The value assigned to the configuration key, such as an IAM user ARN.
- createdAt (datetime) –
  
  The timestamp when the OpenSearch application was created.
- lastUpdatedAt (datetime) –
  
  The timestamp of the last update to the OpenSearch application.

Exceptions

OpenSearchService.Client.exceptions.BaseException
OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.AccessDeniedException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.DisabledOperationException