Amazon OpenSearch Service

{'iamIdentityCenterOptions': {'enabled': 'boolean',
                              'iamIdentityCenterInstanceArn': 'string',
                              'iamRoleForIdentityCenterApplicationArn': 'string'}}

Updates the configuration and settings of an existing OpenSearch application.

See also: AWS API Documentation

Request Syntax

client.update_application(
    id='string',
    dataSources=[
        {
            'dataSourceArn': 'string',
            'dataSourceDescription': 'string',
            'iamRoleForDataSourceArn': 'string'
        },
    ],
    appConfigs=[
        {
            'key': 'opensearchDashboards.dashboardAdmin.users'|'opensearchDashboards.dashboardAdmin.groups',
            'value': 'string'
        },
    ],
    iamIdentityCenterOptions={
        'enabled': True|False,
        'iamIdentityCenterInstanceArn': 'string',
        'iamRoleForIdentityCenterApplicationArn': 'string'
    }
)

type id:

string

param id:

[REQUIRED]

The unique identifier for the OpenSearch application to be updated.

type dataSources:

list

param dataSources:

The data sources to associate 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.

  • iamRoleForDataSourceArn (string) --

    The ARN of the IAM role to be used for cross account/region data source association.

type appConfigs:

list

param appConfigs:

The configuration settings to modify for the OpenSearch application.

• (dict) --

  Configuration settings for an OpenSearch application. For more information, 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.

type iamIdentityCenterOptions:

dict

param iamIdentityCenterOptions:

Configuration settings for integrating IAM Identity Center with the OpenSearch application.

• enabled (boolean) --

  Specifies whether IAM Identity Center is enabled or disabled.

• 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 ARN of the IAM role associated with the IAM Identity Center application.

rtype:

dict

returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'dataSources': [
        {
            'dataSourceArn': 'string',
            'dataSourceDescription': 'string',
            'iamRoleForDataSourceArn': 'string'
        },
    ],
    'iamIdentityCenterOptions': {
        'enabled': True|False,
        'iamIdentityCenterInstanceArn': 'string',
        'iamRoleForIdentityCenterApplicationArn': 'string',
        'iamIdentityCenterApplicationArn': '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 updated OpenSearch application.

  • name (string) --

    The name of the updated 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.

  • dataSources (list) --

    The data sources associated with the updated 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.

      • iamRoleForDataSourceArn (string) --

        The ARN of the IAM role to be used for cross account/region data source association.

  • iamIdentityCenterOptions (dict) --

    The IAM Identity Center configuration for the updated 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.

  • appConfigs (list) --

    The configuration settings for the updated OpenSearch application.

    • (dict) --

      Configuration settings for an OpenSearch application. For more information, 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 originally created.

  • lastUpdatedAt (datetime) --

    The timestamp when the OpenSearch application was last updated.