OpenSearchService / Client / create_application

create_application#

OpenSearchService.Client.create_application(**kwargs)#

Creates an OpenSearch Application.

See also: AWS API Documentation

Request Syntax

response = client.create_application(
    clientToken='string',
    name='string',
    dataSources=[
        {
            'dataSourceArn': 'string',
            'dataSourceDescription': 'string'
        },
    ],
    iamIdentityCenterOptions={
        'enabled': True|False,
        'iamIdentityCenterInstanceArn': 'string',
        'iamRoleForIdentityCenterApplicationArn': 'string'
    },
    appConfigs=[
        {
            'key': 'opensearchDashboards.dashboardAdmin.users'|'opensearchDashboards.dashboardAdmin.groups',
            'value': 'string'
        },
    ],
    tagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • clientToken (string) –

    A unique client idempotency token. It will be auto generated if not provided.

    This field is autopopulated if not provided.

  • name (string) –

    [REQUIRED]

    Name of the OpenSearch Appication to create. Application names are unique across the applications owned by an account within an Amazon Web Services Region.

  • dataSources (list) –

    Data sources to be 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.

  • iamIdentityCenterOptions (dict) –

    Settings of IAM Identity Center for the OpenSearch Application.

    • enabled (boolean) –

      Enable/disable settings for IAM Identity Center.

    • 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 IAM Identity Center’s application.

  • appConfigs (list) –

    Configurations of the OpenSearch Application, inlcuding admin configuration.

    • (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.

  • tagList (list) –

    A list of tags attached to a domain.

    • (dict) –

      A tag (key-value pair) for an Amazon OpenSearch Service resource.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique for the domain to which they are attached.

      • Value (string) – [REQUIRED]

        The value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'dataSources': [
        {
            'dataSourceArn': 'string',
            'dataSourceDescription': 'string'
        },
    ],
    'iamIdentityCenterOptions': {
        'enabled': True|False,
        'iamIdentityCenterInstanceArn': 'string',
        'iamRoleForIdentityCenterApplicationArn': 'string',
        'iamIdentityCenterApplicationArn': 'string'
    },
    'appConfigs': [
        {
            'key': 'opensearchDashboards.dashboardAdmin.users'|'opensearchDashboards.dashboardAdmin.groups',
            'value': 'string'
        },
    ],
    'tagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • id (string) –

      Unique identifier for the created OpenSearch Application.

    • name (string) –

      Name of the created 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) –

      Data sources associated with the created 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.

    • iamIdentityCenterOptions (dict) –

      Settings of IAM Identity Center for the created 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.

    • appConfigs (list) –

      Configurations of the OpenSearch Application, inlcuding admin configuration.

      • (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.

    • tagList (list) –

      A list of tags attached to a domain.

      • (dict) –

        A tag (key-value pair) for an Amazon OpenSearch Service resource.

        • Key (string) –

          The tag key. Tag keys must be unique for the domain to which they are attached.

        • Value (string) –

          The value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

    • createdAt (datetime) –

      Timestamp when the OpenSearch Application was created.

Exceptions