2022/01/27 - Amazon OpenSearch Service - 1 new 7 updated api methods
Changes Allows customers to get progress updates for blue/green deployments
Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
See also: AWS API Documentation
Request Syntax
client.describe_domain_change_progress(
DomainName='string',
ChangeId='string'
)
string
[REQUIRED]
The domain you want to get the progress information about.
string
The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.
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 the progress information of the requested domain change.
ChangeProgressStatus (dict) --
Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.
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. This field can take the following values: PENDING , PROCESSING , COMPLETED and FAILED
PendingProperties (list) --
The list of properties involved in the domain configuration change that are still in pending.
(string) --
CompletedProperties (list) --
The list of properties involved in the domain configuration change that are completed.
(string) --
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) --
A progress stage details of a specific domain configuration change.
Name (string) --
The name of the specific progress stage.
Status (string) --
The overall status of a specific progress stage.
Description (string) --
The description of the progress stage.
LastUpdated (datetime) --
The last updated timestamp of the progress stage.
{'DomainStatus': {'ChangeProgressDetails': {'ChangeId': 'string',
'Message': 'string'}}}
Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide .
See also: AWS API Documentation
Request Syntax
client.create_domain(
DomainName='string',
EngineVersion='string',
ClusterConfig={
'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
EBSOptions={
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1',
'VolumeSize': 123,
'Iops': 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'
},
]
}
)
string
[REQUIRED]
The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
string
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .
dict
Configuration options for a domain. Specifies the instance type and number of instances in the domain.
InstanceType (string) --
The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
InstanceCount (integer) --
The number of instances in the specified domain cluster.
DedicatedMasterEnabled (boolean) --
A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
ZoneAwarenessEnabled (boolean) --
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
ZoneAwarenessConfig (dict) --
The zone awareness configuration for a domain when zone awareness is enabled.
AvailabilityZoneCount (integer) --
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
DedicatedMasterType (string) --
The instance type for a dedicated master node.
DedicatedMasterCount (integer) --
Total number of dedicated master nodes, active and on standby, for the cluster.
WarmEnabled (boolean) --
True to enable UltraWarm storage.
WarmType (string) --
The instance type for the OpenSearch cluster's warm nodes.
WarmCount (integer) --
The number of UltraWarm nodes in the cluster.
ColdStorageOptions (dict) --
Specifies the ColdStorageOptions config for a Domain
Enabled (boolean) -- [REQUIRED]
Enable cold storage option. Accepted values true or false
dict
Options to enable, disable, and specify the type and size of EBS storage volumes.
EBSEnabled (boolean) --
Whether EBS-based storage is enabled.
VolumeType (string) --
The volume type for EBS-based storage.
VolumeSize (integer) --
Integer to specify the size of an EBS volume.
Iops (integer) --
The IOPD for a Provisioned IOPS EBS volume (SSD).
string
IAM access policy as a JSON-formatted string.
dict
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
AutomatedSnapshotStartHour (integer) --
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
dict
Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
SubnetIds (list) --
The subnets for the VPC endpoint.
(string) --
SecurityGroupIds (list) --
The security groups for the VPC endpoint.
(string) --
dict
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .
Enabled (boolean) --
The option to enable Cognito for OpenSearch Dashboards authentication.
UserPoolId (string) --
The Cognito user pool ID for OpenSearch Dashboards authentication.
IdentityPoolId (string) --
The Cognito identity pool ID for OpenSearch Dashboards authentication.
RoleArn (string) --
The role ARN that provides OpenSearch permissions for accessing Cognito resources.
dict
Options for encryption of data at rest.
Enabled (boolean) --
The option to enable encryption at rest.
KmsKeyId (string) --
The KMS key ID for encryption at rest options.
dict
Node-to-node encryption options.
Enabled (boolean) --
True to enable node-to-node encryption.
dict
Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true . See Advanced cluster parameters for more information.
(string) --
(string) --
dict
Map of LogType and LogPublishingOption , each containing options to publish a given type of OpenSearch log.
(string) --
Type of log file. Can be one of the following:
INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
(dict) --
Log Publishing option that is set for a given domain. Attributes and their details:
CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
Enabled: Whether the log publishing for a given log type is enabled or not.
CloudWatchLogsLogGroupArn (string) --
ARN of the Cloudwatch log group to publish logs to.
Enabled (boolean) --
Whether the given log publishing option is enabled or not.
dict
Options to specify configurations that will be applied to the domain endpoint.
EnforceHTTPS (boolean) --
Whether only HTTPS endpoint should be enabled for the domain.
TLSSecurityPolicy (string) --
Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
CustomEndpointEnabled (boolean) --
Whether to enable a custom endpoint for the domain.
CustomEndpoint (string) --
The fully qualified domain for your custom endpoint.
CustomEndpointCertificateArn (string) --
The ACM certificate ARN for your custom endpoint.
dict
Specifies advanced security options.
Enabled (boolean) --
True if advanced security is enabled.
InternalUserDatabaseEnabled (boolean) --
True if the internal user database is enabled.
MasterUserOptions (dict) --
Credentials for the master user: username and password, ARN, or both.
MasterUserARN (string) --
ARN for the master user (if IAM is enabled).
MasterUserName (string) --
The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.
MasterUserPassword (string) --
The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.
SAMLOptions (dict) --
The SAML application configuration for the domain.
Enabled (boolean) --
True if SAML is enabled.
Idp (dict) --
The SAML Identity Provider's information.
MetadataContent (string) -- [REQUIRED]
The metadata of the SAML application in XML format.
EntityId (string) -- [REQUIRED]
The unique entity ID of the application in SAML identity provider.
MasterUserName (string) --
The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.
MasterBackendRole (string) --
The backend role that the SAML master user is mapped to.
SubjectKey (string) --
Element of the SAML assertion to use for username. Default is NameID.
RolesKey (string) --
Element of the SAML assertion to use for backend roles. Default is roles.
SessionTimeoutMinutes (integer) --
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
AnonymousAuthEnabled (boolean) --
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
list
A list of Tag added during domain creation.
(dict) --
A key value pair for a resource tag.
Key (string) -- [REQUIRED]
The TagKey , the name of the tag. Tag keys must be unique for the domain to which they are attached.
Value (string) -- [REQUIRED]
The TagValue , 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
dict
Specifies Auto-Tune options.
DesiredState (string) --
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
MaintenanceSchedules (list) --
A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
(dict) --
Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
StartAt (datetime) --
The timestamp at which the Auto-Tune maintenance schedule starts.
Duration (dict) --
Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
Value (integer) --
Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
Unit (string) --
The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.
CronExpressionForRecurrence (string) --
A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
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',
'VolumeSize': 123,
'Iops': 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'
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
}
}
Response Structure
(dict) --
The result of a CreateDomain operation. Contains the status of the newly created Amazon OpenSearch Service domain.
DomainStatus (dict) --
The status of the newly created domain.
DomainId (string) --
The unique identifier for the specified domain.
DomainName (string) --
The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
ARN (string) --
The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.
Created (boolean) --
The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.
Deleted (boolean) --
The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
Endpoint (string) --
The domain endpoint that you use to submit index and search requests.
Endpoints (dict) --
Map containing the domain endpoints used to submit index and search requests. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .
(string) --
(string) --
The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .
Processing (boolean) --
The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.
UpgradeProcessing (boolean) --
The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.
EngineVersion (string) --
ClusterConfig (dict) --
The type and number of instances in the domain.
InstanceType (string) --
The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
InstanceCount (integer) --
The number of instances in the specified domain cluster.
DedicatedMasterEnabled (boolean) --
A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
ZoneAwarenessEnabled (boolean) --
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
ZoneAwarenessConfig (dict) --
The zone awareness configuration for a domain when zone awareness is enabled.
AvailabilityZoneCount (integer) --
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
DedicatedMasterType (string) --
The instance type for a dedicated master node.
DedicatedMasterCount (integer) --
Total number of dedicated master nodes, active and on standby, for the cluster.
WarmEnabled (boolean) --
True to enable UltraWarm storage.
WarmType (string) --
The instance type for the OpenSearch cluster's warm nodes.
WarmCount (integer) --
The number of UltraWarm nodes in the cluster.
ColdStorageOptions (dict) --
Specifies the ColdStorageOptions config for a Domain
Enabled (boolean) --
Enable cold storage option. Accepted values true or false
EBSOptions (dict) --
The EBSOptions for the specified domain.
EBSEnabled (boolean) --
Whether EBS-based storage is enabled.
VolumeType (string) --
The volume type for EBS-based storage.
VolumeSize (integer) --
Integer to specify the size of an EBS volume.
Iops (integer) --
The IOPD for a Provisioned IOPS EBS volume (SSD).
AccessPolicies (string) --
IAM access policy as a JSON-formatted string.
SnapshotOptions (dict) --
The status of the SnapshotOptions .
AutomatedSnapshotStartHour (integer) --
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
VPCOptions (dict) --
The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
VPCId (string) --
The VPC ID for the domain. Exists only if the domain was created with VPCOptions .
SubnetIds (list) --
The subnets for the VPC endpoint.
(string) --
AvailabilityZones (list) --
The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .
(string) --
SecurityGroupIds (list) --
The security groups for the VPC endpoint.
(string) --
CognitoOptions (dict) --
The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .
Enabled (boolean) --
The option to enable Cognito for OpenSearch Dashboards authentication.
UserPoolId (string) --
The Cognito user pool ID for OpenSearch Dashboards authentication.
IdentityPoolId (string) --
The Cognito identity pool ID for OpenSearch Dashboards authentication.
RoleArn (string) --
The role ARN that provides OpenSearch permissions for accessing Cognito resources.
EncryptionAtRestOptions (dict) --
The status of the EncryptionAtRestOptions .
Enabled (boolean) --
The option to enable encryption at rest.
KmsKeyId (string) --
The KMS key ID for encryption at rest options.
NodeToNodeEncryptionOptions (dict) --
The status of the NodeToNodeEncryptionOptions .
Enabled (boolean) --
True to enable node-to-node encryption.
AdvancedOptions (dict) --
The status of the AdvancedOptions .
(string) --
(string) --
LogPublishingOptions (dict) --
Log publishing options for the given domain.
(string) --
Type of log file. Can be one of the following:
INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
(dict) --
Log Publishing option that is set for a given domain. Attributes and their details:
CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
Enabled: Whether the log publishing for a given log type is enabled or not.
CloudWatchLogsLogGroupArn (string) --
ARN of the Cloudwatch log group to publish logs to.
Enabled (boolean) --
Whether the given log publishing option is enabled or not.
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. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
Description (string) --
The description of the UpdateStatus .
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 AutomatedUpdateDate .
DomainEndpointOptions (dict) --
The current status of the domain's endpoint options.
EnforceHTTPS (boolean) --
Whether only HTTPS endpoint should be enabled for the domain.
TLSSecurityPolicy (string) --
Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
CustomEndpointEnabled (boolean) --
Whether to enable a custom endpoint for the domain.
CustomEndpoint (string) --
The fully qualified domain for your custom endpoint.
CustomEndpointCertificateArn (string) --
The ACM certificate ARN for your custom endpoint.
AdvancedSecurityOptions (dict) --
The current status of the domain's advanced security options.
Enabled (boolean) --
True if advanced security is enabled.
InternalUserDatabaseEnabled (boolean) --
True if the internal user database is enabled.
SAMLOptions (dict) --
Describes the SAML application configured for a domain.
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 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) --
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
AnonymousAuthEnabled (boolean) --
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
AutoTuneOptions (dict) --
The current status of the domain's Auto-Tune options.
State (string) --
The AutoTuneState for the domain.
ErrorMessage (string) --
The error message while enabling or disabling Auto-Tune.
ChangeProgressDetails (dict) --
Specifies change details of the domain configuration change.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
Message (string) --
Contains an optional message associated with the domain configuration change.
{'DomainStatus': {'ChangeProgressDetails': {'ChangeId': 'string',
'Message': 'string'}}}
Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.
See also: AWS API Documentation
Request Syntax
client.delete_domain(
DomainName='string'
)
string
[REQUIRED]
The name of the domain you want to permanently delete.
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',
'VolumeSize': 123,
'Iops': 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'
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
}
}
Response Structure
(dict) --
The result of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.
DomainStatus (dict) --
The status of the domain being deleted.
DomainId (string) --
The unique identifier for the specified domain.
DomainName (string) --
The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
ARN (string) --
The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.
Created (boolean) --
The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.
Deleted (boolean) --
The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
Endpoint (string) --
The domain endpoint that you use to submit index and search requests.
Endpoints (dict) --
Map containing the domain endpoints used to submit index and search requests. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .
(string) --
(string) --
The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .
Processing (boolean) --
The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.
UpgradeProcessing (boolean) --
The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.
EngineVersion (string) --
ClusterConfig (dict) --
The type and number of instances in the domain.
InstanceType (string) --
The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
InstanceCount (integer) --
The number of instances in the specified domain cluster.
DedicatedMasterEnabled (boolean) --
A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
ZoneAwarenessEnabled (boolean) --
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
ZoneAwarenessConfig (dict) --
The zone awareness configuration for a domain when zone awareness is enabled.
AvailabilityZoneCount (integer) --
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
DedicatedMasterType (string) --
The instance type for a dedicated master node.
DedicatedMasterCount (integer) --
Total number of dedicated master nodes, active and on standby, for the cluster.
WarmEnabled (boolean) --
True to enable UltraWarm storage.
WarmType (string) --
The instance type for the OpenSearch cluster's warm nodes.
WarmCount (integer) --
The number of UltraWarm nodes in the cluster.
ColdStorageOptions (dict) --
Specifies the ColdStorageOptions config for a Domain
Enabled (boolean) --
Enable cold storage option. Accepted values true or false
EBSOptions (dict) --
The EBSOptions for the specified domain.
EBSEnabled (boolean) --
Whether EBS-based storage is enabled.
VolumeType (string) --
The volume type for EBS-based storage.
VolumeSize (integer) --
Integer to specify the size of an EBS volume.
Iops (integer) --
The IOPD for a Provisioned IOPS EBS volume (SSD).
AccessPolicies (string) --
IAM access policy as a JSON-formatted string.
SnapshotOptions (dict) --
The status of the SnapshotOptions .
AutomatedSnapshotStartHour (integer) --
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
VPCOptions (dict) --
The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
VPCId (string) --
The VPC ID for the domain. Exists only if the domain was created with VPCOptions .
SubnetIds (list) --
The subnets for the VPC endpoint.
(string) --
AvailabilityZones (list) --
The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .
(string) --
SecurityGroupIds (list) --
The security groups for the VPC endpoint.
(string) --
CognitoOptions (dict) --
The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .
Enabled (boolean) --
The option to enable Cognito for OpenSearch Dashboards authentication.
UserPoolId (string) --
The Cognito user pool ID for OpenSearch Dashboards authentication.
IdentityPoolId (string) --
The Cognito identity pool ID for OpenSearch Dashboards authentication.
RoleArn (string) --
The role ARN that provides OpenSearch permissions for accessing Cognito resources.
EncryptionAtRestOptions (dict) --
The status of the EncryptionAtRestOptions .
Enabled (boolean) --
The option to enable encryption at rest.
KmsKeyId (string) --
The KMS key ID for encryption at rest options.
NodeToNodeEncryptionOptions (dict) --
The status of the NodeToNodeEncryptionOptions .
Enabled (boolean) --
True to enable node-to-node encryption.
AdvancedOptions (dict) --
The status of the AdvancedOptions .
(string) --
(string) --
LogPublishingOptions (dict) --
Log publishing options for the given domain.
(string) --
Type of log file. Can be one of the following:
INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
(dict) --
Log Publishing option that is set for a given domain. Attributes and their details:
CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
Enabled: Whether the log publishing for a given log type is enabled or not.
CloudWatchLogsLogGroupArn (string) --
ARN of the Cloudwatch log group to publish logs to.
Enabled (boolean) --
Whether the given log publishing option is enabled or not.
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. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
Description (string) --
The description of the UpdateStatus .
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 AutomatedUpdateDate .
DomainEndpointOptions (dict) --
The current status of the domain's endpoint options.
EnforceHTTPS (boolean) --
Whether only HTTPS endpoint should be enabled for the domain.
TLSSecurityPolicy (string) --
Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
CustomEndpointEnabled (boolean) --
Whether to enable a custom endpoint for the domain.
CustomEndpoint (string) --
The fully qualified domain for your custom endpoint.
CustomEndpointCertificateArn (string) --
The ACM certificate ARN for your custom endpoint.
AdvancedSecurityOptions (dict) --
The current status of the domain's advanced security options.
Enabled (boolean) --
True if advanced security is enabled.
InternalUserDatabaseEnabled (boolean) --
True if the internal user database is enabled.
SAMLOptions (dict) --
Describes the SAML application configured for a domain.
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 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) --
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
AnonymousAuthEnabled (boolean) --
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
AutoTuneOptions (dict) --
The current status of the domain's Auto-Tune options.
State (string) --
The AutoTuneState for the domain.
ErrorMessage (string) --
The error message while enabling or disabling Auto-Tune.
ChangeProgressDetails (dict) --
Specifies change details of the domain configuration change.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
Message (string) --
Contains an optional message associated with the domain configuration change.
{'DomainStatus': {'ChangeProgressDetails': {'ChangeId': 'string',
'Message': 'string'}}}
Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
See also: AWS API Documentation
Request Syntax
client.describe_domain(
DomainName='string'
)
string
[REQUIRED]
The name of the domain for which you want information.
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',
'VolumeSize': 123,
'Iops': 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'
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
}
}
Response Structure
(dict) --
The result of a DescribeDomain request. Contains the status of the domain specified in the request.
DomainStatus (dict) --
The current status of the domain.
DomainId (string) --
The unique identifier for the specified domain.
DomainName (string) --
The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
ARN (string) --
The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.
Created (boolean) --
The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.
Deleted (boolean) --
The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
Endpoint (string) --
The domain endpoint that you use to submit index and search requests.
Endpoints (dict) --
Map containing the domain endpoints used to submit index and search requests. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .
(string) --
(string) --
The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .
Processing (boolean) --
The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.
UpgradeProcessing (boolean) --
The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.
EngineVersion (string) --
ClusterConfig (dict) --
The type and number of instances in the domain.
InstanceType (string) --
The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
InstanceCount (integer) --
The number of instances in the specified domain cluster.
DedicatedMasterEnabled (boolean) --
A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
ZoneAwarenessEnabled (boolean) --
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
ZoneAwarenessConfig (dict) --
The zone awareness configuration for a domain when zone awareness is enabled.
AvailabilityZoneCount (integer) --
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
DedicatedMasterType (string) --
The instance type for a dedicated master node.
DedicatedMasterCount (integer) --
Total number of dedicated master nodes, active and on standby, for the cluster.
WarmEnabled (boolean) --
True to enable UltraWarm storage.
WarmType (string) --
The instance type for the OpenSearch cluster's warm nodes.
WarmCount (integer) --
The number of UltraWarm nodes in the cluster.
ColdStorageOptions (dict) --
Specifies the ColdStorageOptions config for a Domain
Enabled (boolean) --
Enable cold storage option. Accepted values true or false
EBSOptions (dict) --
The EBSOptions for the specified domain.
EBSEnabled (boolean) --
Whether EBS-based storage is enabled.
VolumeType (string) --
The volume type for EBS-based storage.
VolumeSize (integer) --
Integer to specify the size of an EBS volume.
Iops (integer) --
The IOPD for a Provisioned IOPS EBS volume (SSD).
AccessPolicies (string) --
IAM access policy as a JSON-formatted string.
SnapshotOptions (dict) --
The status of the SnapshotOptions .
AutomatedSnapshotStartHour (integer) --
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
VPCOptions (dict) --
The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
VPCId (string) --
The VPC ID for the domain. Exists only if the domain was created with VPCOptions .
SubnetIds (list) --
The subnets for the VPC endpoint.
(string) --
AvailabilityZones (list) --
The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .
(string) --
SecurityGroupIds (list) --
The security groups for the VPC endpoint.
(string) --
CognitoOptions (dict) --
The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .
Enabled (boolean) --
The option to enable Cognito for OpenSearch Dashboards authentication.
UserPoolId (string) --
The Cognito user pool ID for OpenSearch Dashboards authentication.
IdentityPoolId (string) --
The Cognito identity pool ID for OpenSearch Dashboards authentication.
RoleArn (string) --
The role ARN that provides OpenSearch permissions for accessing Cognito resources.
EncryptionAtRestOptions (dict) --
The status of the EncryptionAtRestOptions .
Enabled (boolean) --
The option to enable encryption at rest.
KmsKeyId (string) --
The KMS key ID for encryption at rest options.
NodeToNodeEncryptionOptions (dict) --
The status of the NodeToNodeEncryptionOptions .
Enabled (boolean) --
True to enable node-to-node encryption.
AdvancedOptions (dict) --
The status of the AdvancedOptions .
(string) --
(string) --
LogPublishingOptions (dict) --
Log publishing options for the given domain.
(string) --
Type of log file. Can be one of the following:
INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
(dict) --
Log Publishing option that is set for a given domain. Attributes and their details:
CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
Enabled: Whether the log publishing for a given log type is enabled or not.
CloudWatchLogsLogGroupArn (string) --
ARN of the Cloudwatch log group to publish logs to.
Enabled (boolean) --
Whether the given log publishing option is enabled or not.
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. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
Description (string) --
The description of the UpdateStatus .
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 AutomatedUpdateDate .
DomainEndpointOptions (dict) --
The current status of the domain's endpoint options.
EnforceHTTPS (boolean) --
Whether only HTTPS endpoint should be enabled for the domain.
TLSSecurityPolicy (string) --
Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
CustomEndpointEnabled (boolean) --
Whether to enable a custom endpoint for the domain.
CustomEndpoint (string) --
The fully qualified domain for your custom endpoint.
CustomEndpointCertificateArn (string) --
The ACM certificate ARN for your custom endpoint.
AdvancedSecurityOptions (dict) --
The current status of the domain's advanced security options.
Enabled (boolean) --
True if advanced security is enabled.
InternalUserDatabaseEnabled (boolean) --
True if the internal user database is enabled.
SAMLOptions (dict) --
Describes the SAML application configured for a domain.
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 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) --
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
AnonymousAuthEnabled (boolean) --
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
AutoTuneOptions (dict) --
The current status of the domain's Auto-Tune options.
State (string) --
The AutoTuneState for the domain.
ErrorMessage (string) --
The error message while enabling or disabling Auto-Tune.
ChangeProgressDetails (dict) --
Specifies change details of the domain configuration change.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
Message (string) --
Contains an optional message associated with the domain configuration change.
{'DomainConfig': {'ChangeProgressDetails': {'ChangeId': 'string',
'Message': 'string'}}}
Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
See also: AWS API Documentation
Request Syntax
client.describe_domain_config(
DomainName='string'
)
string
[REQUIRED]
The domain you want to get information about.
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',
'VolumeSize': 123,
'Iops': 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'
},
]
},
'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'
}
}
}
Response Structure
(dict) --
The result of a DescribeDomainConfig request. Contains the configuration information of the requested domain.
DomainConfig (dict) --
The configuration information of the domain requested in the DescribeDomainConfig request.
EngineVersion (dict) --
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
Options (string) --
The OpenSearch version for the specified OpenSearch domain.
Status (dict) --
The status of the OpenSearch version options for the specified OpenSearch domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
ClusterConfig (dict) --
The ClusterConfig for the domain.
Options (dict) --
The cluster configuration for the specified domain.
InstanceType (string) --
The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
InstanceCount (integer) --
The number of instances in the specified domain cluster.
DedicatedMasterEnabled (boolean) --
A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
ZoneAwarenessEnabled (boolean) --
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
ZoneAwarenessConfig (dict) --
The zone awareness configuration for a domain when zone awareness is enabled.
AvailabilityZoneCount (integer) --
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
DedicatedMasterType (string) --
The instance type for a dedicated master node.
DedicatedMasterCount (integer) --
Total number of dedicated master nodes, active and on standby, for the cluster.
WarmEnabled (boolean) --
True to enable UltraWarm storage.
WarmType (string) --
The instance type for the OpenSearch cluster's warm nodes.
WarmCount (integer) --
The number of UltraWarm nodes in the cluster.
ColdStorageOptions (dict) --
Specifies the ColdStorageOptions config for a Domain
Enabled (boolean) --
Enable cold storage option. Accepted values true or false
Status (dict) --
The cluster configuration status for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
EBSOptions (dict) --
The EBSOptions for the domain.
Options (dict) --
The EBS options for the specified domain.
EBSEnabled (boolean) --
Whether EBS-based storage is enabled.
VolumeType (string) --
The volume type for EBS-based storage.
VolumeSize (integer) --
Integer to specify the size of an EBS volume.
Iops (integer) --
The IOPD for a Provisioned IOPS EBS volume (SSD).
Status (dict) --
The status of the EBS options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
AccessPolicies (dict) --
IAM access policy as a JSON-formatted string.
Options (string) --
The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See Configuring access policies for more information.
Status (dict) --
The status of the access policy for the domain. See OptionStatus for the status information that's included.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
SnapshotOptions (dict) --
The SnapshotOptions for the domain.
Options (dict) --
The daily snapshot options specified for the domain.
AutomatedSnapshotStartHour (integer) --
The time, in UTC format, when the 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 of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
VPCOptions (dict) --
The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
Options (dict) --
The VPC options for the specified domain.
VPCId (string) --
The VPC ID for the domain. Exists only if the domain was created with VPCOptions .
SubnetIds (list) --
The subnets for the VPC endpoint.
(string) --
AvailabilityZones (list) --
The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .
(string) --
SecurityGroupIds (list) --
The security groups for the VPC endpoint.
(string) --
Status (dict) --
The status of the VPC options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
CognitoOptions (dict) --
The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .
Options (dict) --
Cognito options for the specified domain.
Enabled (boolean) --
The option to enable Cognito for OpenSearch Dashboards authentication.
UserPoolId (string) --
The Cognito user pool ID for OpenSearch Dashboards authentication.
IdentityPoolId (string) --
The Cognito identity pool ID for OpenSearch Dashboards authentication.
RoleArn (string) --
The role ARN that provides OpenSearch permissions for accessing Cognito resources.
Status (dict) --
The status of the Cognito options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
EncryptionAtRestOptions (dict) --
The EncryptionAtRestOptions for the domain.
Options (dict) --
The Encryption At Rest options for the specified domain.
Enabled (boolean) --
The option to enable encryption at rest.
KmsKeyId (string) --
The KMS key ID for encryption at rest options.
Status (dict) --
The status of the Encryption At Rest options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
NodeToNodeEncryptionOptions (dict) --
The NodeToNodeEncryptionOptions for the domain.
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 of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
AdvancedOptions (dict) --
The AdvancedOptions for the domain. See Advanced options for more information.
Options (dict) --
The status of advanced options for the specified domain.
(string) --
(string) --
Status (dict) --
The OptionStatus for advanced options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
LogPublishingOptions (dict) --
Log publishing options for the given domain.
Options (dict) --
The log publishing options configured for the domain.
(string) --
Type of log file. Can be one of the following:
INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
(dict) --
Log Publishing option that is set for a given domain. Attributes and their details:
CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
Enabled: Whether the log publishing for a given log type is enabled or not.
CloudWatchLogsLogGroupArn (string) --
ARN of the Cloudwatch log group to publish logs to.
Enabled (boolean) --
Whether the given log publishing option is enabled or not.
Status (dict) --
The status of the log publishing options for the domain. See OptionStatus for the status information that's included.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
DomainEndpointOptions (dict) --
The DomainEndpointOptions for the domain.
Options (dict) --
Options to configure the endpoint for the domain.
EnforceHTTPS (boolean) --
Whether only HTTPS endpoint should be enabled for the domain.
TLSSecurityPolicy (string) --
Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
CustomEndpointEnabled (boolean) --
Whether to enable a custom endpoint for the domain.
CustomEndpoint (string) --
The fully qualified domain for your custom endpoint.
CustomEndpointCertificateArn (string) --
The ACM certificate ARN for your custom endpoint.
Status (dict) --
The status of the endpoint options for the domain. See OptionStatus for the status information that's included.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
AdvancedSecurityOptions (dict) --
Specifies AdvancedSecurityOptions for the domain.
Options (dict) --
Advanced security options for the specified domain.
Enabled (boolean) --
True if advanced security is enabled.
InternalUserDatabaseEnabled (boolean) --
True if the internal user database is enabled.
SAMLOptions (dict) --
Describes the SAML application configured for a domain.
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 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) --
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
AnonymousAuthEnabled (boolean) --
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
Status (dict) --
Status of the advanced security options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
AutoTuneOptions (dict) --
Specifies AutoTuneOptions for the domain.
Options (dict) --
Specifies Auto-Tune options for the domain.
DesiredState (string) --
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
RollbackOnDisable (string) --
The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
MaintenanceSchedules (list) --
A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
(dict) --
Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
StartAt (datetime) --
The timestamp at which the Auto-Tune maintenance schedule starts.
Duration (dict) --
Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
Value (integer) --
Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
Unit (string) --
The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.
CronExpressionForRecurrence (string) --
A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
Status (dict) --
The status of the Auto-Tune options for the domain.
CreationDate (datetime) --
The timestamp of the Auto-Tune options creation date.
UpdateDate (datetime) --
The timestamp of when the Auto-Tune options were last updated.
UpdateVersion (integer) --
The latest version of the Auto-Tune options.
State (string) --
The AutoTuneState for the domain.
ErrorMessage (string) --
The error message while enabling or disabling Auto-Tune.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
ChangeProgressDetails (dict) --
Specifies change details of the domain configuration change.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
Message (string) --
Contains an optional message associated with the domain configuration change.
{'DomainStatusList': {'ChangeProgressDetails': {'ChangeId': 'string',
'Message': 'string'}}}
Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
See also: AWS API Documentation
Request Syntax
client.describe_domains(
DomainNames=[
'string',
]
)
list
[REQUIRED]
The domains for which you want information.
(string) --
The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
dict
Response Syntax
{
'DomainStatusList': [
{
'DomainId': 'string',
'DomainName': 'string',
'ARN': 'string',
'Created': True|False,
'Deleted': True|False,
'Endpoint': 'string',
'Endpoints': {
'string': 'string'
},
'Processing': True|False,
'UpgradeProcessing': True|False,
'EngineVersion': 'string',
'ClusterConfig': {
'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
'EBSOptions': {
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1',
'VolumeSize': 123,
'Iops': 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'
},
'ChangeProgressDetails': {
'ChangeId': 'string',
'Message': 'string'
}
},
]
}
Response Structure
(dict) --
The result of a DescribeDomains request. Contains the status of the specified domains or all domains owned by the account.
DomainStatusList (list) --
The status of the domains requested in the DescribeDomains request.
(dict) --
The current status of a domain.
DomainId (string) --
The unique identifier for the specified domain.
DomainName (string) --
The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
ARN (string) --
The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.
Created (boolean) --
The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.
Deleted (boolean) --
The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
Endpoint (string) --
The domain endpoint that you use to submit index and search requests.
Endpoints (dict) --
Map containing the domain endpoints used to submit index and search requests. Example key, value : 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com' .
(string) --
(string) --
The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com .
Processing (boolean) --
The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.
UpgradeProcessing (boolean) --
The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.
EngineVersion (string) --
ClusterConfig (dict) --
The type and number of instances in the domain.
InstanceType (string) --
The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
InstanceCount (integer) --
The number of instances in the specified domain cluster.
DedicatedMasterEnabled (boolean) --
A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
ZoneAwarenessEnabled (boolean) --
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
ZoneAwarenessConfig (dict) --
The zone awareness configuration for a domain when zone awareness is enabled.
AvailabilityZoneCount (integer) --
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
DedicatedMasterType (string) --
The instance type for a dedicated master node.
DedicatedMasterCount (integer) --
Total number of dedicated master nodes, active and on standby, for the cluster.
WarmEnabled (boolean) --
True to enable UltraWarm storage.
WarmType (string) --
The instance type for the OpenSearch cluster's warm nodes.
WarmCount (integer) --
The number of UltraWarm nodes in the cluster.
ColdStorageOptions (dict) --
Specifies the ColdStorageOptions config for a Domain
Enabled (boolean) --
Enable cold storage option. Accepted values true or false
EBSOptions (dict) --
The EBSOptions for the specified domain.
EBSEnabled (boolean) --
Whether EBS-based storage is enabled.
VolumeType (string) --
The volume type for EBS-based storage.
VolumeSize (integer) --
Integer to specify the size of an EBS volume.
Iops (integer) --
The IOPD for a Provisioned IOPS EBS volume (SSD).
AccessPolicies (string) --
IAM access policy as a JSON-formatted string.
SnapshotOptions (dict) --
The status of the SnapshotOptions .
AutomatedSnapshotStartHour (integer) --
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
VPCOptions (dict) --
The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
VPCId (string) --
The VPC ID for the domain. Exists only if the domain was created with VPCOptions .
SubnetIds (list) --
The subnets for the VPC endpoint.
(string) --
AvailabilityZones (list) --
The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .
(string) --
SecurityGroupIds (list) --
The security groups for the VPC endpoint.
(string) --
CognitoOptions (dict) --
The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .
Enabled (boolean) --
The option to enable Cognito for OpenSearch Dashboards authentication.
UserPoolId (string) --
The Cognito user pool ID for OpenSearch Dashboards authentication.
IdentityPoolId (string) --
The Cognito identity pool ID for OpenSearch Dashboards authentication.
RoleArn (string) --
The role ARN that provides OpenSearch permissions for accessing Cognito resources.
EncryptionAtRestOptions (dict) --
The status of the EncryptionAtRestOptions .
Enabled (boolean) --
The option to enable encryption at rest.
KmsKeyId (string) --
The KMS key ID for encryption at rest options.
NodeToNodeEncryptionOptions (dict) --
The status of the NodeToNodeEncryptionOptions .
Enabled (boolean) --
True to enable node-to-node encryption.
AdvancedOptions (dict) --
The status of the AdvancedOptions .
(string) --
(string) --
LogPublishingOptions (dict) --
Log publishing options for the given domain.
(string) --
Type of log file. Can be one of the following:
INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
(dict) --
Log Publishing option that is set for a given domain. Attributes and their details:
CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
Enabled: Whether the log publishing for a given log type is enabled or not.
CloudWatchLogsLogGroupArn (string) --
ARN of the Cloudwatch log group to publish logs to.
Enabled (boolean) --
Whether the given log publishing option is enabled or not.
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. This field can take the following values: ELIGIBLE , PENDING_UPDATE , IN_PROGRESS , COMPLETED , and NOT_ELIGIBLE .
Description (string) --
The description of the UpdateStatus .
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 AutomatedUpdateDate .
DomainEndpointOptions (dict) --
The current status of the domain's endpoint options.
EnforceHTTPS (boolean) --
Whether only HTTPS endpoint should be enabled for the domain.
TLSSecurityPolicy (string) --
Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
CustomEndpointEnabled (boolean) --
Whether to enable a custom endpoint for the domain.
CustomEndpoint (string) --
The fully qualified domain for your custom endpoint.
CustomEndpointCertificateArn (string) --
The ACM certificate ARN for your custom endpoint.
AdvancedSecurityOptions (dict) --
The current status of the domain's advanced security options.
Enabled (boolean) --
True if advanced security is enabled.
InternalUserDatabaseEnabled (boolean) --
True if the internal user database is enabled.
SAMLOptions (dict) --
Describes the SAML application configured for a domain.
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 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) --
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
AnonymousAuthEnabled (boolean) --
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
AutoTuneOptions (dict) --
The current status of the domain's Auto-Tune options.
State (string) --
The AutoTuneState for the domain.
ErrorMessage (string) --
The error message while enabling or disabling Auto-Tune.
ChangeProgressDetails (dict) --
Specifies change details of the domain configuration change.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
Message (string) --
Contains an optional message associated with the domain configuration change.
{'DomainConfig': {'ChangeProgressDetails': {'ChangeId': 'string',
'Message': 'string'}}}
Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
See also: AWS API Documentation
Request Syntax
client.update_domain_config(
DomainName='string',
ClusterConfig={
'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
'InstanceCount': 123,
'DedicatedMasterEnabled': True|False,
'ZoneAwarenessEnabled': True|False,
'ZoneAwarenessConfig': {
'AvailabilityZoneCount': 123
},
'DedicatedMasterType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
'DedicatedMasterCount': 123,
'WarmEnabled': True|False,
'WarmType': 'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search',
'WarmCount': 123,
'ColdStorageOptions': {
'Enabled': True|False
}
},
EBSOptions={
'EBSEnabled': True|False,
'VolumeType': 'standard'|'gp2'|'io1',
'VolumeSize': 123,
'Iops': 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'
},
]
},
DryRun=True|False
)
string
[REQUIRED]
The name of the domain you're updating.
dict
The type and number of instances to instantiate for the domain cluster.
InstanceType (string) --
The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
InstanceCount (integer) --
The number of instances in the specified domain cluster.
DedicatedMasterEnabled (boolean) --
A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
ZoneAwarenessEnabled (boolean) --
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
ZoneAwarenessConfig (dict) --
The zone awareness configuration for a domain when zone awareness is enabled.
AvailabilityZoneCount (integer) --
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
DedicatedMasterType (string) --
The instance type for a dedicated master node.
DedicatedMasterCount (integer) --
Total number of dedicated master nodes, active and on standby, for the cluster.
WarmEnabled (boolean) --
True to enable UltraWarm storage.
WarmType (string) --
The instance type for the OpenSearch cluster's warm nodes.
WarmCount (integer) --
The number of UltraWarm nodes in the cluster.
ColdStorageOptions (dict) --
Specifies the ColdStorageOptions config for a Domain
Enabled (boolean) -- [REQUIRED]
Enable cold storage option. Accepted values true or false
dict
Specify the type and size of the EBS volume to use.
EBSEnabled (boolean) --
Whether EBS-based storage is enabled.
VolumeType (string) --
The volume type for EBS-based storage.
VolumeSize (integer) --
Integer to specify the size of an EBS volume.
Iops (integer) --
The IOPD for a Provisioned IOPS EBS volume (SSD).
dict
Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
AutomatedSnapshotStartHour (integer) --
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
dict
Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
SubnetIds (list) --
The subnets for the VPC endpoint.
(string) --
SecurityGroupIds (list) --
The security groups for the VPC endpoint.
(string) --
dict
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .
Enabled (boolean) --
The option to enable Cognito for OpenSearch Dashboards authentication.
UserPoolId (string) --
The Cognito user pool ID for OpenSearch Dashboards authentication.
IdentityPoolId (string) --
The Cognito identity pool ID for OpenSearch Dashboards authentication.
RoleArn (string) --
The role ARN that provides OpenSearch permissions for accessing Cognito resources.
dict
Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true . See Advanced options for more information.
(string) --
(string) --
string
IAM access policy as a JSON-formatted string.
dict
Map of LogType and LogPublishingOption , each containing options to publish a given type of OpenSearch log.
(string) --
Type of log file. Can be one of the following:
INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
(dict) --
Log Publishing option that is set for a given domain. Attributes and their details:
CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
Enabled: Whether the log publishing for a given log type is enabled or not.
CloudWatchLogsLogGroupArn (string) --
ARN of the Cloudwatch log group to publish logs to.
Enabled (boolean) --
Whether the given log publishing option is enabled or not.
dict
Specifies encryption of data at rest options.
Enabled (boolean) --
The option to enable encryption at rest.
KmsKeyId (string) --
The KMS key ID for encryption at rest options.
dict
Options to specify configuration that will be applied to the domain endpoint.
EnforceHTTPS (boolean) --
Whether only HTTPS endpoint should be enabled for the domain.
TLSSecurityPolicy (string) --
Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
CustomEndpointEnabled (boolean) --
Whether to enable a custom endpoint for the domain.
CustomEndpoint (string) --
The fully qualified domain for your custom endpoint.
CustomEndpointCertificateArn (string) --
The ACM certificate ARN for your custom endpoint.
dict
Specifies node-to-node encryption options.
Enabled (boolean) --
True to enable node-to-node encryption.
dict
Specifies advanced security options.
Enabled (boolean) --
True if advanced security is enabled.
InternalUserDatabaseEnabled (boolean) --
True if the internal user database is enabled.
MasterUserOptions (dict) --
Credentials for the master user: username and password, ARN, or both.
MasterUserARN (string) --
ARN for the master user (if IAM is enabled).
MasterUserName (string) --
The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.
MasterUserPassword (string) --
The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.
SAMLOptions (dict) --
The SAML application configuration for the domain.
Enabled (boolean) --
True if SAML is enabled.
Idp (dict) --
The SAML Identity Provider's information.
MetadataContent (string) -- [REQUIRED]
The metadata of the SAML application in XML format.
EntityId (string) -- [REQUIRED]
The unique entity ID of the application in SAML identity provider.
MasterUserName (string) --
The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.
MasterBackendRole (string) --
The backend role that the SAML master user is mapped to.
SubjectKey (string) --
Element of the SAML assertion to use for username. Default is NameID.
RolesKey (string) --
Element of the SAML assertion to use for backend roles. Default is roles.
SessionTimeoutMinutes (integer) --
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
AnonymousAuthEnabled (boolean) --
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
dict
Specifies Auto-Tune options.
DesiredState (string) --
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
RollbackOnDisable (string) --
The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
MaintenanceSchedules (list) --
A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
(dict) --
Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
StartAt (datetime) --
The timestamp at which the Auto-Tune maintenance schedule starts.
Duration (dict) --
Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
Value (integer) --
Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
Unit (string) --
The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.
CronExpressionForRecurrence (string) --
A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
boolean
This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.
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',
'VolumeSize': 123,
'Iops': 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'
},
]
},
'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'
}
},
'DryRunResults': {
'DeploymentType': 'string',
'Message': 'string'
}
}
Response Structure
(dict) --
The result of an UpdateDomain request. Contains the status of the domain being updated.
DomainConfig (dict) --
The status of the updated domain.
EngineVersion (dict) --
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
Options (string) --
The OpenSearch version for the specified OpenSearch domain.
Status (dict) --
The status of the OpenSearch version options for the specified OpenSearch domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
ClusterConfig (dict) --
The ClusterConfig for the domain.
Options (dict) --
The cluster configuration for the specified domain.
InstanceType (string) --
The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
InstanceCount (integer) --
The number of instances in the specified domain cluster.
DedicatedMasterEnabled (boolean) --
A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
ZoneAwarenessEnabled (boolean) --
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
ZoneAwarenessConfig (dict) --
The zone awareness configuration for a domain when zone awareness is enabled.
AvailabilityZoneCount (integer) --
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
DedicatedMasterType (string) --
The instance type for a dedicated master node.
DedicatedMasterCount (integer) --
Total number of dedicated master nodes, active and on standby, for the cluster.
WarmEnabled (boolean) --
True to enable UltraWarm storage.
WarmType (string) --
The instance type for the OpenSearch cluster's warm nodes.
WarmCount (integer) --
The number of UltraWarm nodes in the cluster.
ColdStorageOptions (dict) --
Specifies the ColdStorageOptions config for a Domain
Enabled (boolean) --
Enable cold storage option. Accepted values true or false
Status (dict) --
The cluster configuration status for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
EBSOptions (dict) --
The EBSOptions for the domain.
Options (dict) --
The EBS options for the specified domain.
EBSEnabled (boolean) --
Whether EBS-based storage is enabled.
VolumeType (string) --
The volume type for EBS-based storage.
VolumeSize (integer) --
Integer to specify the size of an EBS volume.
Iops (integer) --
The IOPD for a Provisioned IOPS EBS volume (SSD).
Status (dict) --
The status of the EBS options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
AccessPolicies (dict) --
IAM access policy as a JSON-formatted string.
Options (string) --
The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See Configuring access policies for more information.
Status (dict) --
The status of the access policy for the domain. See OptionStatus for the status information that's included.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
SnapshotOptions (dict) --
The SnapshotOptions for the domain.
Options (dict) --
The daily snapshot options specified for the domain.
AutomatedSnapshotStartHour (integer) --
The time, in UTC format, when the 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 of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
VPCOptions (dict) --
The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
Options (dict) --
The VPC options for the specified domain.
VPCId (string) --
The VPC ID for the domain. Exists only if the domain was created with VPCOptions .
SubnetIds (list) --
The subnets for the VPC endpoint.
(string) --
AvailabilityZones (list) --
The Availability Zones for the domain. Exists only if the domain was created with VPCOptions .
(string) --
SecurityGroupIds (list) --
The security groups for the VPC endpoint.
(string) --
Status (dict) --
The status of the VPC options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
CognitoOptions (dict) --
The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards .
Options (dict) --
Cognito options for the specified domain.
Enabled (boolean) --
The option to enable Cognito for OpenSearch Dashboards authentication.
UserPoolId (string) --
The Cognito user pool ID for OpenSearch Dashboards authentication.
IdentityPoolId (string) --
The Cognito identity pool ID for OpenSearch Dashboards authentication.
RoleArn (string) --
The role ARN that provides OpenSearch permissions for accessing Cognito resources.
Status (dict) --
The status of the Cognito options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
EncryptionAtRestOptions (dict) --
The EncryptionAtRestOptions for the domain.
Options (dict) --
The Encryption At Rest options for the specified domain.
Enabled (boolean) --
The option to enable encryption at rest.
KmsKeyId (string) --
The KMS key ID for encryption at rest options.
Status (dict) --
The status of the Encryption At Rest options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
NodeToNodeEncryptionOptions (dict) --
The NodeToNodeEncryptionOptions for the domain.
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 of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
AdvancedOptions (dict) --
The AdvancedOptions for the domain. See Advanced options for more information.
Options (dict) --
The status of advanced options for the specified domain.
(string) --
(string) --
Status (dict) --
The OptionStatus for advanced options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
LogPublishingOptions (dict) --
Log publishing options for the given domain.
Options (dict) --
The log publishing options configured for the domain.
(string) --
Type of log file. Can be one of the following:
INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
(dict) --
Log Publishing option that is set for a given domain. Attributes and their details:
CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.
Enabled: Whether the log publishing for a given log type is enabled or not.
CloudWatchLogsLogGroupArn (string) --
ARN of the Cloudwatch log group to publish logs to.
Enabled (boolean) --
Whether the given log publishing option is enabled or not.
Status (dict) --
The status of the log publishing options for the domain. See OptionStatus for the status information that's included.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
DomainEndpointOptions (dict) --
The DomainEndpointOptions for the domain.
Options (dict) --
Options to configure the endpoint for the domain.
EnforceHTTPS (boolean) --
Whether only HTTPS endpoint should be enabled for the domain.
TLSSecurityPolicy (string) --
Specify the TLS security policy to apply to the HTTPS endpoint of the domain. Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2
CustomEndpointEnabled (boolean) --
Whether to enable a custom endpoint for the domain.
CustomEndpoint (string) --
The fully qualified domain for your custom endpoint.
CustomEndpointCertificateArn (string) --
The ACM certificate ARN for your custom endpoint.
Status (dict) --
The status of the endpoint options for the domain. See OptionStatus for the status information that's included.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
AdvancedSecurityOptions (dict) --
Specifies AdvancedSecurityOptions for the domain.
Options (dict) --
Advanced security options for the specified domain.
Enabled (boolean) --
True if advanced security is enabled.
InternalUserDatabaseEnabled (boolean) --
True if the internal user database is enabled.
SAMLOptions (dict) --
Describes the SAML application configured for a domain.
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 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) --
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
AnonymousAuthEnabled (boolean) --
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
Status (dict) --
Status of the advanced security options for the specified domain.
CreationDate (datetime) --
The timestamp of 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) --
Provides the OptionState for the domain.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
AutoTuneOptions (dict) --
Specifies AutoTuneOptions for the domain.
Options (dict) --
Specifies Auto-Tune options for the domain.
DesiredState (string) --
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
RollbackOnDisable (string) --
The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
MaintenanceSchedules (list) --
A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
(dict) --
Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
StartAt (datetime) --
The timestamp at which the Auto-Tune maintenance schedule starts.
Duration (dict) --
Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
Value (integer) --
Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
Unit (string) --
The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.
CronExpressionForRecurrence (string) --
A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
Status (dict) --
The status of the Auto-Tune options for the domain.
CreationDate (datetime) --
The timestamp of the Auto-Tune options creation date.
UpdateDate (datetime) --
The timestamp of when the Auto-Tune options were last updated.
UpdateVersion (integer) --
The latest version of the Auto-Tune options.
State (string) --
The AutoTuneState for the domain.
ErrorMessage (string) --
The error message while enabling or disabling Auto-Tune.
PendingDeletion (boolean) --
Indicates whether the domain is being deleted.
ChangeProgressDetails (dict) --
Specifies change details of the domain configuration change.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
Message (string) --
Contains an optional message associated with the domain configuration change.
DryRunResults (dict) --
Contains result of DryRun.
DeploymentType (string) --
Specifies the way in which Amazon OpenSearch Service applies the update. Possible responses are Blue/Green (the update requires a blue/green deployment), DynamicUpdate (no blue/green required), Undetermined (the domain is undergoing an update and can't predict the deployment type; try again after the update is complete), and None (the request doesn't include any configuration changes).
Message (string) --
Contains an optional message associated with the DryRunResults.
{'ChangeProgressDetails': {'ChangeId': 'string', 'Message': 'string'}}
Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
See also: AWS API Documentation
Request Syntax
client.upgrade_domain(
DomainName='string',
TargetVersion='string',
PerformCheckOnly=True|False,
AdvancedOptions={
'string': 'string'
}
)
string
[REQUIRED]
The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
string
[REQUIRED]
The version of OpenSearch you intend to upgrade the domain to.
boolean
When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
dict
Exposes select native OpenSearch configuration values from opensearch.yml . Currently, the following advanced options are available:
Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true . See Advanced cluster parameters for more information.
Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.
For more information, see Advanced cluster parameters .
(string) --
(string) --
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 response returned by `` UpgradeDomain `` operation.
UpgradeId (string) --
DomainName (string) --
The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
TargetVersion (string) --
The version of OpenSearch that you intend to upgrade the domain to.
PerformCheckOnly (boolean) --
When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
AdvancedOptions (dict) --
Exposes select native OpenSearch configuration values from opensearch.yml . Currently, the following advanced options are available:
Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true . See Advanced cluster parameters for more information.
Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.
For more information, see Advanced cluster parameters .
(string) --
(string) --
ChangeProgressDetails (dict) --
Specifies change details of the domain configuration change.
ChangeId (string) --
The unique change identifier associated with a specific domain configuration change.
Message (string) --
Contains an optional message associated with the domain configuration change.