OpenSearchService / Client / get_application

get_application#

OpenSearchService.Client.get_application(**kwargs)#

Check the configuration and status of an existing OpenSearch Application.

See also: AWS API Documentation

Request Syntax

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

id (string) –

[REQUIRED]

Unique identifier of the checked OpenSearch Application.

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) –

      Unique identifier of the checked 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) –

      Name of the checked OpenSearch Application.

    • endpoint (string) –

      Endpoint URL of the checked OpenSearch Application.

    • status (string) –

      Current status of the checked OpenSearch Application. Possible values are CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

    • iamIdentityCenterOptions (dict) –

      IAM Identity Center settings for the checked OpenSearch Application.

      • enabled (boolean) –

        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) –

        Amazon Resource Name of the IAM Identity Center’s Application created for the OpenSearch Application after enabling IAM Identity Center.

      • 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) –

      Associated data sources to the checked 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) –

      App configurations of the checked OpenSearch Application.

      • (dict) –

        Configurations of the OpenSearch Application.

        • key (string) –

          Specify the item to configure, such as admin role for the OpenSearch Application.

        • value (string) –

          Specifies the value to configure for the key, such as an IAM user ARN.

    • createdAt (datetime) –

      Timestamp at which the checked OpenSearch Application was created.

    • lastUpdatedAt (datetime) –

      Timestamp at which the checked OpenSearch Application was last updated.

Exceptions