Amazon OpenSearch Service

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements .

See also: AWS API Documentation

Request Syntax

client.list_scheduled_actions(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

type MaxResults

integer

param MaxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

type NextToken

string

param NextToken

If your initial ListScheduledActions operation returns a nextToken , you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.

rtype

dict

returns

Response Syntax

{
    'ScheduledActions': [
        {
            'Id': 'string',
            'Type': 'SERVICE_SOFTWARE_UPDATE'|'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING',
            'Severity': 'HIGH'|'MEDIUM'|'LOW',
            'ScheduledTime': 123,
            'Description': 'string',
            'ScheduledBy': 'CUSTOMER'|'SYSTEM',
            'Status': 'PENDING_UPDATE'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
            'Mandatory': True|False,
            'Cancellable': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ScheduledActions (list) --

    A list of actions that are scheduled for the domain.

    • (dict) --

      Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement .

      • Id (string) --

        The unique identifier of the scheduled action.

      • Type (string) --

        The type of action that will be taken on the domain.

      • Severity (string) --

        The severity of the action.

      • ScheduledTime (integer) --

        The time when the change is scheduled to happen.

      • Description (string) --

        A description of the action to be taken.

      • ScheduledBy (string) --

        Whether the action was scheduled manually (CUSTOMER , or by OpenSearch Service automatically (SYSTEM ).

      • Status (string) --

        The current status of the scheduled action.

      • Mandatory (boolean) --

        Whether the action is required or optional.

      • Cancellable (boolean) --

        Whether or not the scheduled action is cancellable.

  • NextToken (string) --

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement .

See also: AWS API Documentation

Request Syntax

client.update_scheduled_action(
    DomainName='string',
    ActionID='string',
    ActionType='SERVICE_SOFTWARE_UPDATE'|'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING',
    ScheduleAt='NOW'|'TIMESTAMP'|'OFF_PEAK_WINDOW',
    DesiredStartTime=123
)

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain to reschedule an action for.

type ActionID

string

param ActionID

[REQUIRED]

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

type ActionType

string

param ActionType

[REQUIRED]

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE , JVM_HEAP_SIZE_TUNING , or JVM_YOUNG_GEN_TUNING . To retrieve this value, send a ListScheduledActions request.

type ScheduleAt

string

param ScheduleAt

[REQUIRED]

When to schedule the action.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime .

• OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

type DesiredStartTime

integer

param DesiredStartTime

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP .

rtype

dict

returns

Response Syntax

{
    'ScheduledAction': {
        'Id': 'string',
        'Type': 'SERVICE_SOFTWARE_UPDATE'|'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING',
        'Severity': 'HIGH'|'MEDIUM'|'LOW',
        'ScheduledTime': 123,
        'Description': 'string',
        'ScheduledBy': 'CUSTOMER'|'SYSTEM',
        'Status': 'PENDING_UPDATE'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
        'Mandatory': True|False,
        'Cancellable': True|False
    }
}

Response Structure

• (dict) --

  • ScheduledAction (dict) --

    Information about the rescheduled action.

    • Id (string) --

      The unique identifier of the scheduled action.

    • Type (string) --

      The type of action that will be taken on the domain.

    • Severity (string) --

      The severity of the action.

    • ScheduledTime (integer) --

      The time when the change is scheduled to happen.

    • Description (string) --

      A description of the action to be taken.

    • ScheduledBy (string) --

      Whether the action was scheduled manually (CUSTOMER , or by OpenSearch Service automatically (SYSTEM ).

    • Status (string) --

      The current status of the scheduled action.

    • Mandatory (boolean) --

      Whether the action is required or optional.

    • Cancellable (boolean) --

      Whether or not the scheduled action is cancellable.

{'AutoTuneOptions': {'UseOffPeakWindow': 'boolean'},
 'OffPeakWindowOptions': {'Enabled': 'boolean',
                          'OffPeakWindow': {'WindowStartTime': {'Hours': 'long',
                                                                'Minutes': 'long'}}},
 'SoftwareUpdateOptions': {'AutoSoftwareUpdateEnabled': 'boolean'}}

{'DomainStatus': {'AutoTuneOptions': {'UseOffPeakWindow': 'boolean'},
                  'OffPeakWindowOptions': {'Enabled': 'boolean',
                                           'OffPeakWindow': {'WindowStartTime': {'Hours': 'long',
                                                                                 'Minutes': 'long'}}},
                  'SoftwareUpdateOptions': {'AutoSoftwareUpdateEnabled': 'boolean'}}}

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains .

See also: AWS API Documentation

Request Syntax

client.create_domain(
    DomainName='string',
    EngineVersion='string',
    ClusterConfig={
        'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
        'InstanceCount': 123,
        'DedicatedMasterEnabled': True|False,
        'ZoneAwarenessEnabled': True|False,
        'ZoneAwarenessConfig': {
            'AvailabilityZoneCount': 123
        },
        'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
        'DedicatedMasterCount': 123,
        'WarmEnabled': True|False,
        'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
        'WarmCount': 123,
        'ColdStorageOptions': {
            'Enabled': True|False
        }
    },
    EBSOptions={
        'EBSEnabled': True|False,
        'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
        'VolumeSize': 123,
        'Iops': 123,
        'Throughput': 123
    },
    AccessPolicies='string',
    SnapshotOptions={
        'AutomatedSnapshotStartHour': 123
    },
    VPCOptions={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    CognitoOptions={
        'Enabled': True|False,
        'UserPoolId': 'string',
        'IdentityPoolId': 'string',
        'RoleArn': 'string'
    },
    EncryptionAtRestOptions={
        'Enabled': True|False,
        'KmsKeyId': 'string'
    },
    NodeToNodeEncryptionOptions={
        'Enabled': True|False
    },
    AdvancedOptions={
        'string': 'string'
    },
    LogPublishingOptions={
        'string': {
            'CloudWatchLogsLogGroupArn': 'string',
            'Enabled': True|False
        }
    },
    DomainEndpointOptions={
        'EnforceHTTPS': True|False,
        'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
        'CustomEndpointEnabled': True|False,
        'CustomEndpoint': 'string',
        'CustomEndpointCertificateArn': 'string'
    },
    AdvancedSecurityOptions={
        'Enabled': True|False,
        'InternalUserDatabaseEnabled': True|False,
        'MasterUserOptions': {
            'MasterUserARN': 'string',
            'MasterUserName': 'string',
            'MasterUserPassword': 'string'
        },
        'SAMLOptions': {
            'Enabled': True|False,
            'Idp': {
                'MetadataContent': 'string',
                'EntityId': 'string'
            },
            'MasterUserName': 'string',
            'MasterBackendRole': 'string',
            'SubjectKey': 'string',
            'RolesKey': 'string',
            'SessionTimeoutMinutes': 123
        },
        'AnonymousAuthEnabled': True|False
    },
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AutoTuneOptions={
        'DesiredState': 'ENABLED'|'DISABLED',
        'MaintenanceSchedules': [
            {
                'StartAt': datetime(2015, 1, 1),
                'Duration': {
                    'Value': 123,
                    'Unit': 'HOURS'
                },
                'CronExpressionForRecurrence': 'string'
            },
        ],
        'UseOffPeakWindow': True|False
    },
    OffPeakWindowOptions={
        'Enabled': True|False,
        'OffPeakWindow': {
            'WindowStartTime': {
                'Hours': 123,
                'Minutes': 123
            }
        }
    },
    SoftwareUpdateOptions={
        'AutoSoftwareUpdateEnabled': True|False
    }
)

type DomainName

string

param DomainName

[REQUIRED]

Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

type EngineVersion

string

param EngineVersion

String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9 . For more information, see Creating and managing Amazon OpenSearch Service domains .

type ClusterConfig

dict

param ClusterConfig

Container for the cluster configuration of a domain.

• InstanceType (string) --

  Instance type of data nodes in the cluster.

• InstanceCount (integer) --

  Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

• DedicatedMasterEnabled (boolean) --

  Indicates whether dedicated master nodes are enabled for the cluster.``True`` if the cluster will use a dedicated master node.``False`` if the cluster will not.

• ZoneAwarenessEnabled (boolean) --

  Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

• ZoneAwarenessConfig (dict) --

  Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .

  • AvailabilityZoneCount (integer) --

    If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3 . If your domain is provisioned within a VPC, this value be equal to number of subnets.

• DedicatedMasterType (string) --

  OpenSearch Service instance type of the dedicated master nodes in the cluster.

• DedicatedMasterCount (integer) --

  Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

• WarmEnabled (boolean) --

  Whether to enable warm storage for the cluster.

• WarmType (string) --

  The instance type for the cluster's warm nodes.

• WarmCount (integer) --

  The number of warm nodes in the cluster.

• ColdStorageOptions (dict) --

  Container for cold storage configuration options.

  • Enabled (boolean) -- [REQUIRED]

    Whether to enable or disable cold storage on the domain.

type EBSOptions

dict

param EBSOptions

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

• EBSEnabled (boolean) --

  Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

• VolumeType (string) --

  Specifies the type of EBS volumes attached to data nodes.

• VolumeSize (integer) --

  Specifies the size (in GiB) of EBS volumes attached to data nodes.

• Iops (integer) --

  Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

• Throughput (integer) --

  Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

type AccessPolicies

string

param AccessPolicies

Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

type SnapshotOptions

dict

param SnapshotOptions

DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

• AutomatedSnapshotStartHour (integer) --

  The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

type VPCOptions

dict

param VPCOptions

Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

• SubnetIds (list) --

  A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

  • (string) --

• SecurityGroupIds (list) --

  The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

  • (string) --

type CognitoOptions

dict

param CognitoOptions

Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .

• Enabled (boolean) --

  Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

• UserPoolId (string) --

  The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

• IdentityPoolId (string) --

  The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

• RoleArn (string) --

  The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

type EncryptionAtRestOptions

dict

param EncryptionAtRestOptions

Key-value pairs to enable encryption at rest.

• Enabled (boolean) --

  True to enable encryption at rest.

• KmsKeyId (string) --

  The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .

type NodeToNodeEncryptionOptions

dict

param NodeToNodeEncryptionOptions

Enables node-to-node encryption.

• Enabled (boolean) --

  True to enable node-to-node encryption.

type AdvancedOptions

dict

param AdvancedOptions

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

• "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

• "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

• "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

• "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters .

• (string) --

  • (string) --

type LogPublishingOptions

dict

param LogPublishingOptions

Key-value pairs to configure slow log publishing.

• (string) --

  The type of log file. Can be one of the following:

  • INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.

  • SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.

  • ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

  • AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

  • (dict) --

    Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs .

    Note

    After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

    • CloudWatchLogsLogGroupArn (string) --

      The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

    • Enabled (boolean) --

      Whether the log should be published.

type DomainEndpointOptions

dict

param DomainEndpointOptions

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

• EnforceHTTPS (boolean) --

  True to require that all traffic to the domain arrive over HTTPS.

• TLSSecurityPolicy (string) --

  Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

  Can be one of the following values:

  • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

  • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

• CustomEndpointEnabled (boolean) --

  Whether to enable a custom endpoint for the domain.

• CustomEndpoint (string) --

  The fully qualified URL for the custom endpoint.

• CustomEndpointCertificateArn (string) --

  The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

type AdvancedSecurityOptions

dict

param AdvancedSecurityOptions

Options for fine-grained access control.

• Enabled (boolean) --

  True to enable fine-grained access control.

• InternalUserDatabaseEnabled (boolean) --

  True to enable the internal user database.

• MasterUserOptions (dict) --

  Container for information about the master user.

  • MasterUserARN (string) --

    Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false .

  • MasterUserName (string) --

    User name for the master user. Only specify if InternalUserDatabaseEnabled is true .

  • MasterUserPassword (string) --

    Password for the master user. Only specify if InternalUserDatabaseEnabled is true .

• SAMLOptions (dict) --

  Container for information about the SAML configuration for OpenSearch Dashboards.

  • Enabled (boolean) --

    True to enable SAML authentication for a domain.

  • Idp (dict) --

    The SAML Identity Provider's information.

    • MetadataContent (string) -- [REQUIRED]

      The metadata of the SAML application, in XML format.

    • EntityId (string) -- [REQUIRED]

      The unique entity ID of the application in the SAML identity provider.

  • MasterUserName (string) --

    The SAML master user name, which is stored in the domain's internal user database.

  • MasterBackendRole (string) --

    The backend role that the SAML master user is mapped to.

  • SubjectKey (string) --

    Element of the SAML assertion to use for the user name. Default is NameID .

  • RolesKey (string) --

    Element of the SAML assertion to use for backend roles. Default is roles .

  • SessionTimeoutMinutes (integer) --

    The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

• AnonymousAuthEnabled (boolean) --

  True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .

type TagList

list

param TagList

List of tags to add to the domain upon creation.

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

type AutoTuneOptions

dict

param AutoTuneOptions

Options for Auto-Tune.

• DesiredState (string) --

  Whether Auto-Tune is enabled or disabled.

• MaintenanceSchedules (list) --

  A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows .

  • (dict) --

    Note

    This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows .

    The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service .

    • StartAt (datetime) --

      The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

    • Duration (dict) --

      The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"} .

      • Value (integer) --

        Integer to specify the value of a maintenance schedule duration.

      • Unit (string) --

        The unit of measurement for the duration of a maintenance schedule.

    • CronExpressionForRecurrence (string) --

      A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

• UseOffPeakWindow (boolean) --

  Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

type OffPeakWindowOptions

dict

param OffPeakWindowOptions

Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

• Enabled (boolean) --

  Whether to enable an off-peak window.

  This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

• OffPeakWindow (dict) --

  Off-peak window settings for the domain.

  • WindowStartTime (dict) --

    A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

    • Hours (integer) -- [REQUIRED]

      The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

    • Minutes (integer) -- [REQUIRED]

      The start minute of the window, in UTC.

type SoftwareUpdateOptions

dict

param SoftwareUpdateOptions

Software update options for the domain.

• AutoSoftwareUpdateEnabled (boolean) --

  Whether automatic service software updates are enabled for the domain.

rtype

dict

returns

Response Syntax

{
    'DomainStatus': {
        'DomainId': 'string',
        'DomainName': 'string',
        'ARN': 'string',
        'Created': True|False,
        'Deleted': True|False,
        'Endpoint': 'string',
        'Endpoints': {
            'string': 'string'
        },
        'Processing': True|False,
        'UpgradeProcessing': True|False,
        'EngineVersion': 'string',
        'ClusterConfig': {
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'InstanceCount': 123,
            'DedicatedMasterEnabled': True|False,
            'ZoneAwarenessEnabled': True|False,
            'ZoneAwarenessConfig': {
                'AvailabilityZoneCount': 123
            },
            'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'DedicatedMasterCount': 123,
            'WarmEnabled': True|False,
            'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
            'WarmCount': 123,
            'ColdStorageOptions': {
                'Enabled': True|False
            }
        },
        'EBSOptions': {
            'EBSEnabled': True|False,
            'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
            'VolumeSize': 123,
            'Iops': 123,
            'Throughput': 123
        },
        'AccessPolicies': 'string',
        'SnapshotOptions': {
            'AutomatedSnapshotStartHour': 123
        },
        'VPCOptions': {
            'VPCId': 'string',
            'SubnetIds': [
                'string',
            ],
            'AvailabilityZones': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CognitoOptions': {
            'Enabled': True|False,
            'UserPoolId': 'string',
            'IdentityPoolId': 'string',
            'RoleArn': 'string'
        },
        'EncryptionAtRestOptions': {
            'Enabled': True|False,
            'KmsKeyId': 'string'
        },
        'NodeToNodeEncryptionOptions': {
            'Enabled': True|False
        },
        'AdvancedOptions': {
            'string': 'string'
        },
        'LogPublishingOptions': {
            'string': {
                'CloudWatchLogsLogGroupArn': 'string',
                'Enabled': True|False
            }
        },
        'ServiceSoftwareOptions': {
            'CurrentVersion': 'string',
            'NewVersion': 'string',
            'UpdateAvailable': True|False,
            'Cancellable': True|False,
            'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
            'Description': 'string',
            'AutomatedUpdateDate': datetime(2015, 1, 1),
            'OptionalDeployment': True|False
        },
        'DomainEndpointOptions': {
            'EnforceHTTPS': True|False,
            'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
            'CustomEndpointEnabled': True|False,
            'CustomEndpoint': 'string',
            'CustomEndpointCertificateArn': 'string'
        },
        'AdvancedSecurityOptions': {
            'Enabled': True|False,
            'InternalUserDatabaseEnabled': True|False,
            'SAMLOptions': {
                'Enabled': True|False,
                'Idp': {
                    'MetadataContent': 'string',
                    'EntityId': 'string'
                },
                'SubjectKey': 'string',
                'RolesKey': 'string',
                'SessionTimeoutMinutes': 123
            },
            'AnonymousAuthDisableDate': datetime(2015, 1, 1),
            'AnonymousAuthEnabled': True|False
        },
        'AutoTuneOptions': {
            'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
            'ErrorMessage': 'string',
            'UseOffPeakWindow': True|False
        },
        'ChangeProgressDetails': {
            'ChangeId': 'string',
            'Message': 'string'
        },
        'OffPeakWindowOptions': {
            'Enabled': True|False,
            'OffPeakWindow': {
                'WindowStartTime': {
                    'Hours': 123,
                    'Minutes': 123
                }
            }
        },
        'SoftwareUpdateOptions': {
            'AutoSoftwareUpdateEnabled': True|False
        }
    }
}

Response Structure

• (dict) --

  The result of a CreateDomain operation. Contains the status of the newly created domain.

  • DomainStatus (dict) --

    The status of the newly created domain.

    • DomainId (string) --

      Unique identifier for the domain.

    • DomainName (string) --

      Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

    • ARN (string) --

      The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide .

    • Created (boolean) --

      Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

    • Deleted (boolean) --

      Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

    • Endpoint (string) --

      Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

    • Endpoints (dict) --

      The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

      • (string) --

        • (string) --

          The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com .

    • Processing (boolean) --

      The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

    • UpgradeProcessing (boolean) --

      The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

    • EngineVersion (string) --

      Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y .

    • ClusterConfig (dict) --

      Container for the cluster configuration of the domain.

      • InstanceType (string) --

        Instance type of data nodes in the cluster.

      • InstanceCount (integer) --

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • DedicatedMasterEnabled (boolean) --

        Indicates whether dedicated master nodes are enabled for the cluster.``True`` if the cluster will use a dedicated master node.``False`` if the cluster will not.

      • ZoneAwarenessEnabled (boolean) --

        Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

      • ZoneAwarenessConfig (dict) --

        Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .

        • AvailabilityZoneCount (integer) --

          If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3 . If your domain is provisioned within a VPC, this value be equal to number of subnets.

      • DedicatedMasterType (string) --

        OpenSearch Service instance type of the dedicated master nodes in the cluster.

      • DedicatedMasterCount (integer) --

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • WarmEnabled (boolean) --

        Whether to enable warm storage for the cluster.

      • WarmType (string) --

        The instance type for the cluster's warm nodes.

      • WarmCount (integer) --

        The number of warm nodes in the cluster.

      • ColdStorageOptions (dict) --

        Container for cold storage configuration options.

        • Enabled (boolean) --

          Whether to enable or disable cold storage on the domain.

    • EBSOptions (dict) --

      Container for EBS-based storage settings for the domain.

      • EBSEnabled (boolean) --

        Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

      • VolumeType (string) --

        Specifies the type of EBS volumes attached to data nodes.

      • VolumeSize (integer) --

        Specifies the size (in GiB) of EBS volumes attached to data nodes.

      • Iops (integer) --

        Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

      • Throughput (integer) --

        Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

    • AccessPolicies (string) --

      Identity and Access Management (IAM) policy document specifying the access policies for the domain.

    • SnapshotOptions (dict) --

      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

      • AutomatedSnapshotStartHour (integer) --

        The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

    • VPCOptions (dict) --

      The VPC configuration for the domain.

      • VPCId (string) --

        The ID for your VPC. Amazon VPC generates this value when you create a VPC.

      • SubnetIds (list) --

        A list of subnet IDs associated with the VPC endpoints for the domain.

        • (string) --

      • AvailabilityZones (list) --

        The list of Availability Zones associated with the VPC subnets.

        • (string) --

      • SecurityGroupIds (list) --

        The list of security group IDs associated with the VPC endpoints for the domain.

        • (string) --

    • CognitoOptions (dict) --

      Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

      • Enabled (boolean) --

        Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

      • UserPoolId (string) --

        The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • IdentityPoolId (string) --

        The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • RoleArn (string) --

        The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

    • EncryptionAtRestOptions (dict) --

      Encryption at rest settings for the domain.

      • Enabled (boolean) --

        True to enable encryption at rest.

      • KmsKeyId (string) --

        The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .

    • NodeToNodeEncryptionOptions (dict) --

      Whether node-to-node encryption is enabled or disabled.

      • Enabled (boolean) --

        True to enable node-to-node encryption.

    • AdvancedOptions (dict) --

      Key-value pairs that specify advanced configuration options.

      • (string) --

        • (string) --

    • LogPublishingOptions (dict) --

      Log publishing options for the domain.

      • (string) --

        The type of log file. Can be one of the following:

        • INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.

        • SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.

        • ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

        • AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

        • (dict) --

          Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs .

          Note

          After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

          • CloudWatchLogsLogGroupArn (string) --

            The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

          • Enabled (boolean) --

            Whether the log should be published.

    • ServiceSoftwareOptions (dict) --

      The current status of the domain's service software.

      • CurrentVersion (string) --

        The current service software version present on the domain.

      • NewVersion (string) --

        The new service software version, if one is available.

      • UpdateAvailable (boolean) --

        True if you're able to update your service software version. False if you can't update your service software version.

      • Cancellable (boolean) --

        True if you're able to cancel your service software version update. False if you can't cancel your service software update.

      • UpdateStatus (string) --

        The status of your service software update.

      • Description (string) --

        A description of the service software update status.

      • AutomatedUpdateDate (datetime) --

        The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

      • OptionalDeployment (boolean) --

        True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

    • DomainEndpointOptions (dict) --

      Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

      • EnforceHTTPS (boolean) --

        True to require that all traffic to the domain arrive over HTTPS.

      • TLSSecurityPolicy (string) --

        Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

        Can be one of the following values:

        • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

        • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

      • CustomEndpointEnabled (boolean) --

        Whether to enable a custom endpoint for the domain.

      • CustomEndpoint (string) --

        The fully qualified URL for the custom endpoint.

      • CustomEndpointCertificateArn (string) --

        The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

    • AdvancedSecurityOptions (dict) --

      Settings for fine-grained access control.

      • Enabled (boolean) --

        True if fine-grained access control is enabled.

      • InternalUserDatabaseEnabled (boolean) --

        True if the internal user database is enabled.

      • SAMLOptions (dict) --

        Container for information about the SAML configuration for OpenSearch Dashboards.

        • Enabled (boolean) --

          True if SAML is enabled.

        • Idp (dict) --

          Describes the SAML identity provider's information.

          • MetadataContent (string) --

            The metadata of the SAML application, in XML format.

          • EntityId (string) --

            The unique entity ID of the application in the SAML identity provider.

        • SubjectKey (string) --

          The key used for matching the SAML subject attribute.

        • RolesKey (string) --

          The key used for matching the SAML roles attribute.

        • SessionTimeoutMinutes (integer) --

          The duration, in minutes, after which a user session becomes inactive.

      • AnonymousAuthDisableDate (datetime) --

        Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .

      • AnonymousAuthEnabled (boolean) --

        True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .

    • AutoTuneOptions (dict) --

      Auto-Tune settings for the domain.

      • State (string) --

        The current state of Auto-Tune on the domain.

      • ErrorMessage (string) --

        Any errors that occurred while enabling or disabling Auto-Tune.

      • UseOffPeakWindow (boolean) --

        Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

    • ChangeProgressDetails (dict) --

      Information about a configuration change happening on the domain.

      • ChangeId (string) --

        The ID of the configuration change.

      • Message (string) --

        A message corresponding to the status of the configuration change.

    • OffPeakWindowOptions (dict) --

      Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

      • Enabled (boolean) --

        Whether to enable an off-peak window.

        This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

      • OffPeakWindow (dict) --

        Off-peak window settings for the domain.

        • WindowStartTime (dict) --

          A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

          • Hours (integer) --

            The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

          • Minutes (integer) --

            The start minute of the window, in UTC.

    • SoftwareUpdateOptions (dict) --

      Service software update options for the domain.

      • AutoSoftwareUpdateEnabled (boolean) --

        Whether automatic service software updates are enabled for the domain.

{'DomainStatus': {'AutoTuneOptions': {'UseOffPeakWindow': 'boolean'},
                  'OffPeakWindowOptions': {'Enabled': 'boolean',
                                           'OffPeakWindow': {'WindowStartTime': {'Hours': 'long',
                                                                                 'Minutes': 'long'}}},
                  'SoftwareUpdateOptions': {'AutoSoftwareUpdateEnabled': 'boolean'}}}

Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.

See also: AWS API Documentation

Request Syntax

client.delete_domain(
    DomainName='string'
)

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain you want to permanently delete.

rtype

dict

returns

Response Syntax

{
    'DomainStatus': {
        'DomainId': 'string',
        'DomainName': 'string',
        'ARN': 'string',
        'Created': True|False,
        'Deleted': True|False,
        'Endpoint': 'string',
        'Endpoints': {
            'string': 'string'
        },
        'Processing': True|False,
        'UpgradeProcessing': True|False,
        'EngineVersion': 'string',
        'ClusterConfig': {
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'InstanceCount': 123,
            'DedicatedMasterEnabled': True|False,
            'ZoneAwarenessEnabled': True|False,
            'ZoneAwarenessConfig': {
                'AvailabilityZoneCount': 123
            },
            'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'DedicatedMasterCount': 123,
            'WarmEnabled': True|False,
            'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
            'WarmCount': 123,
            'ColdStorageOptions': {
                'Enabled': True|False
            }
        },
        'EBSOptions': {
            'EBSEnabled': True|False,
            'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
            'VolumeSize': 123,
            'Iops': 123,
            'Throughput': 123
        },
        'AccessPolicies': 'string',
        'SnapshotOptions': {
            'AutomatedSnapshotStartHour': 123
        },
        'VPCOptions': {
            'VPCId': 'string',
            'SubnetIds': [
                'string',
            ],
            'AvailabilityZones': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CognitoOptions': {
            'Enabled': True|False,
            'UserPoolId': 'string',
            'IdentityPoolId': 'string',
            'RoleArn': 'string'
        },
        'EncryptionAtRestOptions': {
            'Enabled': True|False,
            'KmsKeyId': 'string'
        },
        'NodeToNodeEncryptionOptions': {
            'Enabled': True|False
        },
        'AdvancedOptions': {
            'string': 'string'
        },
        'LogPublishingOptions': {
            'string': {
                'CloudWatchLogsLogGroupArn': 'string',
                'Enabled': True|False
            }
        },
        'ServiceSoftwareOptions': {
            'CurrentVersion': 'string',
            'NewVersion': 'string',
            'UpdateAvailable': True|False,
            'Cancellable': True|False,
            'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
            'Description': 'string',
            'AutomatedUpdateDate': datetime(2015, 1, 1),
            'OptionalDeployment': True|False
        },
        'DomainEndpointOptions': {
            'EnforceHTTPS': True|False,
            'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
            'CustomEndpointEnabled': True|False,
            'CustomEndpoint': 'string',
            'CustomEndpointCertificateArn': 'string'
        },
        'AdvancedSecurityOptions': {
            'Enabled': True|False,
            'InternalUserDatabaseEnabled': True|False,
            'SAMLOptions': {
                'Enabled': True|False,
                'Idp': {
                    'MetadataContent': 'string',
                    'EntityId': 'string'
                },
                'SubjectKey': 'string',
                'RolesKey': 'string',
                'SessionTimeoutMinutes': 123
            },
            'AnonymousAuthDisableDate': datetime(2015, 1, 1),
            'AnonymousAuthEnabled': True|False
        },
        'AutoTuneOptions': {
            'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
            'ErrorMessage': 'string',
            'UseOffPeakWindow': True|False
        },
        'ChangeProgressDetails': {
            'ChangeId': 'string',
            'Message': 'string'
        },
        'OffPeakWindowOptions': {
            'Enabled': True|False,
            'OffPeakWindow': {
                'WindowStartTime': {
                    'Hours': 123,
                    'Minutes': 123
                }
            }
        },
        'SoftwareUpdateOptions': {
            'AutoSoftwareUpdateEnabled': True|False
        }
    }
}

Response Structure

• (dict) --

  The results of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.

  • DomainStatus (dict) --

    The status of the domain being deleted.

    • DomainId (string) --

      Unique identifier for the domain.

    • DomainName (string) --

      Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

    • ARN (string) --

      The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide .

    • Created (boolean) --

      Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

    • Deleted (boolean) --

      Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

    • Endpoint (string) --

      Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

    • Endpoints (dict) --

      The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

      • (string) --

        • (string) --

          The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com .

    • Processing (boolean) --

      The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

    • UpgradeProcessing (boolean) --

      The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

    • EngineVersion (string) --

      Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y .

    • ClusterConfig (dict) --

      Container for the cluster configuration of the domain.

      • InstanceType (string) --

        Instance type of data nodes in the cluster.

      • InstanceCount (integer) --

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • DedicatedMasterEnabled (boolean) --

        Indicates whether dedicated master nodes are enabled for the cluster.``True`` if the cluster will use a dedicated master node.``False`` if the cluster will not.

      • ZoneAwarenessEnabled (boolean) --

        Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

      • ZoneAwarenessConfig (dict) --

        Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .

        • AvailabilityZoneCount (integer) --

          If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3 . If your domain is provisioned within a VPC, this value be equal to number of subnets.

      • DedicatedMasterType (string) --

        OpenSearch Service instance type of the dedicated master nodes in the cluster.

      • DedicatedMasterCount (integer) --

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • WarmEnabled (boolean) --

        Whether to enable warm storage for the cluster.

      • WarmType (string) --

        The instance type for the cluster's warm nodes.

      • WarmCount (integer) --

        The number of warm nodes in the cluster.

      • ColdStorageOptions (dict) --

        Container for cold storage configuration options.

        • Enabled (boolean) --

          Whether to enable or disable cold storage on the domain.

    • EBSOptions (dict) --

      Container for EBS-based storage settings for the domain.

      • EBSEnabled (boolean) --

        Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

      • VolumeType (string) --

        Specifies the type of EBS volumes attached to data nodes.

      • VolumeSize (integer) --

        Specifies the size (in GiB) of EBS volumes attached to data nodes.

      • Iops (integer) --

        Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

      • Throughput (integer) --

        Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

    • AccessPolicies (string) --

      Identity and Access Management (IAM) policy document specifying the access policies for the domain.

    • SnapshotOptions (dict) --

      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

      • AutomatedSnapshotStartHour (integer) --

        The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

    • VPCOptions (dict) --

      The VPC configuration for the domain.

      • VPCId (string) --

        The ID for your VPC. Amazon VPC generates this value when you create a VPC.

      • SubnetIds (list) --

        A list of subnet IDs associated with the VPC endpoints for the domain.

        • (string) --

      • AvailabilityZones (list) --

        The list of Availability Zones associated with the VPC subnets.

        • (string) --

      • SecurityGroupIds (list) --

        The list of security group IDs associated with the VPC endpoints for the domain.

        • (string) --

    • CognitoOptions (dict) --

      Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

      • Enabled (boolean) --

        Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

      • UserPoolId (string) --

        The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • IdentityPoolId (string) --

        The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • RoleArn (string) --

        The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

    • EncryptionAtRestOptions (dict) --

      Encryption at rest settings for the domain.

      • Enabled (boolean) --

        True to enable encryption at rest.

      • KmsKeyId (string) --

        The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .

    • NodeToNodeEncryptionOptions (dict) --

      Whether node-to-node encryption is enabled or disabled.

      • Enabled (boolean) --

        True to enable node-to-node encryption.

    • AdvancedOptions (dict) --

      Key-value pairs that specify advanced configuration options.

      • (string) --

        • (string) --

    • LogPublishingOptions (dict) --

      Log publishing options for the domain.

      • (string) --

        The type of log file. Can be one of the following:

        • INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.

        • SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.

        • ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

        • AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

        • (dict) --

          Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs .

          Note

          After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

          • CloudWatchLogsLogGroupArn (string) --

            The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

          • Enabled (boolean) --

            Whether the log should be published.

    • ServiceSoftwareOptions (dict) --

      The current status of the domain's service software.

      • CurrentVersion (string) --

        The current service software version present on the domain.

      • NewVersion (string) --

        The new service software version, if one is available.

      • UpdateAvailable (boolean) --

        True if you're able to update your service software version. False if you can't update your service software version.

      • Cancellable (boolean) --

        True if you're able to cancel your service software version update. False if you can't cancel your service software update.

      • UpdateStatus (string) --

        The status of your service software update.

      • Description (string) --

        A description of the service software update status.

      • AutomatedUpdateDate (datetime) --

        The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

      • OptionalDeployment (boolean) --

        True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

    • DomainEndpointOptions (dict) --

      Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

      • EnforceHTTPS (boolean) --

        True to require that all traffic to the domain arrive over HTTPS.

      • TLSSecurityPolicy (string) --

        Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

        Can be one of the following values:

        • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

        • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

      • CustomEndpointEnabled (boolean) --

        Whether to enable a custom endpoint for the domain.

      • CustomEndpoint (string) --

        The fully qualified URL for the custom endpoint.

      • CustomEndpointCertificateArn (string) --

        The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

    • AdvancedSecurityOptions (dict) --

      Settings for fine-grained access control.

      • Enabled (boolean) --

        True if fine-grained access control is enabled.

      • InternalUserDatabaseEnabled (boolean) --

        True if the internal user database is enabled.

      • SAMLOptions (dict) --

        Container for information about the SAML configuration for OpenSearch Dashboards.

        • Enabled (boolean) --

          True if SAML is enabled.

        • Idp (dict) --

          Describes the SAML identity provider's information.

          • MetadataContent (string) --

            The metadata of the SAML application, in XML format.

          • EntityId (string) --

            The unique entity ID of the application in the SAML identity provider.

        • SubjectKey (string) --

          The key used for matching the SAML subject attribute.

        • RolesKey (string) --

          The key used for matching the SAML roles attribute.

        • SessionTimeoutMinutes (integer) --

          The duration, in minutes, after which a user session becomes inactive.

      • AnonymousAuthDisableDate (datetime) --

        Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .

      • AnonymousAuthEnabled (boolean) --

        True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .

    • AutoTuneOptions (dict) --

      Auto-Tune settings for the domain.

      • State (string) --

        The current state of Auto-Tune on the domain.

      • ErrorMessage (string) --

        Any errors that occurred while enabling or disabling Auto-Tune.

      • UseOffPeakWindow (boolean) --

        Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

    • ChangeProgressDetails (dict) --

      Information about a configuration change happening on the domain.

      • ChangeId (string) --

        The ID of the configuration change.

      • Message (string) --

        A message corresponding to the status of the configuration change.

    • OffPeakWindowOptions (dict) --

      Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

      • Enabled (boolean) --

        Whether to enable an off-peak window.

        This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

      • OffPeakWindow (dict) --

        Off-peak window settings for the domain.

        • WindowStartTime (dict) --

          A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

          • Hours (integer) --

            The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

          • Minutes (integer) --

            The start minute of the window, in UTC.

    • SoftwareUpdateOptions (dict) --

      Service software update options for the domain.

      • AutoSoftwareUpdateEnabled (boolean) --

        Whether automatic service software updates are enabled for the domain.

{'DomainStatus': {'AutoTuneOptions': {'UseOffPeakWindow': 'boolean'},
                  'OffPeakWindowOptions': {'Enabled': 'boolean',
                                           'OffPeakWindow': {'WindowStartTime': {'Hours': 'long',
                                                                                 'Minutes': 'long'}}},
                  'SoftwareUpdateOptions': {'AutoSoftwareUpdateEnabled': 'boolean'}}}

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

See also: AWS API Documentation

Request Syntax

client.describe_domain(
    DomainName='string'
)

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain that you want information about.

rtype

dict

returns

Response Syntax

{
    'DomainStatus': {
        'DomainId': 'string',
        'DomainName': 'string',
        'ARN': 'string',
        'Created': True|False,
        'Deleted': True|False,
        'Endpoint': 'string',
        'Endpoints': {
            'string': 'string'
        },
        'Processing': True|False,
        'UpgradeProcessing': True|False,
        'EngineVersion': 'string',
        'ClusterConfig': {
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'InstanceCount': 123,
            'DedicatedMasterEnabled': True|False,
            'ZoneAwarenessEnabled': True|False,
            'ZoneAwarenessConfig': {
                'AvailabilityZoneCount': 123
            },
            'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'DedicatedMasterCount': 123,
            'WarmEnabled': True|False,
            'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
            'WarmCount': 123,
            'ColdStorageOptions': {
                'Enabled': True|False
            }
        },
        'EBSOptions': {
            'EBSEnabled': True|False,
            'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
            'VolumeSize': 123,
            'Iops': 123,
            'Throughput': 123
        },
        'AccessPolicies': 'string',
        'SnapshotOptions': {
            'AutomatedSnapshotStartHour': 123
        },
        'VPCOptions': {
            'VPCId': 'string',
            'SubnetIds': [
                'string',
            ],
            'AvailabilityZones': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CognitoOptions': {
            'Enabled': True|False,
            'UserPoolId': 'string',
            'IdentityPoolId': 'string',
            'RoleArn': 'string'
        },
        'EncryptionAtRestOptions': {
            'Enabled': True|False,
            'KmsKeyId': 'string'
        },
        'NodeToNodeEncryptionOptions': {
            'Enabled': True|False
        },
        'AdvancedOptions': {
            'string': 'string'
        },
        'LogPublishingOptions': {
            'string': {
                'CloudWatchLogsLogGroupArn': 'string',
                'Enabled': True|False
            }
        },
        'ServiceSoftwareOptions': {
            'CurrentVersion': 'string',
            'NewVersion': 'string',
            'UpdateAvailable': True|False,
            'Cancellable': True|False,
            'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
            'Description': 'string',
            'AutomatedUpdateDate': datetime(2015, 1, 1),
            'OptionalDeployment': True|False
        },
        'DomainEndpointOptions': {
            'EnforceHTTPS': True|False,
            'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
            'CustomEndpointEnabled': True|False,
            'CustomEndpoint': 'string',
            'CustomEndpointCertificateArn': 'string'
        },
        'AdvancedSecurityOptions': {
            'Enabled': True|False,
            'InternalUserDatabaseEnabled': True|False,
            'SAMLOptions': {
                'Enabled': True|False,
                'Idp': {
                    'MetadataContent': 'string',
                    'EntityId': 'string'
                },
                'SubjectKey': 'string',
                'RolesKey': 'string',
                'SessionTimeoutMinutes': 123
            },
            'AnonymousAuthDisableDate': datetime(2015, 1, 1),
            'AnonymousAuthEnabled': True|False
        },
        'AutoTuneOptions': {
            'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
            'ErrorMessage': 'string',
            'UseOffPeakWindow': True|False
        },
        'ChangeProgressDetails': {
            'ChangeId': 'string',
            'Message': 'string'
        },
        'OffPeakWindowOptions': {
            'Enabled': True|False,
            'OffPeakWindow': {
                'WindowStartTime': {
                    'Hours': 123,
                    'Minutes': 123
                }
            }
        },
        'SoftwareUpdateOptions': {
            'AutoSoftwareUpdateEnabled': True|False
        }
    }
}

Response Structure

• (dict) --

  Contains the status of the domain specified in the request.

  • DomainStatus (dict) --

    List that contains the status of each specified OpenSearch Service domain.

    • DomainId (string) --

      Unique identifier for the domain.

    • DomainName (string) --

      Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

    • ARN (string) --

      The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide .

    • Created (boolean) --

      Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

    • Deleted (boolean) --

      Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

    • Endpoint (string) --

      Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

    • Endpoints (dict) --

      The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

      • (string) --

        • (string) --

          The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com .

    • Processing (boolean) --

      The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

    • UpgradeProcessing (boolean) --

      The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

    • EngineVersion (string) --

      Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y .

    • ClusterConfig (dict) --

      Container for the cluster configuration of the domain.

      • InstanceType (string) --

        Instance type of data nodes in the cluster.

      • InstanceCount (integer) --

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • DedicatedMasterEnabled (boolean) --

        Indicates whether dedicated master nodes are enabled for the cluster.``True`` if the cluster will use a dedicated master node.``False`` if the cluster will not.

      • ZoneAwarenessEnabled (boolean) --

        Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

      • ZoneAwarenessConfig (dict) --

        Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .

        • AvailabilityZoneCount (integer) --

          If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3 . If your domain is provisioned within a VPC, this value be equal to number of subnets.

      • DedicatedMasterType (string) --

        OpenSearch Service instance type of the dedicated master nodes in the cluster.

      • DedicatedMasterCount (integer) --

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • WarmEnabled (boolean) --

        Whether to enable warm storage for the cluster.

      • WarmType (string) --

        The instance type for the cluster's warm nodes.

      • WarmCount (integer) --

        The number of warm nodes in the cluster.

      • ColdStorageOptions (dict) --

        Container for cold storage configuration options.

        • Enabled (boolean) --

          Whether to enable or disable cold storage on the domain.

    • EBSOptions (dict) --

      Container for EBS-based storage settings for the domain.

      • EBSEnabled (boolean) --

        Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

      • VolumeType (string) --

        Specifies the type of EBS volumes attached to data nodes.

      • VolumeSize (integer) --

        Specifies the size (in GiB) of EBS volumes attached to data nodes.

      • Iops (integer) --

        Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

      • Throughput (integer) --

        Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

    • AccessPolicies (string) --

      Identity and Access Management (IAM) policy document specifying the access policies for the domain.

    • SnapshotOptions (dict) --

      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

      • AutomatedSnapshotStartHour (integer) --

        The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

    • VPCOptions (dict) --

      The VPC configuration for the domain.

      • VPCId (string) --

        The ID for your VPC. Amazon VPC generates this value when you create a VPC.

      • SubnetIds (list) --

        A list of subnet IDs associated with the VPC endpoints for the domain.

        • (string) --

      • AvailabilityZones (list) --

        The list of Availability Zones associated with the VPC subnets.

        • (string) --

      • SecurityGroupIds (list) --

        The list of security group IDs associated with the VPC endpoints for the domain.

        • (string) --

    • CognitoOptions (dict) --

      Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

      • Enabled (boolean) --

        Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

      • UserPoolId (string) --

        The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • IdentityPoolId (string) --

        The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • RoleArn (string) --

        The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

    • EncryptionAtRestOptions (dict) --

      Encryption at rest settings for the domain.

      • Enabled (boolean) --

        True to enable encryption at rest.

      • KmsKeyId (string) --

        The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .

    • NodeToNodeEncryptionOptions (dict) --

      Whether node-to-node encryption is enabled or disabled.

      • Enabled (boolean) --

        True to enable node-to-node encryption.

    • AdvancedOptions (dict) --

      Key-value pairs that specify advanced configuration options.

      • (string) --

        • (string) --

    • LogPublishingOptions (dict) --

      Log publishing options for the domain.

      • (string) --

        The type of log file. Can be one of the following:

        • INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.

        • SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.

        • ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

        • AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

        • (dict) --

          Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs .

          Note

          After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

          • CloudWatchLogsLogGroupArn (string) --

            The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

          • Enabled (boolean) --

            Whether the log should be published.

    • ServiceSoftwareOptions (dict) --

      The current status of the domain's service software.

      • CurrentVersion (string) --

        The current service software version present on the domain.

      • NewVersion (string) --

        The new service software version, if one is available.

      • UpdateAvailable (boolean) --

        True if you're able to update your service software version. False if you can't update your service software version.

      • Cancellable (boolean) --

        True if you're able to cancel your service software version update. False if you can't cancel your service software update.

      • UpdateStatus (string) --

        The status of your service software update.

      • Description (string) --

        A description of the service software update status.

      • AutomatedUpdateDate (datetime) --

        The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

      • OptionalDeployment (boolean) --

        True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

    • DomainEndpointOptions (dict) --

      Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

      • EnforceHTTPS (boolean) --

        True to require that all traffic to the domain arrive over HTTPS.

      • TLSSecurityPolicy (string) --

        Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

        Can be one of the following values:

        • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

        • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

      • CustomEndpointEnabled (boolean) --

        Whether to enable a custom endpoint for the domain.

      • CustomEndpoint (string) --

        The fully qualified URL for the custom endpoint.

      • CustomEndpointCertificateArn (string) --

        The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

    • AdvancedSecurityOptions (dict) --

      Settings for fine-grained access control.

      • Enabled (boolean) --

        True if fine-grained access control is enabled.

      • InternalUserDatabaseEnabled (boolean) --

        True if the internal user database is enabled.

      • SAMLOptions (dict) --

        Container for information about the SAML configuration for OpenSearch Dashboards.

        • Enabled (boolean) --

          True if SAML is enabled.

        • Idp (dict) --

          Describes the SAML identity provider's information.

          • MetadataContent (string) --

            The metadata of the SAML application, in XML format.

          • EntityId (string) --

            The unique entity ID of the application in the SAML identity provider.

        • SubjectKey (string) --

          The key used for matching the SAML subject attribute.

        • RolesKey (string) --

          The key used for matching the SAML roles attribute.

        • SessionTimeoutMinutes (integer) --

          The duration, in minutes, after which a user session becomes inactive.

      • AnonymousAuthDisableDate (datetime) --

        Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .

      • AnonymousAuthEnabled (boolean) --

        True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .

    • AutoTuneOptions (dict) --

      Auto-Tune settings for the domain.

      • State (string) --

        The current state of Auto-Tune on the domain.

      • ErrorMessage (string) --

        Any errors that occurred while enabling or disabling Auto-Tune.

      • UseOffPeakWindow (boolean) --

        Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

    • ChangeProgressDetails (dict) --

      Information about a configuration change happening on the domain.

      • ChangeId (string) --

        The ID of the configuration change.

      • Message (string) --

        A message corresponding to the status of the configuration change.

    • OffPeakWindowOptions (dict) --

      Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

      • Enabled (boolean) --

        Whether to enable an off-peak window.

        This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

      • OffPeakWindow (dict) --

        Off-peak window settings for the domain.

        • WindowStartTime (dict) --

          A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

          • Hours (integer) --

            The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

          • Minutes (integer) --

            The start minute of the window, in UTC.

    • SoftwareUpdateOptions (dict) --

      Service software update options for the domain.

      • AutoSoftwareUpdateEnabled (boolean) --

        Whether automatic service software updates are enabled for the domain.

{'DomainConfig': {'AutoTuneOptions': {'Options': {'UseOffPeakWindow': 'boolean'}},
                  'OffPeakWindowOptions': {'Options': {'Enabled': 'boolean',
                                                       'OffPeakWindow': {'WindowStartTime': {'Hours': 'long',
                                                                                             'Minutes': 'long'}}},
                                           'Status': {'CreationDate': 'timestamp',
                                                      'PendingDeletion': 'boolean',
                                                      'State': 'RequiresIndexDocuments '
                                                               '| Processing | '
                                                               'Active',
                                                      'UpdateDate': 'timestamp',
                                                      'UpdateVersion': 'integer'}},
                  'SoftwareUpdateOptions': {'Options': {'AutoSoftwareUpdateEnabled': 'boolean'},
                                            'Status': {'CreationDate': 'timestamp',
                                                       'PendingDeletion': 'boolean',
                                                       'State': 'RequiresIndexDocuments '
                                                                '| Processing '
                                                                '| Active',
                                                       'UpdateDate': 'timestamp',
                                                       'UpdateVersion': 'integer'}}}}

Returns the configuration of an Amazon OpenSearch Service domain.

See also: AWS API Documentation

Request Syntax

client.describe_domain_config(
    DomainName='string'
)

type DomainName

string

param DomainName

[REQUIRED]

Name of the OpenSearch Service domain configuration that you want to describe.

rtype

dict

returns

Response Syntax

{
    'DomainConfig': {
        'EngineVersion': {
            'Options': 'string',
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'ClusterConfig': {
            'Options': {
                'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'InstanceCount': 123,
                'DedicatedMasterEnabled': True|False,
                'ZoneAwarenessEnabled': True|False,
                'ZoneAwarenessConfig': {
                    'AvailabilityZoneCount': 123
                },
                'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'DedicatedMasterCount': 123,
                'WarmEnabled': True|False,
                'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
                'WarmCount': 123,
                'ColdStorageOptions': {
                    'Enabled': True|False
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'EBSOptions': {
            'Options': {
                'EBSEnabled': True|False,
                'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
                'VolumeSize': 123,
                'Iops': 123,
                'Throughput': 123
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AccessPolicies': {
            'Options': 'string',
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'SnapshotOptions': {
            'Options': {
                'AutomatedSnapshotStartHour': 123
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'VPCOptions': {
            'Options': {
                'VPCId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'AvailabilityZones': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'CognitoOptions': {
            'Options': {
                'Enabled': True|False,
                'UserPoolId': 'string',
                'IdentityPoolId': 'string',
                'RoleArn': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'EncryptionAtRestOptions': {
            'Options': {
                'Enabled': True|False,
                'KmsKeyId': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'NodeToNodeEncryptionOptions': {
            'Options': {
                'Enabled': True|False
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AdvancedOptions': {
            'Options': {
                'string': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'LogPublishingOptions': {
            'Options': {
                'string': {
                    'CloudWatchLogsLogGroupArn': 'string',
                    'Enabled': True|False
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'DomainEndpointOptions': {
            'Options': {
                'EnforceHTTPS': True|False,
                'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
                'CustomEndpointEnabled': True|False,
                'CustomEndpoint': 'string',
                'CustomEndpointCertificateArn': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AdvancedSecurityOptions': {
            'Options': {
                'Enabled': True|False,
                'InternalUserDatabaseEnabled': True|False,
                'SAMLOptions': {
                    'Enabled': True|False,
                    'Idp': {
                        'MetadataContent': 'string',
                        'EntityId': 'string'
                    },
                    'SubjectKey': 'string',
                    'RolesKey': 'string',
                    'SessionTimeoutMinutes': 123
                },
                'AnonymousAuthDisableDate': datetime(2015, 1, 1),
                'AnonymousAuthEnabled': True|False
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AutoTuneOptions': {
            'Options': {
                'DesiredState': 'ENABLED'|'DISABLED',
                'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK',
                'MaintenanceSchedules': [
                    {
                        'StartAt': datetime(2015, 1, 1),
                        'Duration': {
                            'Value': 123,
                            'Unit': 'HOURS'
                        },
                        'CronExpressionForRecurrence': 'string'
                    },
                ],
                'UseOffPeakWindow': True|False
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
                'ErrorMessage': 'string',
                'PendingDeletion': True|False
            }
        },
        'ChangeProgressDetails': {
            'ChangeId': 'string',
            'Message': 'string'
        },
        'OffPeakWindowOptions': {
            'Options': {
                'Enabled': True|False,
                'OffPeakWindow': {
                    'WindowStartTime': {
                        'Hours': 123,
                        'Minutes': 123
                    }
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'SoftwareUpdateOptions': {
            'Options': {
                'AutoSoftwareUpdateEnabled': True|False
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        }
    }
}

Response Structure

• (dict) --

  Contains the configuration information of the requested domain.

  • DomainConfig (dict) --

    Container for the configuration of the OpenSearch Service domain.

    • EngineVersion (dict) --

      The OpenSearch or Elasticsearch version that the domain is running.

      • Options (string) --

        The OpenSearch or Elasticsearch version for the specified domain.

      • Status (dict) --

        The status of the version options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • ClusterConfig (dict) --

      Container for the cluster configuration of a the domain.

      • Options (dict) --

        Cluster configuration options for the specified domain.

        • InstanceType (string) --

          Instance type of data nodes in the cluster.

        • InstanceCount (integer) --

          Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

        • DedicatedMasterEnabled (boolean) --

          Indicates whether dedicated master nodes are enabled for the cluster.``True`` if the cluster will use a dedicated master node.``False`` if the cluster will not.

        • ZoneAwarenessEnabled (boolean) --

          Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

        • ZoneAwarenessConfig (dict) --

          Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .

          • AvailabilityZoneCount (integer) --

            If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3 . If your domain is provisioned within a VPC, this value be equal to number of subnets.

        • DedicatedMasterType (string) --

          OpenSearch Service instance type of the dedicated master nodes in the cluster.

        • DedicatedMasterCount (integer) --

          Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

        • WarmEnabled (boolean) --

          Whether to enable warm storage for the cluster.

        • WarmType (string) --

          The instance type for the cluster's warm nodes.

        • WarmCount (integer) --

          The number of warm nodes in the cluster.

        • ColdStorageOptions (dict) --

          Container for cold storage configuration options.

          • Enabled (boolean) --

            Whether to enable or disable cold storage on the domain.

      • Status (dict) --

        The status of cluster configuration options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • EBSOptions (dict) --

      Container for EBS options configured for the domain.

      • Options (dict) --

        The configured EBS options for the specified domain.

        • EBSEnabled (boolean) --

          Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

        • VolumeType (string) --

          Specifies the type of EBS volumes attached to data nodes.

        • VolumeSize (integer) --

          Specifies the size (in GiB) of EBS volumes attached to data nodes.

        • Iops (integer) --

          Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

        • Throughput (integer) --

          Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

      • Status (dict) --

        The status of the EBS options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • AccessPolicies (dict) --

      Specifies the access policies for the domain.

      • Options (string) --

        The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies .

      • Status (dict) --

        The status of the access policy for the domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • SnapshotOptions (dict) --

      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

      • Options (dict) --

        The daily snapshot options specified for the domain.

        • AutomatedSnapshotStartHour (integer) --

          The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

      • Status (dict) --

        The status of a daily automated snapshot.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • VPCOptions (dict) --

      The current VPC options for the domain and the status of any updates to their configuration.

      • Options (dict) --

        The VPC options for the specified domain.

        • VPCId (string) --

          The ID for your VPC. Amazon VPC generates this value when you create a VPC.

        • SubnetIds (list) --

          A list of subnet IDs associated with the VPC endpoints for the domain.

          • (string) --

        • AvailabilityZones (list) --

          The list of Availability Zones associated with the VPC subnets.

          • (string) --

        • SecurityGroupIds (list) --

          The list of security group IDs associated with the VPC endpoints for the domain.

          • (string) --

      • Status (dict) --

        The status of the VPC options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • CognitoOptions (dict) --

      Container for Amazon Cognito options for the domain.

      • Options (dict) --

        Cognito options for the specified domain.

        • Enabled (boolean) --

          Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

        • UserPoolId (string) --

          The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

        • IdentityPoolId (string) --

          The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

        • RoleArn (string) --

          The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

      • Status (dict) --

        The status of the Cognito options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • EncryptionAtRestOptions (dict) --

      Key-value pairs to enable encryption at rest.

      • Options (dict) --

        Encryption at rest options for the specified domain.

        • Enabled (boolean) --

          True to enable encryption at rest.

        • KmsKeyId (string) --

          The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .

      • Status (dict) --

        The status of the encryption at rest options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • NodeToNodeEncryptionOptions (dict) --

      Whether node-to-node encryption is enabled or disabled.

      • Options (dict) --

        The node-to-node encryption options for the specified domain.

        • Enabled (boolean) --

          True to enable node-to-node encryption.

      • Status (dict) --

        The status of the node-to-node encryption options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • AdvancedOptions (dict) --

      Key-value pairs to specify advanced configuration options. For more information, see Advanced options .

      • Options (dict) --

        The status of advanced options for the specified domain.

        • (string) --

          • (string) --

      • Status (dict) --

        The status of advanced options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • LogPublishingOptions (dict) --

      Key-value pairs to configure slow log publishing.

      • Options (dict) --

        The log publishing options configured for the domain.

        • (string) --

          The type of log file. Can be one of the following:

          • INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.

          • SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.

          • ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

          • AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

          • (dict) --

            Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs .

            Note

            After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

            • CloudWatchLogsLogGroupArn (string) --

              The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

            • Enabled (boolean) --

              Whether the log should be published.

      • Status (dict) --

        The status of the log publishing options for the domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • DomainEndpointOptions (dict) --

      Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

      • Options (dict) --

        Options to configure the endpoint for a domain.

        • EnforceHTTPS (boolean) --

          True to require that all traffic to the domain arrive over HTTPS.

        • TLSSecurityPolicy (string) --

          Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

          Can be one of the following values:

          • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

          • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

        • CustomEndpointEnabled (boolean) --

          Whether to enable a custom endpoint for the domain.

        • CustomEndpoint (string) --

          The fully qualified URL for the custom endpoint.

        • CustomEndpointCertificateArn (string) --

          The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

      • Status (dict) --

        The status of the endpoint options for a domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • AdvancedSecurityOptions (dict) --

      Container for fine-grained access control settings for the domain.

      • Options (dict) --

        Container for fine-grained access control settings.

        • Enabled (boolean) --

          True if fine-grained access control is enabled.

        • InternalUserDatabaseEnabled (boolean) --

          True if the internal user database is enabled.

        • SAMLOptions (dict) --

          Container for information about the SAML configuration for OpenSearch Dashboards.

          • Enabled (boolean) --

            True if SAML is enabled.

          • Idp (dict) --

            Describes the SAML identity provider's information.

            • MetadataContent (string) --

              The metadata of the SAML application, in XML format.

            • EntityId (string) --

              The unique entity ID of the application in the SAML identity provider.

          • SubjectKey (string) --

            The key used for matching the SAML subject attribute.

          • RolesKey (string) --

            The key used for matching the SAML roles attribute.

          • SessionTimeoutMinutes (integer) --

            The duration, in minutes, after which a user session becomes inactive.

        • AnonymousAuthDisableDate (datetime) --

          Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .

        • AnonymousAuthEnabled (boolean) --

          True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .

      • Status (dict) --

        Status of the fine-grained access control settings for a domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • AutoTuneOptions (dict) --

      Container for Auto-Tune settings for the domain.

      • Options (dict) --

        Auto-Tune settings for updating a domain.

        • DesiredState (string) --

          Whether Auto-Tune is enabled or disabled.

        • RollbackOnDisable (string) --

          When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK , you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

        • MaintenanceSchedules (list) --

          DEPRECATED. Use off-peak window instead.

          A list of maintenance schedules during which Auto-Tune can deploy changes.

          • (dict) --

            Note

            This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows .

            The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service .

            • StartAt (datetime) --

              The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

            • Duration (dict) --

              The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"} .

              • Value (integer) --

                Integer to specify the value of a maintenance schedule duration.

              • Unit (string) --

                The unit of measurement for the duration of a maintenance schedule.

            • CronExpressionForRecurrence (string) --

              A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

        • UseOffPeakWindow (boolean) --

          Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

      • Status (dict) --

        The current status of Auto-Tune for a domain.

        • CreationDate (datetime) --

          Date and time when Auto-Tune was enabled for the domain.

        • UpdateDate (datetime) --

          Date and time when the Auto-Tune options were last updated for the domain.

        • UpdateVersion (integer) --

          The latest version of the Auto-Tune options.

        • State (string) --

          The current state of Auto-Tune on the domain.

        • ErrorMessage (string) --

          Any errors that occurred while enabling or disabling Auto-Tune.

        • PendingDeletion (boolean) --

          Indicates whether the domain is being deleted.

    • ChangeProgressDetails (dict) --

      Container for information about the progress of an existing configuration change.

      • ChangeId (string) --

        The ID of the configuration change.

      • Message (string) --

        A message corresponding to the status of the configuration change.

    • OffPeakWindowOptions (dict) --

      Container for off-peak window options for the domain.

      • Options (dict) --

        The domain's off-peak window configuration.

        • Enabled (boolean) --

          Whether to enable an off-peak window.

          This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

        • OffPeakWindow (dict) --

          Off-peak window settings for the domain.

          • WindowStartTime (dict) --

            A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

            • Hours (integer) --

              The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

            • Minutes (integer) --

              The start minute of the window, in UTC.

      • Status (dict) --

        The current status of off-peak window options.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • SoftwareUpdateOptions (dict) --

      Software update options for the domain.

      • Options (dict) --

        The service software update options for a domain.

        • AutoSoftwareUpdateEnabled (boolean) --

          Whether automatic service software updates are enabled for the domain.

      • Status (dict) --

        The status of service software update options, including creation date and last updated date.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

{'DomainStatusList': {'AutoTuneOptions': {'UseOffPeakWindow': 'boolean'},
                      'OffPeakWindowOptions': {'Enabled': 'boolean',
                                               'OffPeakWindow': {'WindowStartTime': {'Hours': 'long',
                                                                                     'Minutes': 'long'}}},
                      'SoftwareUpdateOptions': {'AutoSoftwareUpdateEnabled': 'boolean'}}}

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

See also: AWS API Documentation

Request Syntax

client.describe_domains(
    DomainNames=[
        'string',
    ]
)

type DomainNames

list

param DomainNames

[REQUIRED]

Array of OpenSearch Service domain names that you want information about. If you don't specify any domains, OpenSearch Service returns information about all domains owned by the account.

• (string) --

  The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

rtype

dict

returns

Response Syntax

{
    'DomainStatusList': [
        {
            'DomainId': 'string',
            'DomainName': 'string',
            'ARN': 'string',
            'Created': True|False,
            'Deleted': True|False,
            'Endpoint': 'string',
            'Endpoints': {
                'string': 'string'
            },
            'Processing': True|False,
            'UpgradeProcessing': True|False,
            'EngineVersion': 'string',
            'ClusterConfig': {
                'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'InstanceCount': 123,
                'DedicatedMasterEnabled': True|False,
                'ZoneAwarenessEnabled': True|False,
                'ZoneAwarenessConfig': {
                    'AvailabilityZoneCount': 123
                },
                'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'DedicatedMasterCount': 123,
                'WarmEnabled': True|False,
                'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
                'WarmCount': 123,
                'ColdStorageOptions': {
                    'Enabled': True|False
                }
            },
            'EBSOptions': {
                'EBSEnabled': True|False,
                'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
                'VolumeSize': 123,
                'Iops': 123,
                'Throughput': 123
            },
            'AccessPolicies': 'string',
            'SnapshotOptions': {
                'AutomatedSnapshotStartHour': 123
            },
            'VPCOptions': {
                'VPCId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'AvailabilityZones': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'CognitoOptions': {
                'Enabled': True|False,
                'UserPoolId': 'string',
                'IdentityPoolId': 'string',
                'RoleArn': 'string'
            },
            'EncryptionAtRestOptions': {
                'Enabled': True|False,
                'KmsKeyId': 'string'
            },
            'NodeToNodeEncryptionOptions': {
                'Enabled': True|False
            },
            'AdvancedOptions': {
                'string': 'string'
            },
            'LogPublishingOptions': {
                'string': {
                    'CloudWatchLogsLogGroupArn': 'string',
                    'Enabled': True|False
                }
            },
            'ServiceSoftwareOptions': {
                'CurrentVersion': 'string',
                'NewVersion': 'string',
                'UpdateAvailable': True|False,
                'Cancellable': True|False,
                'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
                'Description': 'string',
                'AutomatedUpdateDate': datetime(2015, 1, 1),
                'OptionalDeployment': True|False
            },
            'DomainEndpointOptions': {
                'EnforceHTTPS': True|False,
                'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
                'CustomEndpointEnabled': True|False,
                'CustomEndpoint': 'string',
                'CustomEndpointCertificateArn': 'string'
            },
            'AdvancedSecurityOptions': {
                'Enabled': True|False,
                'InternalUserDatabaseEnabled': True|False,
                'SAMLOptions': {
                    'Enabled': True|False,
                    'Idp': {
                        'MetadataContent': 'string',
                        'EntityId': 'string'
                    },
                    'SubjectKey': 'string',
                    'RolesKey': 'string',
                    'SessionTimeoutMinutes': 123
                },
                'AnonymousAuthDisableDate': datetime(2015, 1, 1),
                'AnonymousAuthEnabled': True|False
            },
            'AutoTuneOptions': {
                'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
                'ErrorMessage': 'string',
                'UseOffPeakWindow': True|False
            },
            'ChangeProgressDetails': {
                'ChangeId': 'string',
                'Message': 'string'
            },
            'OffPeakWindowOptions': {
                'Enabled': True|False,
                'OffPeakWindow': {
                    'WindowStartTime': {
                        'Hours': 123,
                        'Minutes': 123
                    }
                }
            },
            'SoftwareUpdateOptions': {
                'AutoSoftwareUpdateEnabled': True|False
            }
        },
    ]
}

Response Structure

• (dict) --

  Contains the status of the specified domains or all domains owned by the account.

  • DomainStatusList (list) --

    The status of the requested domains.

    • (dict) --

      The current status of an OpenSearch Service domain.

      • DomainId (string) --

        Unique identifier for the domain.

      • DomainName (string) --

        Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

      • ARN (string) --

        The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide .

      • Created (boolean) --

        Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

      • Deleted (boolean) --

        Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

      • Endpoint (string) --

        Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

      • Endpoints (dict) --

        The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

        • (string) --

          • (string) --

            The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com .

      • Processing (boolean) --

        The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

      • UpgradeProcessing (boolean) --

        The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

      • EngineVersion (string) --

        Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y .

      • ClusterConfig (dict) --

        Container for the cluster configuration of the domain.

        • InstanceType (string) --

          Instance type of data nodes in the cluster.

        • InstanceCount (integer) --

          Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

        • DedicatedMasterEnabled (boolean) --

          Indicates whether dedicated master nodes are enabled for the cluster.``True`` if the cluster will use a dedicated master node.``False`` if the cluster will not.

        • ZoneAwarenessEnabled (boolean) --

          Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

        • ZoneAwarenessConfig (dict) --

          Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .

          • AvailabilityZoneCount (integer) --

            If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3 . If your domain is provisioned within a VPC, this value be equal to number of subnets.

        • DedicatedMasterType (string) --

          OpenSearch Service instance type of the dedicated master nodes in the cluster.

        • DedicatedMasterCount (integer) --

          Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

        • WarmEnabled (boolean) --

          Whether to enable warm storage for the cluster.

        • WarmType (string) --

          The instance type for the cluster's warm nodes.

        • WarmCount (integer) --

          The number of warm nodes in the cluster.

        • ColdStorageOptions (dict) --

          Container for cold storage configuration options.

          • Enabled (boolean) --

            Whether to enable or disable cold storage on the domain.

      • EBSOptions (dict) --

        Container for EBS-based storage settings for the domain.

        • EBSEnabled (boolean) --

          Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

        • VolumeType (string) --

          Specifies the type of EBS volumes attached to data nodes.

        • VolumeSize (integer) --

          Specifies the size (in GiB) of EBS volumes attached to data nodes.

        • Iops (integer) --

          Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

        • Throughput (integer) --

          Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

      • AccessPolicies (string) --

        Identity and Access Management (IAM) policy document specifying the access policies for the domain.

      • SnapshotOptions (dict) --

        DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

        • AutomatedSnapshotStartHour (integer) --

          The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

      • VPCOptions (dict) --

        The VPC configuration for the domain.

        • VPCId (string) --

          The ID for your VPC. Amazon VPC generates this value when you create a VPC.

        • SubnetIds (list) --

          A list of subnet IDs associated with the VPC endpoints for the domain.

          • (string) --

        • AvailabilityZones (list) --

          The list of Availability Zones associated with the VPC subnets.

          • (string) --

        • SecurityGroupIds (list) --

          The list of security group IDs associated with the VPC endpoints for the domain.

          • (string) --

      • CognitoOptions (dict) --

        Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

        • Enabled (boolean) --

          Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

        • UserPoolId (string) --

          The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

        • IdentityPoolId (string) --

          The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

        • RoleArn (string) --

          The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

      • EncryptionAtRestOptions (dict) --

        Encryption at rest settings for the domain.

        • Enabled (boolean) --

          True to enable encryption at rest.

        • KmsKeyId (string) --

          The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .

      • NodeToNodeEncryptionOptions (dict) --

        Whether node-to-node encryption is enabled or disabled.

        • Enabled (boolean) --

          True to enable node-to-node encryption.

      • AdvancedOptions (dict) --

        Key-value pairs that specify advanced configuration options.

        • (string) --

          • (string) --

      • LogPublishingOptions (dict) --

        Log publishing options for the domain.

        • (string) --

          The type of log file. Can be one of the following:

          • INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.

          • SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.

          • ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

          • AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

          • (dict) --

            Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs .

            Note

            After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

            • CloudWatchLogsLogGroupArn (string) --

              The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

            • Enabled (boolean) --

              Whether the log should be published.

      • ServiceSoftwareOptions (dict) --

        The current status of the domain's service software.

        • CurrentVersion (string) --

          The current service software version present on the domain.

        • NewVersion (string) --

          The new service software version, if one is available.

        • UpdateAvailable (boolean) --

          True if you're able to update your service software version. False if you can't update your service software version.

        • Cancellable (boolean) --

          True if you're able to cancel your service software version update. False if you can't cancel your service software update.

        • UpdateStatus (string) --

          The status of your service software update.

        • Description (string) --

          A description of the service software update status.

        • AutomatedUpdateDate (datetime) --

          The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

        • OptionalDeployment (boolean) --

          True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

      • DomainEndpointOptions (dict) --

        Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

        • EnforceHTTPS (boolean) --

          True to require that all traffic to the domain arrive over HTTPS.

        • TLSSecurityPolicy (string) --

          Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

          Can be one of the following values:

          • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

          • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

        • CustomEndpointEnabled (boolean) --

          Whether to enable a custom endpoint for the domain.

        • CustomEndpoint (string) --

          The fully qualified URL for the custom endpoint.

        • CustomEndpointCertificateArn (string) --

          The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

      • AdvancedSecurityOptions (dict) --

        Settings for fine-grained access control.

        • Enabled (boolean) --

          True if fine-grained access control is enabled.

        • InternalUserDatabaseEnabled (boolean) --

          True if the internal user database is enabled.

        • SAMLOptions (dict) --

          Container for information about the SAML configuration for OpenSearch Dashboards.

          • Enabled (boolean) --

            True if SAML is enabled.

          • Idp (dict) --

            Describes the SAML identity provider's information.

            • MetadataContent (string) --

              The metadata of the SAML application, in XML format.

            • EntityId (string) --

              The unique entity ID of the application in the SAML identity provider.

          • SubjectKey (string) --

            The key used for matching the SAML subject attribute.

          • RolesKey (string) --

            The key used for matching the SAML roles attribute.

          • SessionTimeoutMinutes (integer) --

            The duration, in minutes, after which a user session becomes inactive.

        • AnonymousAuthDisableDate (datetime) --

          Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .

        • AnonymousAuthEnabled (boolean) --

          True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .

      • AutoTuneOptions (dict) --

        Auto-Tune settings for the domain.

        • State (string) --

          The current state of Auto-Tune on the domain.

        • ErrorMessage (string) --

          Any errors that occurred while enabling or disabling Auto-Tune.

        • UseOffPeakWindow (boolean) --

          Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

      • ChangeProgressDetails (dict) --

        Information about a configuration change happening on the domain.

        • ChangeId (string) --

          The ID of the configuration change.

        • Message (string) --

          A message corresponding to the status of the configuration change.

      • OffPeakWindowOptions (dict) --

        Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

        • Enabled (boolean) --

          Whether to enable an off-peak window.

          This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

        • OffPeakWindow (dict) --

          Off-peak window settings for the domain.

          • WindowStartTime (dict) --

            A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

            • Hours (integer) --

              The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

            • Minutes (integer) --

              The start minute of the window, in UTC.

      • SoftwareUpdateOptions (dict) --

        Service software update options for the domain.

        • AutoSoftwareUpdateEnabled (boolean) --

          Whether automatic service software updates are enabled for the domain.

{'DryRunConfig': {'AutoTuneOptions': {'UseOffPeakWindow': 'boolean'},
                  'OffPeakWindowOptions': {'Enabled': 'boolean',
                                           'OffPeakWindow': {'WindowStartTime': {'Hours': 'long',
                                                                                 'Minutes': 'long'}}},
                  'SoftwareUpdateOptions': {'AutoSoftwareUpdateEnabled': 'boolean'}}}

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment .

See also: AWS API Documentation

Request Syntax

client.describe_dry_run_progress(
    DomainName='string',
    DryRunId='string',
    LoadDryRunConfig=True|False
)

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

type DryRunId

string

param DryRunId

The unique identifier of the dry run.

type LoadDryRunConfig

boolean

param LoadDryRunConfig

Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make on the domain.

rtype

dict

returns

Response Syntax

{
    'DryRunProgressStatus': {
        'DryRunId': 'string',
        'DryRunStatus': 'string',
        'CreationDate': 'string',
        'UpdateDate': 'string',
        'ValidationFailures': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ]
    },
    'DryRunConfig': {
        'DomainId': 'string',
        'DomainName': 'string',
        'ARN': 'string',
        'Created': True|False,
        'Deleted': True|False,
        'Endpoint': 'string',
        'Endpoints': {
            'string': 'string'
        },
        'Processing': True|False,
        'UpgradeProcessing': True|False,
        'EngineVersion': 'string',
        'ClusterConfig': {
            'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'InstanceCount': 123,
            'DedicatedMasterEnabled': True|False,
            'ZoneAwarenessEnabled': True|False,
            'ZoneAwarenessConfig': {
                'AvailabilityZoneCount': 123
            },
            'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
            'DedicatedMasterCount': 123,
            'WarmEnabled': True|False,
            'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
            'WarmCount': 123,
            'ColdStorageOptions': {
                'Enabled': True|False
            }
        },
        'EBSOptions': {
            'EBSEnabled': True|False,
            'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
            'VolumeSize': 123,
            'Iops': 123,
            'Throughput': 123
        },
        'AccessPolicies': 'string',
        'SnapshotOptions': {
            'AutomatedSnapshotStartHour': 123
        },
        'VPCOptions': {
            'VPCId': 'string',
            'SubnetIds': [
                'string',
            ],
            'AvailabilityZones': [
                'string',
            ],
            'SecurityGroupIds': [
                'string',
            ]
        },
        'CognitoOptions': {
            'Enabled': True|False,
            'UserPoolId': 'string',
            'IdentityPoolId': 'string',
            'RoleArn': 'string'
        },
        'EncryptionAtRestOptions': {
            'Enabled': True|False,
            'KmsKeyId': 'string'
        },
        'NodeToNodeEncryptionOptions': {
            'Enabled': True|False
        },
        'AdvancedOptions': {
            'string': 'string'
        },
        'LogPublishingOptions': {
            'string': {
                'CloudWatchLogsLogGroupArn': 'string',
                'Enabled': True|False
            }
        },
        'ServiceSoftwareOptions': {
            'CurrentVersion': 'string',
            'NewVersion': 'string',
            'UpdateAvailable': True|False,
            'Cancellable': True|False,
            'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
            'Description': 'string',
            'AutomatedUpdateDate': datetime(2015, 1, 1),
            'OptionalDeployment': True|False
        },
        'DomainEndpointOptions': {
            'EnforceHTTPS': True|False,
            'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
            'CustomEndpointEnabled': True|False,
            'CustomEndpoint': 'string',
            'CustomEndpointCertificateArn': 'string'
        },
        'AdvancedSecurityOptions': {
            'Enabled': True|False,
            'InternalUserDatabaseEnabled': True|False,
            'SAMLOptions': {
                'Enabled': True|False,
                'Idp': {
                    'MetadataContent': 'string',
                    'EntityId': 'string'
                },
                'SubjectKey': 'string',
                'RolesKey': 'string',
                'SessionTimeoutMinutes': 123
            },
            'AnonymousAuthDisableDate': datetime(2015, 1, 1),
            'AnonymousAuthEnabled': True|False
        },
        'AutoTuneOptions': {
            'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
            'ErrorMessage': 'string',
            'UseOffPeakWindow': True|False
        },
        'ChangeProgressDetails': {
            'ChangeId': 'string',
            'Message': 'string'
        },
        'OffPeakWindowOptions': {
            'Enabled': True|False,
            'OffPeakWindow': {
                'WindowStartTime': {
                    'Hours': 123,
                    'Minutes': 123
                }
            }
        },
        'SoftwareUpdateOptions': {
            'AutoSoftwareUpdateEnabled': True|False
        }
    },
    'DryRunResults': {
        'DeploymentType': 'string',
        'Message': 'string'
    }
}

Response Structure

• (dict) --

  • DryRunProgressStatus (dict) --

    The current status of the dry run, including any validation errors.

    • DryRunId (string) --

      The unique identifier of the dry run.

    • DryRunStatus (string) --

      The current status of the dry run.

    • CreationDate (string) --

      The timestamp when the dry run was initiated.

    • UpdateDate (string) --

      The timestamp when the dry run was last updated.

    • ValidationFailures (list) --

      Any validation failures that occurred as a result of the dry run.

      • (dict) --

        A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.

        • Code (string) --

          The error code of the failure.

        • Message (string) --

          A message corresponding to the failure.

  • DryRunConfig (dict) --

    Details about the changes you're planning to make on the domain.

    • DomainId (string) --

      Unique identifier for the domain.

    • DomainName (string) --

      Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

    • ARN (string) --

      The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide .

    • Created (boolean) --

      Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

    • Deleted (boolean) --

      Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

    • Endpoint (string) --

      Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

    • Endpoints (dict) --

      The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .

      • (string) --

        • (string) --

          The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com .

    • Processing (boolean) --

      The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

    • UpgradeProcessing (boolean) --

      The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

    • EngineVersion (string) --

      Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y .

    • ClusterConfig (dict) --

      Container for the cluster configuration of the domain.

      • InstanceType (string) --

        Instance type of data nodes in the cluster.

      • InstanceCount (integer) --

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • DedicatedMasterEnabled (boolean) --

        Indicates whether dedicated master nodes are enabled for the cluster.``True`` if the cluster will use a dedicated master node.``False`` if the cluster will not.

      • ZoneAwarenessEnabled (boolean) --

        Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

      • ZoneAwarenessConfig (dict) --

        Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .

        • AvailabilityZoneCount (integer) --

          If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3 . If your domain is provisioned within a VPC, this value be equal to number of subnets.

      • DedicatedMasterType (string) --

        OpenSearch Service instance type of the dedicated master nodes in the cluster.

      • DedicatedMasterCount (integer) --

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • WarmEnabled (boolean) --

        Whether to enable warm storage for the cluster.

      • WarmType (string) --

        The instance type for the cluster's warm nodes.

      • WarmCount (integer) --

        The number of warm nodes in the cluster.

      • ColdStorageOptions (dict) --

        Container for cold storage configuration options.

        • Enabled (boolean) --

          Whether to enable or disable cold storage on the domain.

    • EBSOptions (dict) --

      Container for EBS-based storage settings for the domain.

      • EBSEnabled (boolean) --

        Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

      • VolumeType (string) --

        Specifies the type of EBS volumes attached to data nodes.

      • VolumeSize (integer) --

        Specifies the size (in GiB) of EBS volumes attached to data nodes.

      • Iops (integer) --

        Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

      • Throughput (integer) --

        Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

    • AccessPolicies (string) --

      Identity and Access Management (IAM) policy document specifying the access policies for the domain.

    • SnapshotOptions (dict) --

      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

      • AutomatedSnapshotStartHour (integer) --

        The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

    • VPCOptions (dict) --

      The VPC configuration for the domain.

      • VPCId (string) --

        The ID for your VPC. Amazon VPC generates this value when you create a VPC.

      • SubnetIds (list) --

        A list of subnet IDs associated with the VPC endpoints for the domain.

        • (string) --

      • AvailabilityZones (list) --

        The list of Availability Zones associated with the VPC subnets.

        • (string) --

      • SecurityGroupIds (list) --

        The list of security group IDs associated with the VPC endpoints for the domain.

        • (string) --

    • CognitoOptions (dict) --

      Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

      • Enabled (boolean) --

        Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

      • UserPoolId (string) --

        The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • IdentityPoolId (string) --

        The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • RoleArn (string) --

        The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

    • EncryptionAtRestOptions (dict) --

      Encryption at rest settings for the domain.

      • Enabled (boolean) --

        True to enable encryption at rest.

      • KmsKeyId (string) --

        The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .

    • NodeToNodeEncryptionOptions (dict) --

      Whether node-to-node encryption is enabled or disabled.

      • Enabled (boolean) --

        True to enable node-to-node encryption.

    • AdvancedOptions (dict) --

      Key-value pairs that specify advanced configuration options.

      • (string) --

        • (string) --

    • LogPublishingOptions (dict) --

      Log publishing options for the domain.

      • (string) --

        The type of log file. Can be one of the following:

        • INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.

        • SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.

        • ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

        • AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

        • (dict) --

          Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs .

          Note

          After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

          • CloudWatchLogsLogGroupArn (string) --

            The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

          • Enabled (boolean) --

            Whether the log should be published.

    • ServiceSoftwareOptions (dict) --

      The current status of the domain's service software.

      • CurrentVersion (string) --

        The current service software version present on the domain.

      • NewVersion (string) --

        The new service software version, if one is available.

      • UpdateAvailable (boolean) --

        True if you're able to update your service software version. False if you can't update your service software version.

      • Cancellable (boolean) --

        True if you're able to cancel your service software version update. False if you can't cancel your service software update.

      • UpdateStatus (string) --

        The status of your service software update.

      • Description (string) --

        A description of the service software update status.

      • AutomatedUpdateDate (datetime) --

        The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

      • OptionalDeployment (boolean) --

        True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

    • DomainEndpointOptions (dict) --

      Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

      • EnforceHTTPS (boolean) --

        True to require that all traffic to the domain arrive over HTTPS.

      • TLSSecurityPolicy (string) --

        Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

        Can be one of the following values:

        • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

        • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

      • CustomEndpointEnabled (boolean) --

        Whether to enable a custom endpoint for the domain.

      • CustomEndpoint (string) --

        The fully qualified URL for the custom endpoint.

      • CustomEndpointCertificateArn (string) --

        The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

    • AdvancedSecurityOptions (dict) --

      Settings for fine-grained access control.

      • Enabled (boolean) --

        True if fine-grained access control is enabled.

      • InternalUserDatabaseEnabled (boolean) --

        True if the internal user database is enabled.

      • SAMLOptions (dict) --

        Container for information about the SAML configuration for OpenSearch Dashboards.

        • Enabled (boolean) --

          True if SAML is enabled.

        • Idp (dict) --

          Describes the SAML identity provider's information.

          • MetadataContent (string) --

            The metadata of the SAML application, in XML format.

          • EntityId (string) --

            The unique entity ID of the application in the SAML identity provider.

        • SubjectKey (string) --

          The key used for matching the SAML subject attribute.

        • RolesKey (string) --

          The key used for matching the SAML roles attribute.

        • SessionTimeoutMinutes (integer) --

          The duration, in minutes, after which a user session becomes inactive.

      • AnonymousAuthDisableDate (datetime) --

        Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .

      • AnonymousAuthEnabled (boolean) --

        True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .

    • AutoTuneOptions (dict) --

      Auto-Tune settings for the domain.

      • State (string) --

        The current state of Auto-Tune on the domain.

      • ErrorMessage (string) --

        Any errors that occurred while enabling or disabling Auto-Tune.

      • UseOffPeakWindow (boolean) --

        Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

    • ChangeProgressDetails (dict) --

      Information about a configuration change happening on the domain.

      • ChangeId (string) --

        The ID of the configuration change.

      • Message (string) --

        A message corresponding to the status of the configuration change.

    • OffPeakWindowOptions (dict) --

      Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

      • Enabled (boolean) --

        Whether to enable an off-peak window.

        This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

      • OffPeakWindow (dict) --

        Off-peak window settings for the domain.

        • WindowStartTime (dict) --

          A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

          • Hours (integer) --

            The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

          • Minutes (integer) --

            The start minute of the window, in UTC.

    • SoftwareUpdateOptions (dict) --

      Service software update options for the domain.

      • AutoSoftwareUpdateEnabled (boolean) --

        Whether automatic service software updates are enabled for the domain.

  • DryRunResults (dict) --

    The results of the dry run.

    • DeploymentType (string) --

      Specifies the way in which OpenSearch Service will apply an update. Possible values are:

      • Blue/Green - The update requires a blue/green deployment.

      • DynamicUpdate - No blue/green deployment required

      • Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete.

      • None - The request doesn't include any configuration changes.

    • Message (string) --

      A message corresponding to the deployment type.

{'DesiredStartTime': 'long', 'ScheduleAt': 'NOW | TIMESTAMP | OFF_PEAK_WINDOW'}

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service .

See also: AWS API Documentation

Request Syntax

client.start_service_software_update(
    DomainName='string',
    ScheduleAt='NOW'|'TIMESTAMP'|'OFF_PEAK_WINDOW',
    DesiredStartTime=123
)

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain that you want to update to the latest service software.

type ScheduleAt

string

param ScheduleAt

When to start the service software update.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime .

• OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime , and TIMESTAMP if you do.

type DesiredStartTime

integer

param DesiredStartTime

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP .

rtype

dict

returns

Response Syntax

{
    'ServiceSoftwareOptions': {
        'CurrentVersion': 'string',
        'NewVersion': 'string',
        'UpdateAvailable': True|False,
        'Cancellable': True|False,
        'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE',
        'Description': 'string',
        'AutomatedUpdateDate': datetime(2015, 1, 1),
        'OptionalDeployment': True|False
    }
}

Response Structure

• (dict) --

  Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.

  • ServiceSoftwareOptions (dict) --

    The current status of the OpenSearch Service software update.

    • CurrentVersion (string) --

      The current service software version present on the domain.

    • NewVersion (string) --

      The new service software version, if one is available.

    • UpdateAvailable (boolean) --

      True if you're able to update your service software version. False if you can't update your service software version.

    • Cancellable (boolean) --

      True if you're able to cancel your service software version update. False if you can't cancel your service software update.

    • UpdateStatus (string) --

      The status of your service software update.

    • Description (string) --

      A description of the service software update status.

    • AutomatedUpdateDate (datetime) --

      The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

    • OptionalDeployment (boolean) --

      True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

{'AutoTuneOptions': {'UseOffPeakWindow': 'boolean'},
 'OffPeakWindowOptions': {'Enabled': 'boolean',
                          'OffPeakWindow': {'WindowStartTime': {'Hours': 'long',
                                                                'Minutes': 'long'}}},
 'SoftwareUpdateOptions': {'AutoSoftwareUpdateEnabled': 'boolean'}}

{'DomainConfig': {'AutoTuneOptions': {'Options': {'UseOffPeakWindow': 'boolean'}},
                  'OffPeakWindowOptions': {'Options': {'Enabled': 'boolean',
                                                       'OffPeakWindow': {'WindowStartTime': {'Hours': 'long',
                                                                                             'Minutes': 'long'}}},
                                           'Status': {'CreationDate': 'timestamp',
                                                      'PendingDeletion': 'boolean',
                                                      'State': 'RequiresIndexDocuments '
                                                               '| Processing | '
                                                               'Active',
                                                      'UpdateDate': 'timestamp',
                                                      'UpdateVersion': 'integer'}},
                  'SoftwareUpdateOptions': {'Options': {'AutoSoftwareUpdateEnabled': 'boolean'},
                                            'Status': {'CreationDate': 'timestamp',
                                                       'PendingDeletion': 'boolean',
                                                       'State': 'RequiresIndexDocuments '
                                                                '| Processing '
                                                                '| Active',
                                                       'UpdateDate': 'timestamp',
                                                       'UpdateVersion': 'integer'}}}}

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

See also: AWS API Documentation

Request Syntax

client.update_domain_config(
    DomainName='string',
    ClusterConfig={
        'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
        'InstanceCount': 123,
        'DedicatedMasterEnabled': True|False,
        'ZoneAwarenessEnabled': True|False,
        'ZoneAwarenessConfig': {
            'AvailabilityZoneCount': 123
        },
        'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
        'DedicatedMasterCount': 123,
        'WarmEnabled': True|False,
        'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
        'WarmCount': 123,
        'ColdStorageOptions': {
            'Enabled': True|False
        }
    },
    EBSOptions={
        'EBSEnabled': True|False,
        'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
        'VolumeSize': 123,
        'Iops': 123,
        'Throughput': 123
    },
    SnapshotOptions={
        'AutomatedSnapshotStartHour': 123
    },
    VPCOptions={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    },
    CognitoOptions={
        'Enabled': True|False,
        'UserPoolId': 'string',
        'IdentityPoolId': 'string',
        'RoleArn': 'string'
    },
    AdvancedOptions={
        'string': 'string'
    },
    AccessPolicies='string',
    LogPublishingOptions={
        'string': {
            'CloudWatchLogsLogGroupArn': 'string',
            'Enabled': True|False
        }
    },
    EncryptionAtRestOptions={
        'Enabled': True|False,
        'KmsKeyId': 'string'
    },
    DomainEndpointOptions={
        'EnforceHTTPS': True|False,
        'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
        'CustomEndpointEnabled': True|False,
        'CustomEndpoint': 'string',
        'CustomEndpointCertificateArn': 'string'
    },
    NodeToNodeEncryptionOptions={
        'Enabled': True|False
    },
    AdvancedSecurityOptions={
        'Enabled': True|False,
        'InternalUserDatabaseEnabled': True|False,
        'MasterUserOptions': {
            'MasterUserARN': 'string',
            'MasterUserName': 'string',
            'MasterUserPassword': 'string'
        },
        'SAMLOptions': {
            'Enabled': True|False,
            'Idp': {
                'MetadataContent': 'string',
                'EntityId': 'string'
            },
            'MasterUserName': 'string',
            'MasterBackendRole': 'string',
            'SubjectKey': 'string',
            'RolesKey': 'string',
            'SessionTimeoutMinutes': 123
        },
        'AnonymousAuthEnabled': True|False
    },
    AutoTuneOptions={
        'DesiredState': 'ENABLED'|'DISABLED',
        'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK',
        'MaintenanceSchedules': [
            {
                'StartAt': datetime(2015, 1, 1),
                'Duration': {
                    'Value': 123,
                    'Unit': 'HOURS'
                },
                'CronExpressionForRecurrence': 'string'
            },
        ],
        'UseOffPeakWindow': True|False
    },
    DryRun=True|False,
    DryRunMode='Basic'|'Verbose',
    OffPeakWindowOptions={
        'Enabled': True|False,
        'OffPeakWindow': {
            'WindowStartTime': {
                'Hours': 123,
                'Minutes': 123
            }
        }
    },
    SoftwareUpdateOptions={
        'AutoSoftwareUpdateEnabled': True|False
    }
)

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain that you're updating.

type ClusterConfig

dict

param ClusterConfig

Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

• InstanceType (string) --

  Instance type of data nodes in the cluster.

• InstanceCount (integer) --

  Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

• DedicatedMasterEnabled (boolean) --

  Indicates whether dedicated master nodes are enabled for the cluster.``True`` if the cluster will use a dedicated master node.``False`` if the cluster will not.

• ZoneAwarenessEnabled (boolean) --

  Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

• ZoneAwarenessConfig (dict) --

  Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .

  • AvailabilityZoneCount (integer) --

    If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3 . If your domain is provisioned within a VPC, this value be equal to number of subnets.

• DedicatedMasterType (string) --

  OpenSearch Service instance type of the dedicated master nodes in the cluster.

• DedicatedMasterCount (integer) --

  Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

• WarmEnabled (boolean) --

  Whether to enable warm storage for the cluster.

• WarmType (string) --

  The instance type for the cluster's warm nodes.

• WarmCount (integer) --

  The number of warm nodes in the cluster.

• ColdStorageOptions (dict) --

  Container for cold storage configuration options.

  • Enabled (boolean) -- [REQUIRED]

    Whether to enable or disable cold storage on the domain.

type EBSOptions

dict

param EBSOptions

The type and size of the EBS volume to attach to instances in the domain.

• EBSEnabled (boolean) --

  Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

• VolumeType (string) --

  Specifies the type of EBS volumes attached to data nodes.

• VolumeSize (integer) --

  Specifies the size (in GiB) of EBS volumes attached to data nodes.

• Iops (integer) --

  Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

• Throughput (integer) --

  Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

type SnapshotOptions

dict

param SnapshotOptions

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

• AutomatedSnapshotStartHour (integer) --

  The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

type VPCOptions

dict

param VPCOptions

Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

• SubnetIds (list) --

  A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

  • (string) --

• SecurityGroupIds (list) --

  The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

  • (string) --

type CognitoOptions

dict

param CognitoOptions

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

• Enabled (boolean) --

  Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

• UserPoolId (string) --

  The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

• IdentityPoolId (string) --

  The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

• RoleArn (string) --

  The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

type AdvancedOptions

dict

param AdvancedOptions

Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

• "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

• "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

• "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

• "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

For more information, see Advanced cluster parameters .

• (string) --

  • (string) --

type AccessPolicies

string

param AccessPolicies

Identity and Access Management (IAM) access policy as a JSON-formatted string.

type LogPublishingOptions

dict

param LogPublishingOptions

Options to publish OpenSearch logs to Amazon CloudWatch Logs.

• (string) --

  The type of log file. Can be one of the following:

  • INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.

  • SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.

  • ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

  • AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

  • (dict) --

    Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs .

    Note

    After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

    • CloudWatchLogsLogGroupArn (string) --

      The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

    • Enabled (boolean) --

      Whether the log should be published.

type EncryptionAtRestOptions

dict

param EncryptionAtRestOptions

Encryption at rest options for the domain.

• Enabled (boolean) --

  True to enable encryption at rest.

• KmsKeyId (string) --

  The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .

type DomainEndpointOptions

dict

param DomainEndpointOptions

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

• EnforceHTTPS (boolean) --

  True to require that all traffic to the domain arrive over HTTPS.

• TLSSecurityPolicy (string) --

  Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

  Can be one of the following values:

  • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

  • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

• CustomEndpointEnabled (boolean) --

  Whether to enable a custom endpoint for the domain.

• CustomEndpoint (string) --

  The fully qualified URL for the custom endpoint.

• CustomEndpointCertificateArn (string) --

  The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

type NodeToNodeEncryptionOptions

dict

param NodeToNodeEncryptionOptions

Node-to-node encryption options for the domain.

• Enabled (boolean) --

  True to enable node-to-node encryption.

type AdvancedSecurityOptions

dict

param AdvancedSecurityOptions

Options for fine-grained access control.

• Enabled (boolean) --

  True to enable fine-grained access control.

• InternalUserDatabaseEnabled (boolean) --

  True to enable the internal user database.

• MasterUserOptions (dict) --

  Container for information about the master user.

  • MasterUserARN (string) --

    Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false .

  • MasterUserName (string) --

    User name for the master user. Only specify if InternalUserDatabaseEnabled is true .

  • MasterUserPassword (string) --

    Password for the master user. Only specify if InternalUserDatabaseEnabled is true .

• SAMLOptions (dict) --

  Container for information about the SAML configuration for OpenSearch Dashboards.

  • Enabled (boolean) --

    True to enable SAML authentication for a domain.

  • Idp (dict) --

    The SAML Identity Provider's information.

    • MetadataContent (string) -- [REQUIRED]

      The metadata of the SAML application, in XML format.

    • EntityId (string) -- [REQUIRED]

      The unique entity ID of the application in the SAML identity provider.

  • MasterUserName (string) --

    The SAML master user name, which is stored in the domain's internal user database.

  • MasterBackendRole (string) --

    The backend role that the SAML master user is mapped to.

  • SubjectKey (string) --

    Element of the SAML assertion to use for the user name. Default is NameID .

  • RolesKey (string) --

    Element of the SAML assertion to use for backend roles. Default is roles .

  • SessionTimeoutMinutes (integer) --

    The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

• AnonymousAuthEnabled (boolean) --

  True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .

type AutoTuneOptions

dict

param AutoTuneOptions

Options for Auto-Tune.

• DesiredState (string) --

  Whether Auto-Tune is enabled or disabled.

• RollbackOnDisable (string) --

  When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK , you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

• MaintenanceSchedules (list) --

  DEPRECATED. Use off-peak window instead.

  A list of maintenance schedules during which Auto-Tune can deploy changes.

  • (dict) --

    Note

    This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows .

    The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service .

    • StartAt (datetime) --

      The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

    • Duration (dict) --

      The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"} .

      • Value (integer) --

        Integer to specify the value of a maintenance schedule duration.

      • Unit (string) --

        The unit of measurement for the duration of a maintenance schedule.

    • CronExpressionForRecurrence (string) --

      A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

• UseOffPeakWindow (boolean) --

  Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

type DryRun

boolean

param DryRun

This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.

type DryRunMode

string

param DryRunMode

The type of dry run to perform.

• Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.

• Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update .

type OffPeakWindowOptions

dict

param OffPeakWindowOptions

Off-peak window options for the domain.

• Enabled (boolean) --

  Whether to enable an off-peak window.

  This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

• OffPeakWindow (dict) --

  Off-peak window settings for the domain.

  • WindowStartTime (dict) --

    A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

    • Hours (integer) -- [REQUIRED]

      The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

    • Minutes (integer) -- [REQUIRED]

      The start minute of the window, in UTC.

type SoftwareUpdateOptions

dict

param SoftwareUpdateOptions

Service software update options for the domain.

• AutoSoftwareUpdateEnabled (boolean) --

  Whether automatic service software updates are enabled for the domain.

rtype

dict

returns

Response Syntax

{
    'DomainConfig': {
        'EngineVersion': {
            'Options': 'string',
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'ClusterConfig': {
            'Options': {
                'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'InstanceCount': 123,
                'DedicatedMasterEnabled': True|False,
                'ZoneAwarenessEnabled': True|False,
                'ZoneAwarenessConfig': {
                    'AvailabilityZoneCount': 123
                },
                'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                'DedicatedMasterCount': 123,
                'WarmEnabled': True|False,
                'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
                'WarmCount': 123,
                'ColdStorageOptions': {
                    'Enabled': True|False
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'EBSOptions': {
            'Options': {
                'EBSEnabled': True|False,
                'VolumeType': 'standard'|'gp2'|'io1'|'gp3',
                'VolumeSize': 123,
                'Iops': 123,
                'Throughput': 123
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AccessPolicies': {
            'Options': 'string',
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'SnapshotOptions': {
            'Options': {
                'AutomatedSnapshotStartHour': 123
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'VPCOptions': {
            'Options': {
                'VPCId': 'string',
                'SubnetIds': [
                    'string',
                ],
                'AvailabilityZones': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'CognitoOptions': {
            'Options': {
                'Enabled': True|False,
                'UserPoolId': 'string',
                'IdentityPoolId': 'string',
                'RoleArn': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'EncryptionAtRestOptions': {
            'Options': {
                'Enabled': True|False,
                'KmsKeyId': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'NodeToNodeEncryptionOptions': {
            'Options': {
                'Enabled': True|False
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AdvancedOptions': {
            'Options': {
                'string': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'LogPublishingOptions': {
            'Options': {
                'string': {
                    'CloudWatchLogsLogGroupArn': 'string',
                    'Enabled': True|False
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'DomainEndpointOptions': {
            'Options': {
                'EnforceHTTPS': True|False,
                'TLSSecurityPolicy': 'Policy-Min-TLS-1-0-2019-07'|'Policy-Min-TLS-1-2-2019-07',
                'CustomEndpointEnabled': True|False,
                'CustomEndpoint': 'string',
                'CustomEndpointCertificateArn': 'string'
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AdvancedSecurityOptions': {
            'Options': {
                'Enabled': True|False,
                'InternalUserDatabaseEnabled': True|False,
                'SAMLOptions': {
                    'Enabled': True|False,
                    'Idp': {
                        'MetadataContent': 'string',
                        'EntityId': 'string'
                    },
                    'SubjectKey': 'string',
                    'RolesKey': 'string',
                    'SessionTimeoutMinutes': 123
                },
                'AnonymousAuthDisableDate': datetime(2015, 1, 1),
                'AnonymousAuthEnabled': True|False
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'AutoTuneOptions': {
            'Options': {
                'DesiredState': 'ENABLED'|'DISABLED',
                'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK',
                'MaintenanceSchedules': [
                    {
                        'StartAt': datetime(2015, 1, 1),
                        'Duration': {
                            'Value': 123,
                            'Unit': 'HOURS'
                        },
                        'CronExpressionForRecurrence': 'string'
                    },
                ],
                'UseOffPeakWindow': True|False
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR',
                'ErrorMessage': 'string',
                'PendingDeletion': True|False
            }
        },
        'ChangeProgressDetails': {
            'ChangeId': 'string',
            'Message': 'string'
        },
        'OffPeakWindowOptions': {
            'Options': {
                'Enabled': True|False,
                'OffPeakWindow': {
                    'WindowStartTime': {
                        'Hours': 123,
                        'Minutes': 123
                    }
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        },
        'SoftwareUpdateOptions': {
            'Options': {
                'AutoSoftwareUpdateEnabled': True|False
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active',
                'PendingDeletion': True|False
            }
        }
    },
    'DryRunResults': {
        'DeploymentType': 'string',
        'Message': 'string'
    },
    'DryRunProgressStatus': {
        'DryRunId': 'string',
        'DryRunStatus': 'string',
        'CreationDate': 'string',
        'UpdateDate': 'string',
        'ValidationFailures': [
            {
                'Code': 'string',
                'Message': 'string'
            },
        ]
    }
}

Response Structure

• (dict) --

  The results of an UpdateDomain request. Contains the status of the domain being updated.

  • DomainConfig (dict) --

    The status of the updated domain.

    • EngineVersion (dict) --

      The OpenSearch or Elasticsearch version that the domain is running.

      • Options (string) --

        The OpenSearch or Elasticsearch version for the specified domain.

      • Status (dict) --

        The status of the version options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • ClusterConfig (dict) --

      Container for the cluster configuration of a the domain.

      • Options (dict) --

        Cluster configuration options for the specified domain.

        • InstanceType (string) --

          Instance type of data nodes in the cluster.

        • InstanceCount (integer) --

          Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

        • DedicatedMasterEnabled (boolean) --

          Indicates whether dedicated master nodes are enabled for the cluster.``True`` if the cluster will use a dedicated master node.``False`` if the cluster will not.

        • ZoneAwarenessEnabled (boolean) --

          Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service .

        • ZoneAwarenessConfig (dict) --

          Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .

          • AvailabilityZoneCount (integer) --

            If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3 . If your domain is provisioned within a VPC, this value be equal to number of subnets.

        • DedicatedMasterType (string) --

          OpenSearch Service instance type of the dedicated master nodes in the cluster.

        • DedicatedMasterCount (integer) --

          Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

        • WarmEnabled (boolean) --

          Whether to enable warm storage for the cluster.

        • WarmType (string) --

          The instance type for the cluster's warm nodes.

        • WarmCount (integer) --

          The number of warm nodes in the cluster.

        • ColdStorageOptions (dict) --

          Container for cold storage configuration options.

          • Enabled (boolean) --

            Whether to enable or disable cold storage on the domain.

      • Status (dict) --

        The status of cluster configuration options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • EBSOptions (dict) --

      Container for EBS options configured for the domain.

      • Options (dict) --

        The configured EBS options for the specified domain.

        • EBSEnabled (boolean) --

          Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

        • VolumeType (string) --

          Specifies the type of EBS volumes attached to data nodes.

        • VolumeSize (integer) --

          Specifies the size (in GiB) of EBS volumes attached to data nodes.

        • Iops (integer) --

          Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

        • Throughput (integer) --

          Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

      • Status (dict) --

        The status of the EBS options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • AccessPolicies (dict) --

      Specifies the access policies for the domain.

      • Options (string) --

        The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies .

      • Status (dict) --

        The status of the access policy for the domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • SnapshotOptions (dict) --

      DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

      • Options (dict) --

        The daily snapshot options specified for the domain.

        • AutomatedSnapshotStartHour (integer) --

          The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

      • Status (dict) --

        The status of a daily automated snapshot.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • VPCOptions (dict) --

      The current VPC options for the domain and the status of any updates to their configuration.

      • Options (dict) --

        The VPC options for the specified domain.

        • VPCId (string) --

          The ID for your VPC. Amazon VPC generates this value when you create a VPC.

        • SubnetIds (list) --

          A list of subnet IDs associated with the VPC endpoints for the domain.

          • (string) --

        • AvailabilityZones (list) --

          The list of Availability Zones associated with the VPC subnets.

          • (string) --

        • SecurityGroupIds (list) --

          The list of security group IDs associated with the VPC endpoints for the domain.

          • (string) --

      • Status (dict) --

        The status of the VPC options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • CognitoOptions (dict) --

      Container for Amazon Cognito options for the domain.

      • Options (dict) --

        Cognito options for the specified domain.

        • Enabled (boolean) --

          Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

        • UserPoolId (string) --

          The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

        • IdentityPoolId (string) --

          The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

        • RoleArn (string) --

          The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

      • Status (dict) --

        The status of the Cognito options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • EncryptionAtRestOptions (dict) --

      Key-value pairs to enable encryption at rest.

      • Options (dict) --

        Encryption at rest options for the specified domain.

        • Enabled (boolean) --

          True to enable encryption at rest.

        • KmsKeyId (string) --

          The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .

      • Status (dict) --

        The status of the encryption at rest options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • NodeToNodeEncryptionOptions (dict) --

      Whether node-to-node encryption is enabled or disabled.

      • Options (dict) --

        The node-to-node encryption options for the specified domain.

        • Enabled (boolean) --

          True to enable node-to-node encryption.

      • Status (dict) --

        The status of the node-to-node encryption options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • AdvancedOptions (dict) --

      Key-value pairs to specify advanced configuration options. For more information, see Advanced options .

      • Options (dict) --

        The status of advanced options for the specified domain.

        • (string) --

          • (string) --

      • Status (dict) --

        The status of advanced options for the specified domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • LogPublishingOptions (dict) --

      Key-value pairs to configure slow log publishing.

      • Options (dict) --

        The log publishing options configured for the domain.

        • (string) --

          The type of log file. Can be one of the following:

          • INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.

          • SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.

          • ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

          • AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.

          • (dict) --

            Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs .

            Note

            After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

            • CloudWatchLogsLogGroupArn (string) --

              The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

            • Enabled (boolean) --

              Whether the log should be published.

      • Status (dict) --

        The status of the log publishing options for the domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • DomainEndpointOptions (dict) --

      Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

      • Options (dict) --

        Options to configure the endpoint for a domain.

        • EnforceHTTPS (boolean) --

          True to require that all traffic to the domain arrive over HTTPS.

        • TLSSecurityPolicy (string) --

          Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

          Can be one of the following values:

          • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

          • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

        • CustomEndpointEnabled (boolean) --

          Whether to enable a custom endpoint for the domain.

        • CustomEndpoint (string) --

          The fully qualified URL for the custom endpoint.

        • CustomEndpointCertificateArn (string) --

          The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

      • Status (dict) --

        The status of the endpoint options for a domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • AdvancedSecurityOptions (dict) --

      Container for fine-grained access control settings for the domain.

      • Options (dict) --

        Container for fine-grained access control settings.

        • Enabled (boolean) --

          True if fine-grained access control is enabled.

        • InternalUserDatabaseEnabled (boolean) --

          True if the internal user database is enabled.

        • SAMLOptions (dict) --

          Container for information about the SAML configuration for OpenSearch Dashboards.

          • Enabled (boolean) --

            True if SAML is enabled.

          • Idp (dict) --

            Describes the SAML identity provider's information.

            • MetadataContent (string) --

              The metadata of the SAML application, in XML format.

            • EntityId (string) --

              The unique entity ID of the application in the SAML identity provider.

          • SubjectKey (string) --

            The key used for matching the SAML subject attribute.

          • RolesKey (string) --

            The key used for matching the SAML roles attribute.

          • SessionTimeoutMinutes (integer) --

            The duration, in minutes, after which a user session becomes inactive.

        • AnonymousAuthDisableDate (datetime) --

          Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain .

        • AnonymousAuthEnabled (boolean) --

          True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain .

      • Status (dict) --

        Status of the fine-grained access control settings for a domain.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • AutoTuneOptions (dict) --

      Container for Auto-Tune settings for the domain.

      • Options (dict) --

        Auto-Tune settings for updating a domain.

        • DesiredState (string) --

          Whether Auto-Tune is enabled or disabled.

        • RollbackOnDisable (string) --

          When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK , you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

        • MaintenanceSchedules (list) --

          DEPRECATED. Use off-peak window instead.

          A list of maintenance schedules during which Auto-Tune can deploy changes.

          • (dict) --

            Note

            This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows .

            The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service .

            • StartAt (datetime) --

              The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

            • Duration (dict) --

              The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"} .

              • Value (integer) --

                Integer to specify the value of a maintenance schedule duration.

              • Unit (string) --

                The unit of measurement for the duration of a maintenance schedule.

            • CronExpressionForRecurrence (string) --

              A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

        • UseOffPeakWindow (boolean) --

          Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

      • Status (dict) --

        The current status of Auto-Tune for a domain.

        • CreationDate (datetime) --

          Date and time when Auto-Tune was enabled for the domain.

        • UpdateDate (datetime) --

          Date and time when the Auto-Tune options were last updated for the domain.

        • UpdateVersion (integer) --

          The latest version of the Auto-Tune options.

        • State (string) --

          The current state of Auto-Tune on the domain.

        • ErrorMessage (string) --

          Any errors that occurred while enabling or disabling Auto-Tune.

        • PendingDeletion (boolean) --

          Indicates whether the domain is being deleted.

    • ChangeProgressDetails (dict) --

      Container for information about the progress of an existing configuration change.

      • ChangeId (string) --

        The ID of the configuration change.

      • Message (string) --

        A message corresponding to the status of the configuration change.

    • OffPeakWindowOptions (dict) --

      Container for off-peak window options for the domain.

      • Options (dict) --

        The domain's off-peak window configuration.

        • Enabled (boolean) --

          Whether to enable an off-peak window.

          This option is only available when modifying a domain created prior to February 13, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

        • OffPeakWindow (dict) --

          Off-peak window settings for the domain.

          • WindowStartTime (dict) --

            A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

            • Hours (integer) --

              The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

            • Minutes (integer) --

              The start minute of the window, in UTC.

      • Status (dict) --

        The current status of off-peak window options.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

    • SoftwareUpdateOptions (dict) --

      Software update options for the domain.

      • Options (dict) --

        The service software update options for a domain.

        • AutoSoftwareUpdateEnabled (boolean) --

          Whether automatic service software updates are enabled for the domain.

      • Status (dict) --

        The status of service software update options, including creation date and last updated date.

        • CreationDate (datetime) --

          The timestamp when the entity was created.

        • UpdateDate (datetime) --

          The timestamp of the last time the entity was updated.

        • UpdateVersion (integer) --

          The latest version of the entity.

        • State (string) --

          The state of the entity.

        • PendingDeletion (boolean) --

          Indicates whether the entity is being deleted.

  • DryRunResults (dict) --

    Results of the dry run performed in the update domain request.

    • DeploymentType (string) --

      Specifies the way in which OpenSearch Service will apply an update. Possible values are:

      • Blue/Green - The update requires a blue/green deployment.

      • DynamicUpdate - No blue/green deployment required

      • Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete.

      • None - The request doesn't include any configuration changes.

    • Message (string) --

      A message corresponding to the deployment type.

  • DryRunProgressStatus (dict) --

    The status of the dry run being performed on the domain, if any.

    • DryRunId (string) --

      The unique identifier of the dry run.

    • DryRunStatus (string) --

      The current status of the dry run.

    • CreationDate (string) --

      The timestamp when the dry run was initiated.

    • UpdateDate (string) --

      The timestamp when the dry run was last updated.

    • ValidationFailures (list) --

      Any validation failures that occurred as a result of the dry run.

      • (dict) --

        A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.

        • Code (string) --

          The error code of the failure.

        • Message (string) --

          A message corresponding to the failure.