Table of Contents
OpenSearchService.Client¶A low-level client representing Amazon OpenSearch Service
Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains.
For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service requests is Region specific: es.*region* .amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.
import boto3
client = boto3.client('opensearch')
These are the available methods:
accept_inbound_connection()add_tags()associate_package()authorize_vpc_endpoint_access()can_paginate()cancel_service_software_update()close()create_domain()create_outbound_connection()create_package()create_vpc_endpoint()delete_domain()delete_inbound_connection()delete_outbound_connection()delete_package()delete_vpc_endpoint()describe_domain()describe_domain_auto_tunes()describe_domain_change_progress()describe_domain_config()describe_domains()describe_dry_run_progress()describe_inbound_connections()describe_instance_type_limits()describe_outbound_connections()describe_packages()describe_reserved_instance_offerings()describe_reserved_instances()describe_vpc_endpoints()dissociate_package()get_compatible_versions()get_package_version_history()get_paginator()get_upgrade_history()get_upgrade_status()get_waiter()list_domain_names()list_domains_for_package()list_instance_type_details()list_packages_for_domain()list_scheduled_actions()list_tags()list_versions()list_vpc_endpoint_access()list_vpc_endpoints()list_vpc_endpoints_for_domain()purchase_reserved_instance_offering()reject_inbound_connection()remove_tags()revoke_vpc_endpoint_access()start_service_software_update()update_domain_config()update_package()update_scheduled_action()update_vpc_endpoint()upgrade_domain()accept_inbound_connection(**kwargs)¶Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.accept_inbound_connection(
ConnectionId='string'
)
[REQUIRED]
The ID of the inbound connection to accept.
{
'Connection': {
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT'
}
}
Response Structure
Contains details about the accepted inbound connection.
Information about the accepted inbound connection.
Information about the source (local) domain.
Information about an Amazon OpenSearch Service domain.
The Amazon Web Services account ID of the domain owner.
Name of the domain.
The Amazon Web Services Region in which the domain is located.
Information about the destination (remote) domain.
Information about an Amazon OpenSearch Service domain.
The Amazon Web Services account ID of the domain owner.
Name of the domain.
The Amazon Web Services Region in which the domain is located.
The unique identifier of the connection.
The current status of the connection.
The status code for the connection. Can be one of the following:
Information about the connection.
The connection mode.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionAttaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
See also: AWS API Documentation
Request Syntax
response = client.add_tags(
ARN='string',
TagList=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.
[REQUIRED]
List of resource tags.
A tag (key-value pair) for an Amazon OpenSearch Service resource.
The tag key. Tag keys must be unique for the domain to which they are attached.
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
None
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.InternalExceptionassociate_package(**kwargs)¶Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.associate_package(
PackageID='string',
DomainName='string'
)
[REQUIRED]
Internal ID of the package to associate with a domain. Use DescribePackages to find this value.
[REQUIRED]
Name of the domain to associate the package with.
dict
Response Syntax
{
'DomainPackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'LastUpdated': datetime(2015, 1, 1),
'DomainName': 'string',
'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
'PackageVersion': 'string',
'ReferencePath': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Container for the response returned by the AssociatePackage operation.
DomainPackageDetails (dict) --
Information about a package that is associated with a domain.
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User-specified name of the package.
PackageType (string) --
The type of package.
LastUpdated (datetime) --
Timestamp of the most recent update to the package association status.
DomainName (string) --
Name of the domain that the package is associated with.
DomainPackageStatus (string) --
State of the association.
PackageVersion (string) --
The current version of the package.
ReferencePath (string) --
Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.AccessDeniedExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.ConflictExceptionProvides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
See also: AWS API Documentation
Request Syntax
response = client.authorize_vpc_endpoint_access(
DomainName='string',
Account='string'
)
[REQUIRED]
The name of the OpenSearch Service domain to provide access to.
[REQUIRED]
The Amazon Web Services account ID to grant access to.
dict
Response Syntax
{
'AuthorizedPrincipal': {
'PrincipalType': 'AWS_ACCOUNT'|'AWS_SERVICE',
'Principal': 'string'
}
}
Response Structure
(dict) --
AuthorizedPrincipal (dict) --
Information about the Amazon Web Services account or service that was provided access to the domain.
PrincipalType (string) --
The type of principal.
Principal (string) --
The IAM principal that is allowed access to the domain.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.BaseExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_service_software_update(**kwargs)¶Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE . For more information, see Service software updates in Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.cancel_service_software_update(
DomainName='string'
)
[REQUIRED]
Name of the OpenSearch Service domain that you want to cancel the service software update on.
{
'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
Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.
Container for the state of your domain relative to the latest service software.
The current service software version present on the domain.
The new service software version, if one is available.
True if you're able to update your service software version. False if you can't update your service software version.
True if you're able to cancel your service software version update. False if you can't cancel your service software update.
The status of your service software update.
A description of the service software update status.
The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptionclose()¶Closes underlying endpoint connections.
create_domain(**kwargs)¶Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
See also: AWS API Documentation
Request Syntax
response = 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
}
)
[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.
OpenSearch_1.0 or Elasticsearch_7.9 . For more information, see Creating and managing Amazon OpenSearch Service domains.Container for the cluster configuration of a domain.
Instance type of data nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
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.
Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .
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.
OpenSearch Service instance type of the dedicated master nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
Whether to enable warm storage for the cluster.
The instance type for the cluster's warm nodes.
The number of warm nodes in the cluster.
Container for cold storage configuration options.
Whether to enable or disable cold storage on the domain.
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
Specifies the type of EBS volumes attached to data nodes.
Specifies the size (in GiB) of EBS volumes attached to data nodes.
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.
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
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.
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.
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.
Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
Key-value pairs to enable encryption at rest.
True to enable encryption at rest.
The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .
Enables node-to-node encryption.
True to enable node-to-node encryption.
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.
Key-value pairs to configure slow log publishing.
The type of log file. Can be one of the following:
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.
The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Whether the log should be published.
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
True to require that all traffic to the domain arrive over HTTPS.
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Whether to enable a custom endpoint for the domain.
The fully qualified URL for the custom endpoint.
The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
Options for fine-grained access control.
True to enable fine-grained access control.
True to enable the internal user database.
Container for information about the master user.
Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false .
User name for the master user. Only specify if InternalUserDatabaseEnabled is true .
Password for the master user. Only specify if InternalUserDatabaseEnabled is true .
Container for information about the SAML configuration for OpenSearch Dashboards.
True to enable SAML authentication for a domain.
The SAML Identity Provider's information.
The metadata of the SAML application, in XML format.
The unique entity ID of the application in the SAML identity provider.
The SAML master user name, which is stored in the domain's internal user database.
The backend role that the SAML master user is mapped to.
Element of the SAML assertion to use for the user name. Default is NameID .
Element of the SAML assertion to use for backend roles. Default is roles .
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
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.
List of tags to add to the domain upon creation.
A tag (key-value pair) for an Amazon OpenSearch Service resource.
The tag key. Tag keys must be unique for the domain to which they are attached.
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
Options for Auto-Tune.
Whether Auto-Tune is enabled or disabled.
A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.
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.
The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"} .
Integer to specify the value of a maintenance schedule duration.
The unit of measurement for the duration of a maintenance schedule.
A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.
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.
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.
Off-peak window settings for the domain.
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.
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.
The start minute of the window, in UTC.
Software update options for the domain.
Whether automatic service software updates are enabled for the domain.
dict
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.
AvailabilityZones (list) --
The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds (list) --
The list of security group IDs associated with the VPC endpoints for the domain.
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.
LogPublishingOptions (dict) --
Log publishing options for the domain.
(string) --
The type of log file. Can be one of the following:
(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:
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.InvalidTypeExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.ResourceAlreadyExistsExceptionOpenSearchService.Client.exceptions.ValidationExceptioncreate_outbound_connection(**kwargs)¶Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.create_outbound_connection(
LocalDomainInfo={
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
RemoteDomainInfo={
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
ConnectionAlias='string',
ConnectionMode='DIRECT'|'VPC_ENDPOINT'
)
[REQUIRED]
Name and Region of the source (local) domain.
Information about an Amazon OpenSearch Service domain.
The Amazon Web Services account ID of the domain owner.
Name of the domain.
The Amazon Web Services Region in which the domain is located.
[REQUIRED]
Name and Region of the destination (remote) domain.
Information about an Amazon OpenSearch Service domain.
The Amazon Web Services account ID of the domain owner.
Name of the domain.
The Amazon Web Services Region in which the domain is located.
[REQUIRED]
Name of the connection.
dict
Response Syntax
{
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionAlias': 'string',
'ConnectionStatus': {
'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionId': 'string',
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT',
'ConnectionProperties': {
'Endpoint': 'string'
}
}
Response Structure
(dict) --
The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.
LocalDomainInfo (dict) --
Information about the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo (dict) --
Information about the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
ConnectionAlias (string) --
Name of the connection.
ConnectionStatus (dict) --
The status of the connection.
StatusCode (string) --
The status code for the outbound connection. Can be one of the following:
Message (string) --
Verbose information for the outbound connection.
ConnectionId (string) --
The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.
ConnectionMode (string) --
The connection mode.
ConnectionProperties (dict) --
The ConnectionProperties for the newly created connection.
Endpoint (string) --
The endpoint of the remote domain.
Exceptions
OpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceAlreadyExistsExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptioncreate_package(**kwargs)¶Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.create_package(
PackageName='string',
PackageType='TXT-DICTIONARY',
PackageDescription='string',
PackageSource={
'S3BucketName': 'string',
'S3Key': 'string'
}
)
[REQUIRED]
Unique name for the package.
[REQUIRED]
Type of package.
[REQUIRED]
The Amazon S3 location from which to import the package.
The name of the Amazon S3 bucket containing the package.
Key (file name) of the package.
dict
Response Syntax
{
'PackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'PackageDescription': 'string',
'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'AvailablePackageVersion': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Container for the response returned by the CreatePackage operation.
PackageDetails (dict) --
Basic information about an OpenSearch Service package.
PackageID (string) --
The unique identifier of the package.
PackageName (string) --
User-specified name of the package.
PackageType (string) --
The type of package.
PackageDescription (string) --
User-specified description of the package.
PackageStatus (string) --
Current status of the package.
CreatedAt (datetime) --
The timestamp when the package was created.
LastUpdatedAt (datetime) --
Date and time when the package was last updated.
AvailablePackageVersion (string) --
The package version.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.InvalidTypeExceptionOpenSearchService.Client.exceptions.ResourceAlreadyExistsExceptionOpenSearchService.Client.exceptions.AccessDeniedExceptionOpenSearchService.Client.exceptions.ValidationExceptioncreate_vpc_endpoint(**kwargs)¶Creates an Amazon OpenSearch Service-managed VPC endpoint.
See also: AWS API Documentation
Request Syntax
response = client.create_vpc_endpoint(
DomainArn='string',
VpcOptions={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
ClientToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the domain to create the endpoint for.
[REQUIRED]
Options to specify the subnets and security groups for the endpoint.
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.
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.
dict
Response Syntax
{
'VpcEndpoint': {
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'DomainArn': 'string',
'VpcOptions': {
'VPCId': 'string',
'SubnetIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'Endpoint': 'string'
}
}
Response Structure
(dict) --
VpcEndpoint (dict) --
Information about the newly created VPC endpoint.
VpcEndpointId (string) --
The unique identifier of the endpoint.
VpcEndpointOwner (string) --
The creator of the endpoint.
DomainArn (string) --
The Amazon Resource Name (ARN) of the domain associated with the endpoint.
VpcOptions (dict) --
Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
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.
AvailabilityZones (list) --
The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds (list) --
The list of security group IDs associated with the VPC endpoints for the domain.
Status (string) --
The current status of the endpoint.
Endpoint (string) --
The connection endpoint ID for connecting to the domain.
Exceptions
OpenSearchService.Client.exceptions.ConflictExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.BaseExceptiondelete_domain(**kwargs)¶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
response = client.delete_domain(
DomainName='string'
)
[REQUIRED]
The name of the domain you want to permanently delete.
{
'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
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.
The status of the domain being deleted.
Unique identifier for the domain.
Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide .
Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
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.
Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
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' .
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 .
The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
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.
Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y .
Container for the cluster configuration of the domain.
Instance type of data nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
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.
Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .
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.
OpenSearch Service instance type of the dedicated master nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
Whether to enable warm storage for the cluster.
The instance type for the cluster's warm nodes.
The number of warm nodes in the cluster.
Container for cold storage configuration options.
Whether to enable or disable cold storage on the domain.
Container for EBS-based storage settings for the domain.
Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
Specifies the type of EBS volumes attached to data nodes.
Specifies the size (in GiB) of EBS volumes attached to data nodes.
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.
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
Identity and Access Management (IAM) policy document specifying the access policies for the domain.
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
The VPC configuration for the domain.
The ID for your VPC. Amazon VPC generates this value when you create a VPC.
A list of subnet IDs associated with the VPC endpoints for the domain.
The list of Availability Zones associated with the VPC subnets.
The list of security group IDs associated with the VPC endpoints for the domain.
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
Encryption at rest settings for the domain.
True to enable encryption at rest.
The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .
Whether node-to-node encryption is enabled or disabled.
True to enable node-to-node encryption.
Key-value pairs that specify advanced configuration options.
Log publishing options for the domain.
The type of log file. Can be one of the following:
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.
The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Whether the log should be published.
The current status of the domain's service software.
The current service software version present on the domain.
The new service software version, if one is available.
True if you're able to update your service software version. False if you can't update your service software version.
True if you're able to cancel your service software version update. False if you can't cancel your service software update.
The status of your service software update.
A description of the service software update status.
The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
True to require that all traffic to the domain arrive over HTTPS.
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Whether to enable a custom endpoint for the domain.
The fully qualified URL for the custom endpoint.
The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
Settings for fine-grained access control.
True if fine-grained access control is enabled.
True if the internal user database is enabled.
Container for information about the SAML configuration for OpenSearch Dashboards.
True if SAML is enabled.
Describes the SAML identity provider's information.
The metadata of the SAML application, in XML format.
The unique entity ID of the application in the SAML identity provider.
The key used for matching the SAML subject attribute.
The key used for matching the SAML roles attribute.
The duration, in minutes, after which a user session becomes inactive.
Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
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.
Auto-Tune settings for the domain.
The current state of Auto-Tune on the domain.
Any errors that occurred while enabling or disabling Auto-Tune.
Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.
Information about a configuration change happening on the domain.
The ID of the configuration change.
A message corresponding to the status of the configuration change.
Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
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.
Off-peak window settings for the domain.
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.
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.
The start minute of the window, in UTC.
Service software update options for the domain.
Whether automatic service software updates are enabled for the domain.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptiondelete_inbound_connection(**kwargs)¶Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.delete_inbound_connection(
ConnectionId='string'
)
[REQUIRED]
The ID of the inbound connection to permanently delete.
{
'Connection': {
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT'
}
}
Response Structure
The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.
The deleted inbound connection.
Information about the source (local) domain.
Information about an Amazon OpenSearch Service domain.
The Amazon Web Services account ID of the domain owner.
Name of the domain.
The Amazon Web Services Region in which the domain is located.
Information about the destination (remote) domain.
Information about an Amazon OpenSearch Service domain.
The Amazon Web Services account ID of the domain owner.
Name of the domain.
The Amazon Web Services Region in which the domain is located.
The unique identifier of the connection.
The current status of the connection.
The status code for the connection. Can be one of the following:
Information about the connection.
The connection mode.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptiondelete_outbound_connection(**kwargs)¶Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.delete_outbound_connection(
ConnectionId='string'
)
[REQUIRED]
The ID of the outbound connection you want to permanently delete.
{
'Connection': {
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionAlias': 'string',
'ConnectionStatus': {
'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT',
'ConnectionProperties': {
'Endpoint': 'string'
}
}
}
Response Structure
Details about the deleted outbound connection.
The deleted inbound connection.
Information about the source (local) domain.
Information about an Amazon OpenSearch Service domain.
The Amazon Web Services account ID of the domain owner.
Name of the domain.
The Amazon Web Services Region in which the domain is located.
Information about the destination (remote) domain.
Information about an Amazon OpenSearch Service domain.
The Amazon Web Services account ID of the domain owner.
Name of the domain.
The Amazon Web Services Region in which the domain is located.
Unique identifier of the connection.
Name of the connection.
Status of the connection.
The status code for the outbound connection. Can be one of the following:
Verbose information for the outbound connection.
The connection mode.
Properties for the outbound connection.
The endpoint of the remote domain.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptiondelete_package(**kwargs)¶Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.delete_package(
PackageID='string'
)
[REQUIRED]
The internal ID of the package you want to delete. Use DescribePackages to find this value.
{
'PackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'PackageDescription': 'string',
'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'AvailablePackageVersion': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
Container for the response parameters to the DeletePackage operation.
Information about the deleted package.
The unique identifier of the package.
User-specified name of the package.
The type of package.
User-specified description of the package.
Current status of the package.
The timestamp when the package was created.
Date and time when the package was last updated.
The package version.
Additional information if the package is in an error state. Null otherwise.
The type of error that occurred.
A message describing the error.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.AccessDeniedExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.ConflictExceptiondelete_vpc_endpoint(**kwargs)¶Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_vpc_endpoint(
VpcEndpointId='string'
)
[REQUIRED]
The unique identifier of the endpoint.
{
'VpcEndpointSummary': {
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'DomainArn': 'string',
'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'
}
}
Response Structure
Information about the deleted endpoint, including its current status ( DELETING or DELETE_FAILED ).
The unique identifier of the endpoint.
The creator of the endpoint.
The Amazon Resource Name (ARN) of the domain associated with the endpoint.
The current status of the endpoint.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.BaseExceptiondescribe_domain(**kwargs)¶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
response = client.describe_domain(
DomainName='string'
)
[REQUIRED]
The name of the domain that you want information about.
{
'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
Contains the status of the domain specified in the request.
List that contains the status of each specified OpenSearch Service domain.
Unique identifier for the domain.
Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide .
Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
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.
Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
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' .
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 .
The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
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.
Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y .
Container for the cluster configuration of the domain.
Instance type of data nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
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.
Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .
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.
OpenSearch Service instance type of the dedicated master nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
Whether to enable warm storage for the cluster.
The instance type for the cluster's warm nodes.
The number of warm nodes in the cluster.
Container for cold storage configuration options.
Whether to enable or disable cold storage on the domain.
Container for EBS-based storage settings for the domain.
Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
Specifies the type of EBS volumes attached to data nodes.
Specifies the size (in GiB) of EBS volumes attached to data nodes.
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.
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
Identity and Access Management (IAM) policy document specifying the access policies for the domain.
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
The VPC configuration for the domain.
The ID for your VPC. Amazon VPC generates this value when you create a VPC.
A list of subnet IDs associated with the VPC endpoints for the domain.
The list of Availability Zones associated with the VPC subnets.
The list of security group IDs associated with the VPC endpoints for the domain.
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
Encryption at rest settings for the domain.
True to enable encryption at rest.
The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .
Whether node-to-node encryption is enabled or disabled.
True to enable node-to-node encryption.
Key-value pairs that specify advanced configuration options.
Log publishing options for the domain.
The type of log file. Can be one of the following:
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.
The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Whether the log should be published.
The current status of the domain's service software.
The current service software version present on the domain.
The new service software version, if one is available.
True if you're able to update your service software version. False if you can't update your service software version.
True if you're able to cancel your service software version update. False if you can't cancel your service software update.
The status of your service software update.
A description of the service software update status.
The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
True to require that all traffic to the domain arrive over HTTPS.
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Whether to enable a custom endpoint for the domain.
The fully qualified URL for the custom endpoint.
The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
Settings for fine-grained access control.
True if fine-grained access control is enabled.
True if the internal user database is enabled.
Container for information about the SAML configuration for OpenSearch Dashboards.
True if SAML is enabled.
Describes the SAML identity provider's information.
The metadata of the SAML application, in XML format.
The unique entity ID of the application in the SAML identity provider.
The key used for matching the SAML subject attribute.
The key used for matching the SAML roles attribute.
The duration, in minutes, after which a user session becomes inactive.
Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
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.
Auto-Tune settings for the domain.
The current state of Auto-Tune on the domain.
Any errors that occurred while enabling or disabling Auto-Tune.
Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.
Information about a configuration change happening on the domain.
The ID of the configuration change.
A message corresponding to the status of the configuration change.
Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
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.
Off-peak window settings for the domain.
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.
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.
The start minute of the window, in UTC.
Service software update options for the domain.
Whether automatic service software updates are enabled for the domain.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptiondescribe_domain_auto_tunes(**kwargs)¶Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.describe_domain_auto_tunes(
DomainName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
Name of the domain that you want Auto-Tune details about.
nextToken to get the next page of results.DescribeDomainAutoTunes operation returns a nextToken , you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.dict
Response Syntax
{
'AutoTunes': [
{
'AutoTuneType': 'SCHEDULED_ACTION',
'AutoTuneDetails': {
'ScheduledAutoTuneDetails': {
'Date': datetime(2015, 1, 1),
'ActionType': 'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING',
'Action': 'string',
'Severity': 'LOW'|'MEDIUM'|'HIGH'
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The result of a DescribeDomainAutoTunes request.
AutoTunes (list) --
The list of setting adjustments that Auto-Tune has made to the domain.
(dict) --
Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
AutoTuneType (string) --
The type of Auto-Tune action.
AutoTuneDetails (dict) --
Details about an Auto-Tune action.
ScheduledAutoTuneDetails (dict) --
Container for details about a scheduled Auto-Tune action.
Date (datetime) --
The date and time when the Auto-Tune action is scheduled for the domain.
ActionType (string) --
The type of Auto-Tune action.
Action (string) --
A description of the Auto-Tune action.
Severity (string) --
The severity of the Auto-Tune action. Valid values are LOW , MEDIUM , and HIGH .
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptiondescribe_domain_change_progress(**kwargs)¶Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.describe_domain_change_progress(
DomainName='string',
ChangeId='string'
)
[REQUIRED]
The name of the domain to get progress information for.
dict
Response Syntax
{
'ChangeProgressStatus': {
'ChangeId': 'string',
'StartTime': datetime(2015, 1, 1),
'Status': 'PENDING'|'PROCESSING'|'COMPLETED'|'FAILED',
'PendingProperties': [
'string',
],
'CompletedProperties': [
'string',
],
'TotalNumberOfStages': 123,
'ChangeProgressStages': [
{
'Name': 'string',
'Status': 'string',
'Description': 'string',
'LastUpdated': datetime(2015, 1, 1)
},
]
}
}
Response Structure
(dict) --
The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.
ChangeProgressStatus (dict) --
Container for information about the stages of a configuration change happening on a domain.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
StartTime (datetime) --
The time at which the configuration change is made on the domain.
Status (string) --
The overall status of the domain configuration change.
PendingProperties (list) --
The list of properties in the domain configuration change that are still pending.
CompletedProperties (list) --
The list of properties in the domain configuration change that have completed.
TotalNumberOfStages (integer) --
The total number of stages required for the configuration change.
ChangeProgressStages (list) --
The specific stages that the domain is going through to perform the configuration change.
(dict) --
Progress details for each stage of a domain update.
Name (string) --
The name of the stage.
Status (string) --
The status of the stage.
Description (string) --
The description of the stage.
LastUpdated (datetime) --
The most recent updated timestamp of the stage.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptiondescribe_domain_config(**kwargs)¶Returns the configuration of an Amazon OpenSearch Service domain.
See also: AWS API Documentation
Request Syntax
response = client.describe_domain_config(
DomainName='string'
)
[REQUIRED]
Name of the OpenSearch Service domain configuration that you want to describe.
{
'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
Contains the configuration information of the requested domain.
Container for the configuration of the OpenSearch Service domain.
The OpenSearch or Elasticsearch version that the domain is running.
The OpenSearch or Elasticsearch version for the specified domain.
The status of the version options for the specified domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Container for the cluster configuration of a the domain.
Cluster configuration options for the specified domain.
Instance type of data nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
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.
Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .
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.
OpenSearch Service instance type of the dedicated master nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
Whether to enable warm storage for the cluster.
The instance type for the cluster's warm nodes.
The number of warm nodes in the cluster.
Container for cold storage configuration options.
Whether to enable or disable cold storage on the domain.
The status of cluster configuration options for the specified domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Container for EBS options configured for the domain.
The configured EBS options for the specified domain.
Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
Specifies the type of EBS volumes attached to data nodes.
Specifies the size (in GiB) of EBS volumes attached to data nodes.
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.
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
The status of the EBS options for the specified domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Specifies the access policies for the domain.
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.
The status of the access policy for the domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
The daily snapshot options specified for the domain.
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
The status of a daily automated snapshot.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
The current VPC options for the domain and the status of any updates to their configuration.
The VPC options for the specified domain.
The ID for your VPC. Amazon VPC generates this value when you create a VPC.
A list of subnet IDs associated with the VPC endpoints for the domain.
The list of Availability Zones associated with the VPC subnets.
The list of security group IDs associated with the VPC endpoints for the domain.
The status of the VPC options for the specified domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Container for Amazon Cognito options for the domain.
Cognito options for the specified domain.
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
The status of the Cognito options for the specified domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Key-value pairs to enable encryption at rest.
Encryption at rest options for the specified domain.
True to enable encryption at rest.
The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .
The status of the encryption at rest options for the specified domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Whether node-to-node encryption is enabled or disabled.
The node-to-node encryption options for the specified domain.
True to enable node-to-node encryption.
The status of the node-to-node encryption options for the specified domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
The status of advanced options for the specified domain.
The status of advanced options for the specified domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Key-value pairs to configure slow log publishing.
The log publishing options configured for the domain.
The type of log file. Can be one of the following:
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.
The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Whether the log should be published.
The status of the log publishing options for the domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
Options to configure the endpoint for a domain.
True to require that all traffic to the domain arrive over HTTPS.
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Whether to enable a custom endpoint for the domain.
The fully qualified URL for the custom endpoint.
The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
The status of the endpoint options for a domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Container for fine-grained access control settings for the domain.
Container for fine-grained access control settings.
True if fine-grained access control is enabled.
True if the internal user database is enabled.
Container for information about the SAML configuration for OpenSearch Dashboards.
True if SAML is enabled.
Describes the SAML identity provider's information.
The metadata of the SAML application, in XML format.
The unique entity ID of the application in the SAML identity provider.
The key used for matching the SAML subject attribute.
The key used for matching the SAML roles attribute.
The duration, in minutes, after which a user session becomes inactive.
Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
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 of the fine-grained access control settings for a domain.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Container for Auto-Tune settings for the domain.
Auto-Tune settings for updating a domain.
Whether Auto-Tune is enabled or disabled.
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.
DEPRECATED. Use off-peak window instead.
A list of maintenance schedules during which Auto-Tune can deploy changes.
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.
The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"} .
Integer to specify the value of a maintenance schedule duration.
The unit of measurement for the duration of a maintenance schedule.
A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.
The current status of Auto-Tune for a domain.
Date and time when Auto-Tune was enabled for the domain.
Date and time when the Auto-Tune options were last updated for the domain.
The latest version of the Auto-Tune options.
The current state of Auto-Tune on the domain.
Any errors that occurred while enabling or disabling Auto-Tune.
Indicates whether the domain is being deleted.
Container for information about the progress of an existing configuration change.
The ID of the configuration change.
A message corresponding to the status of the configuration change.
Container for off-peak window options for the domain.
The domain's off-peak window configuration.
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.
Off-peak window settings for the domain.
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.
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.
The start minute of the window, in UTC.
The current status of off-peak window options.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Software update options for the domain.
The service software update options for a domain.
Whether automatic service software updates are enabled for the domain.
The status of service software update options, including creation date and last updated date.
The timestamp when the entity was created.
The timestamp of the last time the entity was updated.
The latest version of the entity.
The state of the entity.
Indicates whether the entity is being deleted.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptiondescribe_domains(**kwargs)¶Returns domain configuration information about the specified Amazon OpenSearch Service domains.
See also: AWS API Documentation
Request Syntax
response = client.describe_domains(
DomainNames=[
'string',
]
)
[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.
The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.
{
'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
Contains the status of the specified domains or all domains owned by the account.
The status of the requested domains.
The current status of an OpenSearch Service domain.
Unique identifier for the domain.
Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide .
Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
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.
Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
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' .
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 .
The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
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.
Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y .
Container for the cluster configuration of the domain.
Instance type of data nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
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.
Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .
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.
OpenSearch Service instance type of the dedicated master nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
Whether to enable warm storage for the cluster.
The instance type for the cluster's warm nodes.
The number of warm nodes in the cluster.
Container for cold storage configuration options.
Whether to enable or disable cold storage on the domain.
Container for EBS-based storage settings for the domain.
Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
Specifies the type of EBS volumes attached to data nodes.
Specifies the size (in GiB) of EBS volumes attached to data nodes.
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.
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
Identity and Access Management (IAM) policy document specifying the access policies for the domain.
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
The VPC configuration for the domain.
The ID for your VPC. Amazon VPC generates this value when you create a VPC.
A list of subnet IDs associated with the VPC endpoints for the domain.
The list of Availability Zones associated with the VPC subnets.
The list of security group IDs associated with the VPC endpoints for the domain.
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
Encryption at rest settings for the domain.
True to enable encryption at rest.
The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .
Whether node-to-node encryption is enabled or disabled.
True to enable node-to-node encryption.
Key-value pairs that specify advanced configuration options.
Log publishing options for the domain.
The type of log file. Can be one of the following:
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.
The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Whether the log should be published.
The current status of the domain's service software.
The current service software version present on the domain.
The new service software version, if one is available.
True if you're able to update your service software version. False if you can't update your service software version.
True if you're able to cancel your service software version update. False if you can't cancel your service software update.
The status of your service software update.
A description of the service software update status.
The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
True to require that all traffic to the domain arrive over HTTPS.
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Whether to enable a custom endpoint for the domain.
The fully qualified URL for the custom endpoint.
The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
Settings for fine-grained access control.
True if fine-grained access control is enabled.
True if the internal user database is enabled.
Container for information about the SAML configuration for OpenSearch Dashboards.
True if SAML is enabled.
Describes the SAML identity provider's information.
The metadata of the SAML application, in XML format.
The unique entity ID of the application in the SAML identity provider.
The key used for matching the SAML subject attribute.
The key used for matching the SAML roles attribute.
The duration, in minutes, after which a user session becomes inactive.
Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
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.
Auto-Tune settings for the domain.
The current state of Auto-Tune on the domain.
Any errors that occurred while enabling or disabling Auto-Tune.
Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.
Information about a configuration change happening on the domain.
The ID of the configuration change.
A message corresponding to the status of the configuration change.
Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
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.
Off-peak window settings for the domain.
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.
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.
The start minute of the window, in UTC.
Service software update options for the domain.
Whether automatic service software updates are enabled for the domain.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ValidationExceptiondescribe_dry_run_progress(**kwargs)¶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
response = client.describe_dry_run_progress(
DomainName='string',
DryRunId='string',
LoadDryRunConfig=True|False
)
[REQUIRED]
The name of the domain.
dict
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.
AvailabilityZones (list) --
The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds (list) --
The list of security group IDs associated with the VPC endpoints for the domain.
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.
LogPublishingOptions (dict) --
Log publishing options for the domain.
(string) --
The type of log file. Can be one of the following:
(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:
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:
Message (string) --
A message corresponding to the deployment type.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptiondescribe_inbound_connections(**kwargs)¶Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.describe_inbound_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
A list of filters used to match properties for inbound cross-cluster connections.
A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
The name of the filter.
One or more values for the filter.
nextToken to get the next page of results.DescribeInboundConnections operation returns a nextToken , you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.dict
Response Syntax
{
'Connections': [
{
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains a list of connections matching the filter criteria.
Connections (list) --
List of inbound connections.
(dict) --
Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.
LocalDomainInfo (dict) --
Information about the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo (dict) --
Information about the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
ConnectionId (string) --
The unique identifier of the connection.
ConnectionStatus (dict) --
The current status of the connection.
StatusCode (string) --
The status code for the connection. Can be one of the following:
Message (string) --
Information about the connection.
ConnectionMode (string) --
The connection mode.
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.
Exceptions
OpenSearchService.Client.exceptions.InvalidPaginationTokenExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptiondescribe_instance_type_limits(**kwargs)¶Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
See also: AWS API Documentation
Request Syntax
response = client.describe_instance_type_limits(
DomainName='string',
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',
EngineVersion='string'
)
[REQUIRED]
The OpenSearch Service instance type for which you need limit information.
[REQUIRED]
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
dict
Response Syntax
{
'LimitsByRole': {
'string': {
'StorageTypes': [
{
'StorageTypeName': 'string',
'StorageSubTypeName': 'string',
'StorageTypeLimits': [
{
'LimitName': 'string',
'LimitValues': [
'string',
]
},
]
},
],
'InstanceLimits': {
'InstanceCountLimits': {
'MinimumInstanceCount': 123,
'MaximumInstanceCount': 123
}
},
'AdditionalLimits': [
{
'LimitName': 'string',
'LimitValues': [
'string',
]
},
]
}
}
}
Response Structure
(dict) --
Container for the parameters received from the DescribeInstanceTypeLimits operation.
LimitsByRole (dict) --
Map that contains all applicable instance type limits. data refers to data nodes. master refers to dedicated master nodes.
(string) --
(dict) --
Limits for a given instance type and for each of its roles.
StorageTypes (list) --
Storage-related attributes that are available for a given instance type.
(dict) --
A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.
StorageTypeName (string) --
The name of the storage type.
StorageSubTypeName (string) --
The storage sub-type, such as gp3 or io1 .
StorageTypeLimits (list) --
Limits that are applicable for the given storage type.
(dict) --
Limits that are applicable for the given Amazon OpenSearch Service storage type.
LimitName (string) --
Name of storage limits that are applicable for the given storage type. If StorageType is ebs , the following options are available:
LimitValues (list) --
The limit values.
InstanceLimits (dict) --
The limits for a given instance type.
InstanceCountLimits (dict) --
Limits on the number of instances that can be created for a given instance type.
MinimumInstanceCount (integer) --
The maximum allowed number of instances.
MaximumInstanceCount (integer) --
The minimum allowed number of instances.
AdditionalLimits (list) --
List of additional limits that are specific to a given instance type for each of its instance roles.
(dict) --
List of limits that are specific to a given instance type.
LimitName (string) --
MaximumNumberOfDataNodesSupported - This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support.MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.LimitValues (list) --
The values of the additional instance type limits.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.InvalidTypeExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptiondescribe_outbound_connections(**kwargs)¶Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.describe_outbound_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
List of filter names and values that you can use for requests.
A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
The name of the filter.
One or more values for the filter.
nextToken to get the next page of results.DescribeOutboundConnections operation returns a nextToken , you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.dict
Response Syntax
{
'Connections': [
{
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionAlias': 'string',
'ConnectionStatus': {
'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT',
'ConnectionProperties': {
'Endpoint': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains a list of connections matching the filter criteria.
Connections (list) --
List of outbound connections that match the filter criteria.
(dict) --
Specifies details about an outbound cross-cluster connection.
LocalDomainInfo (dict) --
Information about the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo (dict) --
Information about the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
ConnectionId (string) --
Unique identifier of the connection.
ConnectionAlias (string) --
Name of the connection.
ConnectionStatus (dict) --
Status of the connection.
StatusCode (string) --
The status code for the outbound connection. Can be one of the following:
Message (string) --
Verbose information for the outbound connection.
ConnectionMode (string) --
The connection mode.
ConnectionProperties (dict) --
Properties for the outbound connection.
Endpoint (string) --
The endpoint of the remote domain.
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.
Exceptions
OpenSearchService.Client.exceptions.InvalidPaginationTokenExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptiondescribe_packages(**kwargs)¶Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.describe_packages(
Filters=[
{
'Name': 'PackageID'|'PackageName'|'PackageStatus',
'Value': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
Only returns packages that match the DescribePackagesFilterList values.
A filter to apply to the DescribePackage response.
Any field from PackageDetails .
A list of values for the specified filter field.
nextToken to get the next page of results.DescribePackageFilters operation returns a nextToken , you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.dict
Response Syntax
{
'PackageDetailsList': [
{
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'PackageDescription': 'string',
'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'AvailablePackageVersion': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for the response returned by the DescribePackages operation.
PackageDetailsList (list) --
Basic information about a package.
(dict) --
Basic information about a package.
PackageID (string) --
The unique identifier of the package.
PackageName (string) --
User-specified name of the package.
PackageType (string) --
The type of package.
PackageDescription (string) --
User-specified description of the package.
PackageStatus (string) --
Current status of the package.
CreatedAt (datetime) --
The timestamp when the package was created.
LastUpdatedAt (datetime) --
Date and time when the package was last updated.
AvailablePackageVersion (string) --
The package version.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.AccessDeniedExceptionOpenSearchService.Client.exceptions.ValidationExceptiondescribe_reserved_instance_offerings(**kwargs)¶Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_instance_offerings(
ReservedInstanceOfferingId='string',
MaxResults=123,
NextToken='string'
)
nextToken to get the next page of results.DescribeReservedInstanceOfferings operation returns a nextToken , you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.dict
Response Syntax
{
'NextToken': 'string',
'ReservedInstanceOfferings': [
{
'ReservedInstanceOfferingId': 'string',
'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',
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Container for results of a DescribeReservedInstanceOfferings request.
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.
ReservedInstanceOfferings (list) --
List of Reserved Instance offerings.
(dict) --
Details of an OpenSearch Reserved Instance offering.
ReservedInstanceOfferingId (string) --
The unique identifier of the Reserved Instance offering.
InstanceType (string) --
The OpenSearch instance type offered by the Reserved Instance offering.
Duration (integer) --
The duration, in seconds, for which the offering will reserve the OpenSearch instance.
FixedPrice (float) --
The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.
UsagePrice (float) --
The hourly rate at which you're charged for the domain using this Reserved Instance.
CurrencyCode (string) --
The currency code for the Reserved Instance offering.
PaymentOption (string) --
Payment option for the Reserved Instance offering
RecurringCharges (list) --
The recurring charge to your account, regardless of whether you creates any domains using the offering.
(dict) --
Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.
RecurringChargeAmount (float) --
The monetary amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.InternalExceptiondescribe_reserved_instances(**kwargs)¶Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_instances(
ReservedInstanceId='string',
MaxResults=123,
NextToken='string'
)
nextToken to get the next page of results.DescribeReservedInstances operation returns a nextToken , you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.dict
Response Syntax
{
'NextToken': 'string',
'ReservedInstances': [
{
'ReservationName': 'string',
'ReservedInstanceId': 'string',
'BillingSubscriptionId': 123,
'ReservedInstanceOfferingId': 'string',
'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',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'InstanceCount': 123,
'State': 'string',
'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Container for results from DescribeReservedInstances
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.
ReservedInstances (list) --
List of Reserved Instances in the current Region.
(dict) --
Details of an OpenSearch Reserved Instance.
ReservationName (string) --
The customer-specified identifier to track this reservation.
ReservedInstanceId (string) --
The unique identifier for the reservation.
BillingSubscriptionId (integer) --
The unique identifier of the billing subscription.
ReservedInstanceOfferingId (string) --
The unique identifier of the Reserved Instance offering.
InstanceType (string) --
The OpenSearch instance type offered by theReserved Instance offering.
StartTime (datetime) --
The date and time when the reservation was purchased.
Duration (integer) --
The duration, in seconds, for which the OpenSearch instance is reserved.
FixedPrice (float) --
The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.
UsagePrice (float) --
The hourly rate at which you're charged for the domain using this Reserved Instance.
CurrencyCode (string) --
The currency code for the offering.
InstanceCount (integer) --
The number of OpenSearch instances that have been reserved.
State (string) --
The state of the Reserved Instance.
PaymentOption (string) --
The payment option as defined in the Reserved Instance offering.
RecurringCharges (list) --
The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.
(dict) --
Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.
RecurringChargeAmount (float) --
The monetary amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptiondescribe_vpc_endpoints(**kwargs)¶Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
See also: AWS API Documentation
Request Syntax
response = client.describe_vpc_endpoints(
VpcEndpointIds=[
'string',
]
)
[REQUIRED]
The unique identifiers of the endpoints to get information about.
{
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'DomainArn': 'string',
'VpcOptions': {
'VPCId': 'string',
'SubnetIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'Endpoint': 'string'
},
],
'VpcEndpointErrors': [
{
'VpcEndpointId': 'string',
'ErrorCode': 'ENDPOINT_NOT_FOUND'|'SERVER_ERROR',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about each requested VPC endpoint.
The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
The unique identifier of the endpoint.
The creator of the endpoint.
The Amazon Resource Name (ARN) of the domain associated with the endpoint.
Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
The ID for your VPC. Amazon VPC generates this value when you create a VPC.
A list of subnet IDs associated with the VPC endpoints for the domain.
The list of Availability Zones associated with the VPC subnets.
The list of security group IDs associated with the VPC endpoints for the domain.
The current status of the endpoint.
The connection endpoint ID for connecting to the domain.
Any errors associated with the request.
Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
The unique identifier of the endpoint.
The code associated with the error.
A message describing the error.
Exceptions
OpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.BaseExceptiondissociate_package(**kwargs)¶Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.dissociate_package(
PackageID='string',
DomainName='string'
)
[REQUIRED]
Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.
[REQUIRED]
Name of the domain to dissociate the package from.
dict
Response Syntax
{
'DomainPackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'LastUpdated': datetime(2015, 1, 1),
'DomainName': 'string',
'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
'PackageVersion': 'string',
'ReferencePath': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Container for the response returned by an DissociatePackage operation.
DomainPackageDetails (dict) --
Information about a package that has been dissociated from the domain.
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User-specified name of the package.
PackageType (string) --
The type of package.
LastUpdated (datetime) --
Timestamp of the most recent update to the package association status.
DomainName (string) --
Name of the domain that the package is associated with.
DomainPackageStatus (string) --
State of the association.
PackageVersion (string) --
The current version of the package.
ReferencePath (string) --
Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.AccessDeniedExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.ConflictExceptionget_compatible_versions(**kwargs)¶Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
See also: AWS API Documentation
Request Syntax
response = client.get_compatible_versions(
DomainName='string'
)
{
'CompatibleVersions': [
{
'SourceVersion': 'string',
'TargetVersions': [
'string',
]
},
]
}
Response Structure
Container for the response returned by the GetCompatibleVersions operation.
A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
The current version that the OpenSearch Service domain is running.
The possible versions that you can upgrade the domain to.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.InternalExceptionget_package_version_history(**kwargs)¶Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.get_package_version_history(
PackageID='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The unique identifier of the package.
nextToken to get the next page of results.GetPackageVersionHistory operation returns a nextToken , you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.dict
Response Syntax
{
'PackageID': 'string',
'PackageVersionHistoryList': [
{
'PackageVersion': 'string',
'CommitMessage': 'string',
'CreatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for response returned by GetPackageVersionHistory operation.
PackageID (string) --
The unique identifier of the package.
PackageVersionHistoryList (list) --
A list of package versions, along with their creation time and commit message.
(dict) --
Details about a package version.
PackageVersion (string) --
The package version.
CommitMessage (string) --
A message associated with the package version when it was uploaded.
CreatedAt (datetime) --
The date and time when the package was created.
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.AccessDeniedExceptionOpenSearchService.Client.exceptions.ValidationExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_upgrade_history(**kwargs)¶Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
See also: AWS API Documentation
Request Syntax
response = client.get_upgrade_history(
DomainName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The name of an existing domain.
nextToken to get the next page of results.GetUpgradeHistory operation returns a nextToken , you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.dict
Response Syntax
{
'UpgradeHistories': [
{
'UpgradeName': 'string',
'StartTimestamp': datetime(2015, 1, 1),
'UpgradeStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
'StepsList': [
{
'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
'UpgradeStepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
'Issues': [
'string',
],
'ProgressPercent': 123.0
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for the response returned by the GetUpgradeHistory operation.
UpgradeHistories (list) --
A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.
(dict) --
History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.
UpgradeName (string) --
A string that describes the upgrade.
StartTimestamp (datetime) --
UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ .
UpgradeStatus (string) --
The current status of the upgrade. The status can take one of the following values:
StepsList (list) --
A list of each step performed as part of a specific upgrade or upgrade eligibility check.
(dict) --
Represents a single step of an upgrade or upgrade eligibility check workflow.
UpgradeStep (string) --
One of three steps that an upgrade or upgrade eligibility check goes through:
UpgradeStepStatus (string) --
The current status of the upgrade. The status can take one of the following values:
Issues (list) --
A list of strings containing detailed information about the errors encountered in a particular step.
ProgressPercent (float) --
The floating point value representing the progress percentage of a particular step.
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.InternalExceptionget_upgrade_status(**kwargs)¶Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
See also: AWS API Documentation
Request Syntax
response = client.get_upgrade_status(
DomainName='string'
)
[REQUIRED]
The domain of the domain to get upgrade status information for.
{
'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE',
'StepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED',
'UpgradeName': 'string'
}
Response Structure
Container for the response returned by the GetUpgradeStatus operation.
One of three steps that an upgrade or upgrade eligibility check goes through.
The status of the current step that an upgrade is on.
A string that describes the update.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.InternalExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_domain_names(**kwargs)¶Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
See also: AWS API Documentation
Request Syntax
response = client.list_domain_names(
EngineType='OpenSearch'|'Elasticsearch'
)
{
'DomainNames': [
{
'DomainName': 'string',
'EngineType': 'OpenSearch'|'Elasticsearch'
},
]
}
Response Structure
The results of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.
The names of all OpenSearch Service domains owned by the current user and their respective engine types.
Information about an OpenSearch Service domain.
Name of the domain.
The type of search engine that the domain is running. OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.ValidationExceptionlist_domains_for_package(**kwargs)¶Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.list_domains_for_package(
PackageID='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The unique identifier of the package for which to list associated domains.
nextToken to get the next page of results.ListDomainsForPackage operation returns a nextToken , you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.dict
Response Syntax
{
'DomainPackageDetailsList': [
{
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'LastUpdated': datetime(2015, 1, 1),
'DomainName': 'string',
'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
'PackageVersion': 'string',
'ReferencePath': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for the response parameters to the ListDomainsForPackage operation.
DomainPackageDetailsList (list) --
Information about all domains associated with a package.
(dict) --
Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User-specified name of the package.
PackageType (string) --
The type of package.
LastUpdated (datetime) --
Timestamp of the most recent update to the package association status.
DomainName (string) --
Name of the domain that the package is associated with.
DomainPackageStatus (string) --
State of the association.
PackageVersion (string) --
The current version of the package.
ReferencePath (string) --
Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.AccessDeniedExceptionOpenSearchService.Client.exceptions.ValidationExceptionlist_instance_type_details(**kwargs)¶Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
See also: AWS API Documentation
Request Syntax
response = client.list_instance_type_details(
EngineVersion='string',
DomainName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
nextToken to get the next page of results.ListInstanceTypeDetails operation returns a nextToken , you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.dict
Response Syntax
{
'InstanceTypeDetails': [
{
'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',
'EncryptionEnabled': True|False,
'CognitoEnabled': True|False,
'AppLogsEnabled': True|False,
'AdvancedSecurityEnabled': True|False,
'WarmEnabled': True|False,
'InstanceRole': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceTypeDetails (list) --
Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.
(dict) --
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
InstanceType (string) --
The instance type.
EncryptionEnabled (boolean) --
Whether encryption at rest and node-to-node encryption are supported for the instance type.
CognitoEnabled (boolean) --
Whether Amazon Cognito access is supported for the instance type.
AppLogsEnabled (boolean) --
Whether logging is supported for the instance type.
AdvancedSecurityEnabled (boolean) --
Whether fine-grained access control is supported for the instance type.
WarmEnabled (boolean) --
Whether UltraWarm is supported for the instance type.
InstanceRole (list) --
Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptionlist_packages_for_domain(**kwargs)¶Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.list_packages_for_domain(
DomainName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The name of the domain for which you want to list associated packages.
nextToken to get the next page of results.ListPackagesForDomain operation returns a nextToken , you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.dict
Response Syntax
{
'DomainPackageDetailsList': [
{
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'LastUpdated': datetime(2015, 1, 1),
'DomainName': 'string',
'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED',
'PackageVersion': 'string',
'ReferencePath': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for the response parameters to the ListPackagesForDomain operation.
DomainPackageDetailsList (list) --
List of all packages associated with a domain.
(dict) --
Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
PackageID (string) --
Internal ID of the package.
PackageName (string) --
User-specified name of the package.
PackageType (string) --
The type of package.
LastUpdated (datetime) --
Timestamp of the most recent update to the package association status.
DomainName (string) --
Name of the domain that the package is associated with.
DomainPackageStatus (string) --
State of the association.
PackageVersion (string) --
The current version of the package.
ReferencePath (string) --
Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.AccessDeniedExceptionOpenSearchService.Client.exceptions.ValidationExceptionlist_scheduled_actions(**kwargs)¶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
response = client.list_scheduled_actions(
DomainName='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The name of the domain.
nextToken to get the next page of results.ListScheduledActions operation returns a nextToken , you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.dict
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.InvalidPaginationTokenExceptionOpenSearchService.Client.exceptions.ValidationExceptionReturns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
ARN='string'
)
[REQUIRED]
Amazon Resource Name (ARN) for the domain to view tags for.
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The results of a ListTags operation.
List of resource tags associated with the specified domain.
A tag (key-value pair) for an Amazon OpenSearch Service resource.
The tag key. Tag keys must be unique for the domain to which they are attached.
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
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.InternalExceptionlist_versions(**kwargs)¶Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
See also: AWS API Documentation
Request Syntax
response = client.list_versions(
MaxResults=123,
NextToken='string'
)
nextToken to get the next page of results.ListVersions operation returns a nextToken , you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.dict
Response Syntax
{
'Versions': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Container for the parameters for response received from the ListVersions operation.
Versions (list) --
A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptionlist_vpc_endpoint_access(**kwargs)¶Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
See also: AWS API Documentation
Request Syntax
response = client.list_vpc_endpoint_access(
DomainName='string',
NextToken='string'
)
[REQUIRED]
The name of the OpenSearch Service domain to retrieve access information for.
ListVpcEndpointAccess operation returns a nextToken , you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.dict
Response Syntax
{
'AuthorizedPrincipalList': [
{
'PrincipalType': 'AWS_ACCOUNT'|'AWS_SERVICE',
'Principal': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AuthorizedPrincipalList (list) --
A list of IAM principals that can currently access the domain.
(dict) --
Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
PrincipalType (string) --
The type of principal.
Principal (string) --
The IAM principal that is allowed access to the domain.
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.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.BaseExceptionlist_vpc_endpoints(**kwargs)¶Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
See also: AWS API Documentation
Request Syntax
response = client.list_vpc_endpoints(
NextToken='string'
)
ListVpcEndpoints operation returns a nextToken , you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.{
'VpcEndpointSummaryList': [
{
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'DomainArn': 'string',
'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'
},
],
'NextToken': 'string'
}
Response Structure
Information about each endpoint.
Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
The unique identifier of the endpoint.
The creator of the endpoint.
The Amazon Resource Name (ARN) of the domain associated with the endpoint.
The current status of the endpoint.
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.
Exceptions
OpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.BaseExceptionlist_vpc_endpoints_for_domain(**kwargs)¶Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
See also: AWS API Documentation
Request Syntax
response = client.list_vpc_endpoints_for_domain(
DomainName='string',
NextToken='string'
)
[REQUIRED]
The name of the domain to list associated VPC endpoints for.
ListEndpointsForDomain operation returns a nextToken , you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.dict
Response Syntax
{
'VpcEndpointSummaryList': [
{
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'DomainArn': 'string',
'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
VpcEndpointSummaryList (list) --
Information about each endpoint associated with the domain.
(dict) --
Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
VpcEndpointId (string) --
The unique identifier of the endpoint.
VpcEndpointOwner (string) --
The creator of the endpoint.
DomainArn (string) --
The Amazon Resource Name (ARN) of the domain associated with the endpoint.
Status (string) --
The current status of the endpoint.
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.
Exceptions
OpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.BaseExceptionpurchase_reserved_instance_offering(**kwargs)¶Allows you to purchase Amazon OpenSearch Service Reserved Instances.
See also: AWS API Documentation
Request Syntax
response = client.purchase_reserved_instance_offering(
ReservedInstanceOfferingId='string',
ReservationName='string',
InstanceCount=123
)
[REQUIRED]
The ID of the Reserved Instance offering to purchase.
[REQUIRED]
A customer-specified identifier to track this reservation.
dict
Response Syntax
{
'ReservedInstanceId': 'string',
'ReservationName': 'string'
}
Response Structure
(dict) --
Represents the output of a PurchaseReservedInstanceOffering operation.
ReservedInstanceId (string) --
The ID of the Reserved Instance offering that was purchased.
ReservationName (string) --
The customer-specified identifier used to track this reservation.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ResourceAlreadyExistsExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.InternalExceptionreject_inbound_connection(**kwargs)¶Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
See also: AWS API Documentation
Request Syntax
response = client.reject_inbound_connection(
ConnectionId='string'
)
[REQUIRED]
The unique identifier of the inbound connection to reject.
{
'Connection': {
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT'
}
}
Response Structure
Represents the output of a RejectInboundConnection operation.
Contains details about the rejected inbound connection.
Information about the source (local) domain.
Information about an Amazon OpenSearch Service domain.
The Amazon Web Services account ID of the domain owner.
Name of the domain.
The Amazon Web Services Region in which the domain is located.
Information about the destination (remote) domain.
Information about an Amazon OpenSearch Service domain.
The Amazon Web Services account ID of the domain owner.
Name of the domain.
The Amazon Web Services Region in which the domain is located.
The unique identifier of the connection.
The current status of the connection.
The status code for the connection. Can be one of the following:
Information about the connection.
The connection mode.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionRemoves the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags(
ARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.
[REQUIRED]
The list of tag keys to remove from the domain.
None
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.InternalExceptionrevoke_vpc_endpoint_access(**kwargs)¶Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
See also: AWS API Documentation
Request Syntax
response = client.revoke_vpc_endpoint_access(
DomainName='string',
Account='string'
)
[REQUIRED]
The name of the OpenSearch Service domain.
[REQUIRED]
The account ID to revoke access from.
dict
Response Syntax
{}
Response Structure
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.BaseExceptionstart_service_software_update(**kwargs)¶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
response = client.start_service_software_update(
DomainName='string',
ScheduleAt='NOW'|'TIMESTAMP'|'OFF_PEAK_WINDOW',
DesiredStartTime=123
)
[REQUIRED]
The name of the domain that you want to update to the latest service software.
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.
ScheduleAt to TIMESTAMP .dict
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptionupdate_domain_config(**kwargs)¶Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
See also: AWS API Documentation
Request Syntax
response = 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
}
)
[REQUIRED]
The name of the domain that you're updating.
Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
Instance type of data nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
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.
Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true .
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.
OpenSearch Service instance type of the dedicated master nodes in the cluster.
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
Whether to enable warm storage for the cluster.
The instance type for the cluster's warm nodes.
The number of warm nodes in the cluster.
Container for cold storage configuration options.
Whether to enable or disable cold storage on the domain.
The type and size of the EBS volume to attach to instances in the domain.
Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
Specifies the type of EBS volumes attached to data nodes.
Specifies the size (in GiB) of EBS volumes attached to data nodes.
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.
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
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.
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.
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.
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
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.
Options to publish OpenSearch logs to Amazon CloudWatch Logs.
The type of log file. Can be one of the following:
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.
The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Whether the log should be published.
Encryption at rest options for the domain.
True to enable encryption at rest.
The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a .
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
True to require that all traffic to the domain arrive over HTTPS.
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Whether to enable a custom endpoint for the domain.
The fully qualified URL for the custom endpoint.
The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
Node-to-node encryption options for the domain.
True to enable node-to-node encryption.
Options for fine-grained access control.
True to enable fine-grained access control.
True to enable the internal user database.
Container for information about the master user.
Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false .
User name for the master user. Only specify if InternalUserDatabaseEnabled is true .
Password for the master user. Only specify if InternalUserDatabaseEnabled is true .
Container for information about the SAML configuration for OpenSearch Dashboards.
True to enable SAML authentication for a domain.
The SAML Identity Provider's information.
The metadata of the SAML application, in XML format.
The unique entity ID of the application in the SAML identity provider.
The SAML master user name, which is stored in the domain's internal user database.
The backend role that the SAML master user is mapped to.
Element of the SAML assertion to use for the user name. Default is NameID .
Element of the SAML assertion to use for backend roles. Default is roles .
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
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.
Options for Auto-Tune.
Whether Auto-Tune is enabled or disabled.
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.
DEPRECATED. Use off-peak window instead.
A list of maintenance schedules during which Auto-Tune can deploy changes.
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.
The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"} .
Integer to specify the value of a maintenance schedule duration.
The unit of measurement for the duration of a maintenance schedule.
A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.
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.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.Off-peak window options for the domain.
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.
Off-peak window settings for the domain.
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.
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.
The start minute of the window, in UTC.
Service software update options for the domain.
Whether automatic service software updates are enabled for the domain.
dict
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.
AvailabilityZones (list) --
The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds (list) --
The list of security group IDs associated with the VPC endpoints for the domain.
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.
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:
(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:
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:
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.InvalidTypeExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ValidationExceptionupdate_package(**kwargs)¶Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.update_package(
PackageID='string',
PackageSource={
'S3BucketName': 'string',
'S3Key': 'string'
},
PackageDescription='string',
CommitMessage='string'
)
[REQUIRED]
The unique identifier for the package.
[REQUIRED]
Amazon S3 bucket and key for the package.
The name of the Amazon S3 bucket containing the package.
Key (file name) of the package.
GetPackageVersionHistoryResponse .dict
Response Syntax
{
'PackageDetails': {
'PackageID': 'string',
'PackageName': 'string',
'PackageType': 'TXT-DICTIONARY',
'PackageDescription': 'string',
'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED',
'CreatedAt': datetime(2015, 1, 1),
'LastUpdatedAt': datetime(2015, 1, 1),
'AvailablePackageVersion': 'string',
'ErrorDetails': {
'ErrorType': 'string',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Container for the response returned by the UpdatePackage operation.
PackageDetails (dict) --
Information about a package.
PackageID (string) --
The unique identifier of the package.
PackageName (string) --
User-specified name of the package.
PackageType (string) --
The type of package.
PackageDescription (string) --
User-specified description of the package.
PackageStatus (string) --
Current status of the package.
CreatedAt (datetime) --
The timestamp when the package was created.
LastUpdatedAt (datetime) --
Date and time when the package was last updated.
AvailablePackageVersion (string) --
The package version.
ErrorDetails (dict) --
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) --
The type of error that occurred.
ErrorMessage (string) --
A message describing the error.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.AccessDeniedExceptionOpenSearchService.Client.exceptions.ValidationExceptionupdate_scheduled_action(**kwargs)¶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
response = 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
)
[REQUIRED]
The name of the domain to reschedule an action for.
[REQUIRED]
The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.
[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.
[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.ScheduleAt to TIMESTAMP .dict
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.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.SlotNotAvailableExceptionOpenSearchService.Client.exceptions.ConflictExceptionOpenSearchService.Client.exceptions.LimitExceededExceptionOpenSearchService.Client.exceptions.ValidationExceptionupdate_vpc_endpoint(**kwargs)¶Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
See also: AWS API Documentation
Request Syntax
response = client.update_vpc_endpoint(
VpcEndpointId='string',
VpcOptions={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
}
)
[REQUIRED]
The unique identifier of the endpoint.
[REQUIRED]
The security groups and/or subnets to add, remove, or modify.
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.
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.
dict
Response Syntax
{
'VpcEndpoint': {
'VpcEndpointId': 'string',
'VpcEndpointOwner': 'string',
'DomainArn': 'string',
'VpcOptions': {
'VPCId': 'string',
'SubnetIds': [
'string',
],
'AvailabilityZones': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
'Endpoint': 'string'
}
}
Response Structure
(dict) --
VpcEndpoint (dict) --
The endpoint to be updated.
VpcEndpointId (string) --
The unique identifier of the endpoint.
VpcEndpointOwner (string) --
The creator of the endpoint.
DomainArn (string) --
The Amazon Resource Name (ARN) of the domain associated with the endpoint.
VpcOptions (dict) --
Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
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.
AvailabilityZones (list) --
The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds (list) --
The list of security group IDs associated with the VPC endpoints for the domain.
Status (string) --
The current status of the endpoint.
Endpoint (string) --
The connection endpoint ID for connecting to the domain.
Exceptions
OpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.InternalExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.ConflictExceptionOpenSearchService.Client.exceptions.BaseExceptionupgrade_domain(**kwargs)¶Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
See also: AWS API Documentation
Request Syntax
response = client.upgrade_domain(
DomainName='string',
TargetVersion='string',
PerformCheckOnly=True|False,
AdvancedOptions={
'string': 'string'
}
)
[REQUIRED]
Name of the OpenSearch Service domain that you want to upgrade.
[REQUIRED]
OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.
Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.
dict
Response Syntax
{
'UpgradeId': 'string',
'DomainName': 'string',
'TargetVersion': 'string',
'PerformCheckOnly': True|False,
'AdvancedOptions': {
'string': 'string'
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
}
Response Structure
(dict) --
Container for the response returned by UpgradeDomain operation.
UpgradeId (string) --
The unique identifier of the domain upgrade.
DomainName (string) --
The name of the domain that was upgraded.
TargetVersion (string) --
OpenSearch or Elasticsearch version that the domain was upgraded to.
PerformCheckOnly (boolean) --
When true, indicates that an upgrade eligibility check was performed.
AdvancedOptions (dict) --
The advanced options configuration for the domain.
ChangeProgressDetails (dict) --
Container for information about a configuration change happening on a domain.
ChangeId (string) --
The ID of the configuration change.
Message (string) --
A message corresponding to the status of the configuration change.
Exceptions
OpenSearchService.Client.exceptions.BaseExceptionOpenSearchService.Client.exceptions.ResourceNotFoundExceptionOpenSearchService.Client.exceptions.ResourceAlreadyExistsExceptionOpenSearchService.Client.exceptions.DisabledOperationExceptionOpenSearchService.Client.exceptions.ValidationExceptionOpenSearchService.Client.exceptions.InternalExceptionThe available paginators are: