OpenSearchService ***************** Client ====== class OpenSearchService.Client A low-level client representing Amazon OpenSearch Service Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service requests is Region specific: es.*region*.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints. import boto3 client = boto3.client('opensearch') These are the available methods: * accept_inbound_connection * add_data_source * add_direct_query_data_source * add_tags * associate_package * associate_packages * authorize_vpc_endpoint_access * can_paginate * cancel_domain_config_change * cancel_service_software_update * close * create_application * create_domain * create_outbound_connection * create_package * create_vpc_endpoint * delete_application * delete_data_source * delete_direct_query_data_source * delete_domain * delete_inbound_connection * delete_outbound_connection * delete_package * delete_vpc_endpoint * describe_domain * describe_domain_auto_tunes * describe_domain_change_progress * describe_domain_config * describe_domain_health * describe_domain_nodes * describe_domains * describe_dry_run_progress * describe_inbound_connections * describe_instance_type_limits * describe_outbound_connections * describe_packages * describe_reserved_instance_offerings * describe_reserved_instances * describe_vpc_endpoints * dissociate_package * dissociate_packages * get_application * get_compatible_versions * get_data_source * get_direct_query_data_source * get_domain_maintenance_status * get_package_version_history * get_paginator * get_upgrade_history * get_upgrade_status * get_waiter * list_applications * list_data_sources * list_direct_query_data_sources * list_domain_maintenances * list_domain_names * list_domains_for_package * list_instance_type_details * list_packages_for_domain * list_scheduled_actions * list_tags * list_versions * list_vpc_endpoint_access * list_vpc_endpoints * list_vpc_endpoints_for_domain * purchase_reserved_instance_offering * reject_inbound_connection * remove_tags * revoke_vpc_endpoint_access * start_domain_maintenance * start_service_software_update * update_application * update_data_source * update_direct_query_data_source * update_domain_config * update_package * update_package_scope * update_scheduled_action * update_vpc_endpoint * upgrade_domain Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListApplications OpenSearchService / Paginator / ListApplications ListApplications **************** class OpenSearchService.Paginator.ListApplications paginator = client.get_paginator('list_applications') paginate(**kwargs) Creates an iterator that will paginate through responses from "OpenSearchService.Client.list_applications()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( statuses=[ 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED', ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **statuses** (*list*) -- Filters the list of OpenSearch applications by status. Possible values: "CREATING", "UPDATING", "DELETING", "FAILED", "ACTIVE", and "DELETED". * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ApplicationSummaries': [ { 'id': 'string', 'arn': 'string', 'name': 'string', 'endpoint': 'string', 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ApplicationSummaries** *(list) --* Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation time, and last update time. * *(dict) --* Basic details of an OpenSearch application. * **id** *(string) --* The unique identifier of an OpenSearch application. * **arn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **name** *(string) --* The name of an OpenSearch application. * **endpoint** *(string) --* The endpoint URL of an OpenSearch application. * **status** *(string) --* The current status of an OpenSearch application. Possible values: "CREATING", "UPDATING", "DELETING", "FAILED", "ACTIVE", and "DELETED". * **createdAt** *(datetime) --* The timestamp when an OpenSearch application was created. * **lastUpdatedAt** *(datetime) --* The timestamp of the last update to an OpenSearch application. * **NextToken** *(string) --* A token to resume pagination. OpenSearchService / Client / create_outbound_connection create_outbound_connection ************************** OpenSearchService.Client.create_outbound_connection(**kwargs) Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.create_outbound_connection( LocalDomainInfo={ 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, RemoteDomainInfo={ 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, ConnectionAlias='string', ConnectionMode='DIRECT'|'VPC_ENDPOINT', ConnectionProperties={ 'Endpoint': 'string', 'CrossClusterSearch': { 'SkipUnavailable': 'ENABLED'|'DISABLED' } } ) Parameters: * **LocalDomainInfo** (*dict*) -- **[REQUIRED]** Name and Region of the source (local) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* **[REQUIRED]** Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **RemoteDomainInfo** (*dict*) -- **[REQUIRED]** Name and Region of the destination (remote) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* **[REQUIRED]** Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **ConnectionAlias** (*string*) -- **[REQUIRED]** Name of the connection. * **ConnectionMode** (*string*) -- The connection mode. * **ConnectionProperties** (*dict*) -- The "ConnectionProperties" for the outbound connection. * **Endpoint** *(string) --* Warning: The Endpoint attribute cannot be modified. The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode. * **CrossClusterSearch** *(dict) --* The connection properties for cross cluster search. * **SkipUnavailable** *(string) --* The status of the "SkipUnavailable" setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross- cluster queries return partial results despite failures on one or more remote clusters. Return type: dict Returns: **Response Syntax** { 'LocalDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'RemoteDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'ConnectionAlias': 'string', 'ConnectionStatus': { 'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED', 'Message': 'string' }, 'ConnectionId': 'string', 'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT', 'ConnectionProperties': { 'Endpoint': 'string', 'CrossClusterSearch': { 'SkipUnavailable': 'ENABLED'|'DISABLED' } } } **Response Structure** * *(dict) --* The result of a "CreateOutboundConnection" request. Contains details about the newly created cross-cluster connection. * **LocalDomainInfo** *(dict) --* Information about the source (local) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **RemoteDomainInfo** *(dict) --* Information about the destination (remote) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **ConnectionAlias** *(string) --* Name of the connection. * **ConnectionStatus** *(dict) --* The status of the connection. * **StatusCode** *(string) --* The status code for the outbound connection. Can be one of the following: * **VALIDATING** - The outbound connection request is being validated. * **VALIDATION_FAILED** - Validation failed for the connection request. * **PENDING_ACCEPTANCE**: Outbound connection request is validated and is not yet accepted by the remote domain owner. * **APPROVED** - Outbound connection has been approved by the remote domain owner for getting provisioned. * **PROVISIONING** - Outbound connection request is in process. * **ACTIVE** - Outbound connection is active and ready to use. * **REJECTING** - Outbound connection rejection by remote domain owner is in progress. * **REJECTED** - Outbound connection request is rejected by remote domain owner. * **DELETING** - Outbound connection deletion is in progress. * **DELETED** - Outbound connection is deleted and can no longer be used. * **Message** *(string) --* Verbose information for the outbound connection. * **ConnectionId** *(string) --* The unique identifier for the created outbound connection, which is used for subsequent operations on the connection. * **ConnectionMode** *(string) --* The connection mode. * **ConnectionProperties** *(dict) --* The "ConnectionProperties" for the newly created connection. * **Endpoint** *(string) --* Warning: The Endpoint attribute cannot be modified. The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode. * **CrossClusterSearch** *(dict) --* The connection properties for cross cluster search. * **SkipUnavailable** *(string) --* The status of the "SkipUnavailable" setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross- cluster queries return partial results despite failures on one or more remote clusters. **Exceptions** * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceAlreadyExistsExcept ion" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / list_applications list_applications ***************** OpenSearchService.Client.list_applications(**kwargs) Lists all OpenSearch applications under your account. See also: AWS API Documentation **Request Syntax** response = client.list_applications( nextToken='string', statuses=[ 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED', ], maxResults=123 ) Parameters: * **nextToken** (*string*) -- When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. * **statuses** (*list*) -- Filters the list of OpenSearch applications by status. Possible values: "CREATING", "UPDATING", "DELETING", "FAILED", "ACTIVE", and "DELETED". * *(string) --* * **maxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return for a given request. Return type: dict Returns: **Response Syntax** { 'ApplicationSummaries': [ { 'id': 'string', 'arn': 'string', 'name': 'string', 'endpoint': 'string', 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **ApplicationSummaries** *(list) --* Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation time, and last update time. * *(dict) --* Basic details of an OpenSearch application. * **id** *(string) --* The unique identifier of an OpenSearch application. * **arn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **name** *(string) --* The name of an OpenSearch application. * **endpoint** *(string) --* The endpoint URL of an OpenSearch application. * **status** *(string) --* The current status of an OpenSearch application. Possible values: "CREATING", "UPDATING", "DELETING", "FAILED", "ACTIVE", and "DELETED". * **createdAt** *(datetime) --* The timestamp when an OpenSearch application was created. * **lastUpdatedAt** *(datetime) --* The timestamp of the last update to an OpenSearch application. * **nextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / get_paginator get_paginator ************* OpenSearchService.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. OpenSearchService / Client / list_domains_for_package list_domains_for_package ************************ OpenSearchService.Client.list_domains_for_package(**kwargs) Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.list_domains_for_package( PackageID='string', MaxResults=123, NextToken='string' ) Parameters: * **PackageID** (*string*) -- **[REQUIRED]** The unique identifier of the package for which to list associated domains. * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "ListDomainsForPackage" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListDomainsForPackage" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'DomainPackageDetailsList': [ { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', 'LastUpdated': datetime(2015, 1, 1), 'DomainName': 'string', 'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED', 'PackageVersion': 'string', 'PrerequisitePackageIDList': [ 'string', ], 'ReferencePath': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'AssociationConfiguration': { 'KeyStoreAccessOption': { 'KeyAccessRoleArn': 'string', 'KeyStoreAccessEnabled': True|False } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Container for the response parameters to the "ListDomainsForPackage" operation. * **DomainPackageDetailsList** *(list) --* Information about all domains associated with a package. * *(dict) --* Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service. * **PackageID** *(string) --* Internal ID of the package. * **PackageName** *(string) --* User-specified name of the package. * **PackageType** *(string) --* The type of package. * **LastUpdated** *(datetime) --* Timestamp of the most recent update to the package association status. * **DomainName** *(string) --* Name of the domain that the package is associated with. * **DomainPackageStatus** *(string) --* State of the association. * **PackageVersion** *(string) --* The current version of the package. * **PrerequisitePackageIDList** *(list) --* A list of package IDs that must be associated with the domain before or with the package can be associated. * *(string) --* * **ReferencePath** *(string) --* The relative path of the package on the OpenSearch Service cluster nodes. This is "synonym_path" when the package is for synonym files. * **ErrorDetails** *(dict) --* Additional information if the package is in an error state. Null otherwise. * **ErrorType** *(string) --* The type of error that occurred. * **ErrorMessage** *(string) --* A message describing the error. * **AssociationConfiguration** *(dict) --* The configuration for associating a package with an Amazon OpenSearch Service domain. * **KeyStoreAccessOption** *(dict) --* The configuration parameters to enable accessing the key store required by the package. * **KeyAccessRoleArn** *(string) --* Role ARN to access the KeyStore Key * **KeyStoreAccessEnabled** *(boolean) --* This indicates whether Key Store access is enabled * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / get_package_version_history get_package_version_history *************************** OpenSearchService.Client.get_package_version_history(**kwargs) Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.get_package_version_history( PackageID='string', MaxResults=123, NextToken='string' ) Parameters: * **PackageID** (*string*) -- **[REQUIRED]** The unique identifier of the package. * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "GetPackageVersionHistory" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "GetPackageVersionHistory" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'PackageID': 'string', 'PackageVersionHistoryList': [ { 'PackageVersion': 'string', 'CommitMessage': 'string', 'CreatedAt': datetime(2015, 1, 1), 'PluginProperties': { 'Name': 'string', 'Description': 'string', 'Version': 'string', 'ClassName': 'string', 'UncompressedSizeInBytes': 123 }, 'PackageConfiguration': { 'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'LicenseFilepath': 'string', 'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'RequiresRestartForConfigurationUpdate': True|False } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Container for response returned by "GetPackageVersionHistory" operation. * **PackageID** *(string) --* The unique identifier of the package. * **PackageVersionHistoryList** *(list) --* A list of package versions, along with their creation time and commit message. * *(dict) --* Details about a package version. * **PackageVersion** *(string) --* The package version. * **CommitMessage** *(string) --* A message associated with the package version when it was uploaded. * **CreatedAt** *(datetime) --* The date and time when the package was created. * **PluginProperties** *(dict) --* Additional information about plugin properties if the package is a "ZIP-PLUGIN" package. * **Name** *(string) --* The name of the plugin. * **Description** *(string) --* The description of the plugin. * **Version** *(string) --* The version of the plugin. * **ClassName** *(string) --* The name of the class to load. * **UncompressedSizeInBytes** *(integer) --* The uncompressed size of the plugin. * **PackageConfiguration** *(dict) --* The configuration details for a specific version of a package. * **LicenseRequirement** *(string) --* The license requirements for the package. * **LicenseFilepath** *(string) --* The relative file path for the license associated with the package. * **ConfigurationRequirement** *(string) --* The configuration requirements for the package. * **RequiresRestartForConfigurationUpdate** *(boolean) --* This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / list_domain_maintenances list_domain_maintenances ************************ OpenSearchService.Client.list_domain_maintenances(**kwargs) A list of maintenance actions for the domain. See also: AWS API Documentation **Request Syntax** response = client.list_domain_maintenances( DomainName='string', Action='REBOOT_NODE'|'RESTART_SEARCH_PROCESS'|'RESTART_DASHBOARD', Status='PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'TIMED_OUT', MaxResults=123, NextToken='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. * **Action** (*string*) -- The name of the action. * **Status** (*string*) -- The status of the action. * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "ListDomainMaintenances" operation returns a "nextToken", include the returned "nextToken" in subsequent "ListDomainMaintenances" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'DomainMaintenances': [ { 'MaintenanceId': 'string', 'DomainName': 'string', 'Action': 'REBOOT_NODE'|'RESTART_SEARCH_PROCESS'|'RESTART_DASHBOARD', 'NodeId': 'string', 'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'TIMED_OUT', 'StatusMessage': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The result of a "ListDomainMaintenances" request that contains information about the requested actions. * **DomainMaintenances** *(list) --* A list of the submitted maintenance actions. * *(dict) --* Container for the domain maintenance details. * **MaintenanceId** *(string) --* The ID of the requested action. * **DomainName** *(string) --* The name of the domain. * **Action** *(string) --* The name of the action. * **NodeId** *(string) --* The ID of the data node. * **Status** *(string) --* The status of the action. * **StatusMessage** *(string) --* The status message for the action. * **CreatedAt** *(datetime) --* The time at which the action was created. * **UpdatedAt** *(datetime) --* The time at which the action was updated. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / describe_domain describe_domain *************** OpenSearchService.Client.describe_domain(**kwargs) Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN. See also: AWS API Documentation **Request Syntax** response = client.describe_domain( DomainName='string' ) Parameters: **DomainName** (*string*) -- **[REQUIRED]** The name of the domain that you want information about. Return type: dict Returns: **Response Syntax** { 'DomainStatus': { 'DomainId': 'string', 'DomainName': 'string', 'ARN': 'string', 'Created': True|False, 'Deleted': True|False, 'Endpoint': 'string', 'EndpointV2': 'string', 'Endpoints': { 'string': 'string' }, 'DomainEndpointV2HostedZoneId': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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 }, 'MultiAZWithStandbyEnabled': True|False, 'NodeOptions': [ { 'NodeType': 'coordinator', 'NodeConfig': { 'Enabled': True|False, 'Type': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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', 'Count': 123 } }, ] }, 'EBSOptions': { 'EBSEnabled': True|False, 'VolumeType': 'standard'|'gp2'|'io1'|'gp3', 'VolumeSize': 123, 'Iops': 123, 'Throughput': 123 }, 'AccessPolicies': 'string', 'IPAddressType': 'ipv4'|'dualstack', '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'|'Policy-Min-TLS-1-2-PFS-2023-10', '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 }, 'JWTOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string', 'PublicKey': 'string' }, 'IAMFederationOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string' }, 'AnonymousAuthDisableDate': datetime(2015, 1, 1), 'AnonymousAuthEnabled': True|False }, 'IdentityCenterOptions': { 'EnabledAPIAccess': True|False, 'IdentityCenterInstanceARN': 'string', 'SubjectKey': 'UserName'|'UserId'|'Email', 'RolesKey': 'GroupName'|'GroupId', 'IdentityCenterApplicationARN': 'string', 'IdentityStoreId': 'string' }, 'AutoTuneOptions': { 'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR', 'ErrorMessage': 'string', 'UseOffPeakWindow': True|False }, 'ChangeProgressDetails': { 'ChangeId': 'string', 'Message': 'string', 'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled', 'InitiatedBy': 'CUSTOMER'|'SERVICE', 'StartTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, 'OffPeakWindowOptions': { 'Enabled': True|False, 'OffPeakWindow': { 'WindowStartTime': { 'Hours': 123, 'Minutes': 123 } } }, 'SoftwareUpdateOptions': { 'AutoSoftwareUpdateEnabled': True|False }, 'DomainProcessingStatus': 'Creating'|'Active'|'Modifying'|'UpgradingEngineVersion'|'UpdatingServiceSoftware'|'Isolated'|'Deleting', 'ModifyingProperties': [ { 'Name': 'string', 'ActiveValue': 'string', 'PendingValue': 'string', 'ValueType': 'PLAIN_TEXT'|'STRINGIFIED_JSON' }, ], 'AIMLOptions': { 'NaturalLanguageQueryGenerationOptions': { 'DesiredState': 'ENABLED'|'DISABLED', 'CurrentState': 'NOT_ENABLED'|'ENABLE_COMPLETE'|'ENABLE_IN_PROGRESS'|'ENABLE_FAILED'|'DISABLE_COMPLETE'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED' }, 'S3VectorsEngine': { 'Enabled': True|False } } } } **Response Structure** * *(dict) --* Contains the status of the domain specified in the request. * **DomainStatus** *(dict) --* List that contains the status of each specified OpenSearch Service domain. * **DomainId** *(string) --* Unique identifier for the domain. * **DomainName** *(string) --* Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the *AWS Identity and Access Management User Guide*. * **Created** *(boolean) --* Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress. * **Deleted** *(boolean) --* Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned. * **Endpoint** *(string) --* Domain-specific endpoint used to submit index, search, and data upload requests to the domain. * **EndpointV2** *(string) --* If "IPAddressType" to set to "dualstack", a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. * **Endpoints** *(dict) --* The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example: * **IPv4 IP addresses** - "'vpc','vpc-endpoint- h2dsd34efgyghrtguk5gt6j2foh4.us- east-1.es.amazonaws.com'" * **Dual stack IP addresses** - "'vpcv2':'vpc-endpoint- h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'" * *(string) --* * *(string) --* The domain endpoint to which index and search requests are submitted. For example, "search-imdb-movies- oopcnjfn6ugo.eu-west-1.es.amazonaws.com" or "doc-imdb- movies-oopcnjfn6u.eu-west-1.es.amazonaws.com". * **DomainEndpointV2HostedZoneId** *(string) --* The dual stack hosted zone ID for the domain. * **Processing** *(boolean) --* The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active. * **UpgradeProcessing** *(boolean) --* The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active. * **EngineVersion** *(string) --* Version of OpenSearch or Elasticsearch that the domain is running, in the format "Elasticsearch_X.Y" or "OpenSearch_X.Y". * **ClusterConfig** *(dict) --* Container for the cluster configuration of the domain. * **InstanceType** *(string) --* Instance type of data nodes in the cluster. * **InstanceCount** *(integer) --* Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. * **DedicatedMasterEnabled** *(boolean) --* Indicates whether dedicated master nodes are enabled for the cluster. "True" if the cluster will use a dedicated master node. "False" if the cluster will not. * **ZoneAwarenessEnabled** *(boolean) --* Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi- AZ domain in Amazon OpenSearch Service. * **ZoneAwarenessConfig** *(dict) --* Container for zone awareness configuration options. Only required if "ZoneAwarenessEnabled" is "true". * **AvailabilityZoneCount** *(integer) --* If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are "2" and "3". If your domain is provisioned within a VPC, this value be equal to number of subnets. * **DedicatedMasterType** *(string) --* OpenSearch Service instance type of the dedicated master nodes in the cluster. * **DedicatedMasterCount** *(integer) --* Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. * **WarmEnabled** *(boolean) --* Whether to enable warm storage for the cluster. * **WarmType** *(string) --* The instance type for the cluster's warm nodes. * **WarmCount** *(integer) --* The number of warm nodes in the cluster. * **ColdStorageOptions** *(dict) --* Container for cold storage configuration options. * **Enabled** *(boolean) --* Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. * **MultiAZWithStandbyEnabled** *(boolean) --* A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **NodeOptions** *(list) --* List of node options for the domain. * *(dict) --* Configuration settings for defining the node type within a cluster. * **NodeType** *(string) --* Defines the type of node, such as coordinating nodes. * **NodeConfig** *(dict) --* Configuration options for defining the setup of any node type. * **Enabled** *(boolean) --* A boolean value indicating whether a specific node type is active or inactive. * **Type** *(string) --* The instance type of a particular node within the cluster. * **Count** *(integer) --* The number of nodes of a specific type within the cluster. * **EBSOptions** *(dict) --* Container for EBS-based storage settings for the domain. * **EBSEnabled** *(boolean) --* Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. * **VolumeType** *(string) --* Specifies the type of EBS volumes attached to data nodes. * **VolumeSize** *(integer) --* Specifies the size (in GiB) of EBS volumes attached to data nodes. * **Iops** *(integer) --* Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the "gp3" and provisioned IOPS EBS volume types. * **Throughput** *(integer) --* Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the "gp3" volume type. * **AccessPolicies** *(string) --* Identity and Access Management (IAM) policy document specifying the access policies for the domain. * **IPAddressType** *(string) --* The type of IP addresses supported by the endpoint for the domain. * **SnapshotOptions** *(dict) --* DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes. * **AutomatedSnapshotStartHour** *(integer) --* The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is "0" hours. * **VPCOptions** *(dict) --* The VPC configuration for the domain. * **VPCId** *(string) --* The ID for your VPC. Amazon VPC generates this value when you create a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. * *(string) --* * **AvailabilityZones** *(list) --* The list of Availability Zones associated with the VPC subnets. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. * *(string) --* * **CognitoOptions** *(dict) --* Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards. * **Enabled** *(boolean) --* Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. * **UserPoolId** *(string) --* The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **IdentityPoolId** *(string) --* The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **RoleArn** *(string) --* The "AmazonOpenSearchServiceCognitoAccess" role that allows OpenSearch Service to configure your user pool and identity pool. * **EncryptionAtRestOptions** *(dict) --* Encryption at rest settings for the domain. * **Enabled** *(boolean) --* True to enable encryption at rest. * **KmsKeyId** *(string) --* The KMS key ID. Takes the form "1a2a3a4-1a2a-3a4a-5a6a- 1a2a3a4a5a6a". * **NodeToNodeEncryptionOptions** *(dict) --* Whether node-to-node encryption is enabled or disabled. * **Enabled** *(boolean) --* True to enable node-to-node encryption. * **AdvancedOptions** *(dict) --* Key-value pairs that specify advanced configuration options. * *(string) --* * *(string) --* * **LogPublishingOptions** *(dict) --* Log publishing options for the domain. * *(string) --* The type of log file. Can be one of the following: * **INDEX_SLOW_LOGS** - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute. * **SEARCH_SLOW_LOGS** - Search slow logs contain search queries that took more time than the configured search query log threshold to execute. * **ES_APPLICATION_LOGS** - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting. * **AUDIT_LOGS** - Audit logs contain records of user requests for access to the domain. * *(dict) --* Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs. Note: After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. * **Enabled** *(boolean) --* Whether the log should be published. * **ServiceSoftwareOptions** *(dict) --* The current status of the domain's service software. * **CurrentVersion** *(string) --* The current service software version present on the domain. * **NewVersion** *(string) --* The new service software version, if one is available. * **UpdateAvailable** *(boolean) --* True if you're able to update your service software version. False if you can't update your service software version. * **Cancellable** *(boolean) --* True if you're able to cancel your service software version update. False if you can't cancel your service software update. * **UpdateStatus** *(string) --* The status of your service software update. * **Description** *(string) --* A description of the service software update status. * **AutomatedUpdateDate** *(datetime) --* The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. * **OptionalDeployment** *(boolean) --* True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date. * **DomainEndpointOptions** *(dict) --* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. * **EnforceHTTPS** *(boolean) --* True to require that all traffic to the domain arrive over HTTPS. * **TLSSecurityPolicy** *(string) --* Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports TLS version 1.0 to TLS version 1.2 * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports only TLS version 1.2 * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites * **CustomEndpointEnabled** *(boolean) --* Whether to enable a custom endpoint for the domain. * **CustomEndpoint** *(string) --* The fully qualified URL for the custom endpoint. * **CustomEndpointCertificateArn** *(string) --* The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). * **AdvancedSecurityOptions** *(dict) --* Settings for fine-grained access control. * **Enabled** *(boolean) --* True if fine-grained access control is enabled. * **InternalUserDatabaseEnabled** *(boolean) --* True if the internal user database is enabled. * **SAMLOptions** *(dict) --* Container for information about the SAML configuration for OpenSearch Dashboards. * **Enabled** *(boolean) --* True if SAML is enabled. * **Idp** *(dict) --* Describes the SAML identity provider's information. * **MetadataContent** *(string) --* The metadata of the SAML application, in XML format. * **EntityId** *(string) --* The unique entity ID of the application in the SAML identity provider. * **SubjectKey** *(string) --* The key used for matching the SAML subject attribute. * **RolesKey** *(string) --* The key used for matching the SAML roles attribute. * **SessionTimeoutMinutes** *(integer) --* The duration, in minutes, after which a user session becomes inactive. * **JWTOptions** *(dict) --* Container for information about the JWT configuration of the Amazon OpenSearch Service. * **Enabled** *(boolean) --* True if JWT use is enabled. * **SubjectKey** *(string) --* The key used for matching the JWT subject attribute. * **RolesKey** *(string) --* The key used for matching the JWT roles attribute. * **PublicKey** *(string) --* The key used to verify the signature of incoming JWT requests. * **IAMFederationOptions** *(dict) --* Container for information about the IAM federation configuration for an OpenSearch UI application. * **Enabled** *(boolean) --* True if IAM federation is enabled. * **SubjectKey** *(string) --* The key used for matching the IAM federation subject attribute. * **RolesKey** *(string) --* The key used for matching the IAM federation roles attribute. * **AnonymousAuthDisableDate** *(datetime) --* Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain. * **AnonymousAuthEnabled** *(boolean) --* True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. * **IdentityCenterOptions** *(dict) --* Configuration options for controlling IAM Identity Center integration within a domain. * **EnabledAPIAccess** *(boolean) --* Indicates whether IAM Identity Center is enabled for the application. * **IdentityCenterInstanceARN** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center instance. * **SubjectKey** *(string) --* Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center. * **RolesKey** *(string) --* Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center. * **IdentityCenterApplicationARN** *(string) --* The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service. * **IdentityStoreId** *(string) --* The identifier of the IAM Identity Store. * **AutoTuneOptions** *(dict) --* Auto-Tune settings for the domain. * **State** *(string) --* The current state of Auto-Tune on the domain. * **ErrorMessage** *(string) --* Any errors that occurred while enabling or disabling Auto-Tune. * **UseOffPeakWindow** *(boolean) --* Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule. * **ChangeProgressDetails** *(dict) --* Information about a configuration change happening on the domain. * **ChangeId** *(string) --* The ID of the configuration change. * **Message** *(string) --* A message corresponding to the status of the configuration change. * **ConfigChangeStatus** *(string) --* The current status of the configuration change. * **InitiatedBy** *(string) --* The IAM principal who initiated the configuration change. * **StartTime** *(datetime) --* The time that the configuration change was initiated, in Universal Coordinated Time (UTC). * **LastUpdatedTime** *(datetime) --* The last time that the configuration change was updated. * **OffPeakWindowOptions** *(dict) --* Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain. * **Enabled** *(boolean) --* Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain. * **OffPeakWindow** *(dict) --* Off-peak window settings for the domain. * **WindowStartTime** *(dict) --* A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. * **Hours** *(integer) --* The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, "17" refers to 5:00 P.M. UTC. * **Minutes** *(integer) --* The start minute of the window, in UTC. * **SoftwareUpdateOptions** *(dict) --* Service software update options for the domain. * **AutoSoftwareUpdateEnabled** *(boolean) --* Whether automatic service software updates are enabled for the domain. * **DomainProcessingStatus** *(string) --* The status of any changes that are currently in progress for the domain. * **ModifyingProperties** *(list) --* Information about the domain properties that are currently being modified. * *(dict) --* Information about the domain properties that are currently being modified. * **Name** *(string) --* The name of the property that is currently being modified. * **ActiveValue** *(string) --* The current value of the domain property that is being modified. * **PendingValue** *(string) --* The value that the property that is currently being modified will eventually have. * **ValueType** *(string) --* The type of value that is currently being modified. Properties can have two types: * "PLAIN_TEXT": Contain direct values such as "1", "True", or "c5.large.search". * "STRINGIFIED_JSON": Contain content in JSON format, such as {"Enabled":"True"}". * **AIMLOptions** *(dict) --* Container for parameters required to enable all machine learning features. * **NaturalLanguageQueryGenerationOptions** *(dict) --* Container for parameters required for natural language query generation on the specified domain. * **DesiredState** *(string) --* The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED. * **CurrentState** *(string) --* The current state of the natural language query generation feature, indicating completion, in progress, or failure. * **S3VectorsEngine** *(dict) --* Container for parameters representing the state of S3 vectors engine features on the specified domain. * **Enabled** *(boolean) --* Enables S3 vectors engine features. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / get_data_source get_data_source *************** OpenSearchService.Client.get_data_source(**kwargs) Retrieves information about a direct query data source. See also: AWS API Documentation **Request Syntax** response = client.get_data_source( DomainName='string', Name='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. * **Name** (*string*) -- **[REQUIRED]** The name of the data source to get information about. Return type: dict Returns: **Response Syntax** { 'DataSourceType': { 'S3GlueDataCatalog': { 'RoleArn': 'string' } }, 'Name': 'string', 'Description': 'string', 'Status': 'ACTIVE'|'DISABLED' } **Response Structure** * *(dict) --* The result of a "GetDataSource" operation. * **DataSourceType** *(dict) --* The type of data source. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "S3GlueDataCatalog". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **S3GlueDataCatalog** *(dict) --* An Amazon S3 data source. * **RoleArn** *(string) --* >The Amazon Resource Name (ARN) for the S3 Glue Data Catalog. * **Name** *(string) --* The name of the data source. * **Description** *(string) --* A description of the data source. * **Status** *(string) --* The status of the data source. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.DependencyFailureException" OpenSearchService / Client / list_scheduled_actions list_scheduled_actions ********************** OpenSearchService.Client.list_scheduled_actions(**kwargs) Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements. See also: AWS API Documentation **Request Syntax** response = client.list_scheduled_actions( DomainName='string', MaxResults=123, NextToken='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "ListScheduledActions" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListScheduledActions" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'ScheduledActions': [ { 'Id': 'string', 'Type': 'SERVICE_SOFTWARE_UPDATE'|'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING', 'Severity': 'HIGH'|'MEDIUM'|'LOW', 'ScheduledTime': 123, 'Description': 'string', 'ScheduledBy': 'CUSTOMER'|'SYSTEM', 'Status': 'PENDING_UPDATE'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE', 'Mandatory': True|False, 'Cancellable': True|False }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ScheduledActions** *(list) --* A list of actions that are scheduled for the domain. * *(dict) --* Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement. * **Id** *(string) --* The unique identifier of the scheduled action. * **Type** *(string) --* The type of action that will be taken on the domain. * **Severity** *(string) --* The severity of the action. * **ScheduledTime** *(integer) --* The time when the change is scheduled to happen. * **Description** *(string) --* A description of the action to be taken. * **ScheduledBy** *(string) --* Whether the action was scheduled manually ( "CUSTOMER", or by OpenSearch Service automatically ( "SYSTEM"). * **Status** *(string) --* The current status of the scheduled action. * **Mandatory** *(boolean) --* Whether the action is required or optional. * **Cancellable** *(boolean) --* Whether or not the scheduled action is cancellable. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.InvalidPaginationTokenExcep tion" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / associate_packages associate_packages ****************** OpenSearchService.Client.associate_packages(**kwargs) Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously. See also: AWS API Documentation **Request Syntax** response = client.associate_packages( PackageList=[ { 'PackageID': 'string', 'PrerequisitePackageIDList': [ 'string', ], 'AssociationConfiguration': { 'KeyStoreAccessOption': { 'KeyAccessRoleArn': 'string', 'KeyStoreAccessEnabled': True|False } } }, ], DomainName='string' ) Parameters: * **PackageList** (*list*) -- **[REQUIRED]** A list of packages and their prerequisites to be associated with a domain. * *(dict) --* Details of a package that is associated with a domain. * **PackageID** *(string) --* **[REQUIRED]** Internal ID of the package that you want to associate with a domain. * **PrerequisitePackageIDList** *(list) --* List of package IDs that must be linked to the domain before or simultaneously with the package association. * *(string) --* * **AssociationConfiguration** *(dict) --* The configuration parameters for associating the package with a domain. * **KeyStoreAccessOption** *(dict) --* The configuration parameters to enable accessing the key store required by the package. * **KeyAccessRoleArn** *(string) --* Role ARN to access the KeyStore Key * **KeyStoreAccessEnabled** *(boolean) --* **[REQUIRED]** This indicates whether Key Store access is enabled * **DomainName** (*string*) -- **[REQUIRED]** The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region. Return type: dict Returns: **Response Syntax** { 'DomainPackageDetailsList': [ { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', 'LastUpdated': datetime(2015, 1, 1), 'DomainName': 'string', 'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED', 'PackageVersion': 'string', 'PrerequisitePackageIDList': [ 'string', ], 'ReferencePath': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'AssociationConfiguration': { 'KeyStoreAccessOption': { 'KeyAccessRoleArn': 'string', 'KeyStoreAccessEnabled': True|False } } }, ] } **Response Structure** * *(dict) --* * **DomainPackageDetailsList** *(list) --* List of information about packages that are associated with a domain. * *(dict) --* Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service. * **PackageID** *(string) --* Internal ID of the package. * **PackageName** *(string) --* User-specified name of the package. * **PackageType** *(string) --* The type of package. * **LastUpdated** *(datetime) --* Timestamp of the most recent update to the package association status. * **DomainName** *(string) --* Name of the domain that the package is associated with. * **DomainPackageStatus** *(string) --* State of the association. * **PackageVersion** *(string) --* The current version of the package. * **PrerequisitePackageIDList** *(list) --* A list of package IDs that must be associated with the domain before or with the package can be associated. * *(string) --* * **ReferencePath** *(string) --* The relative path of the package on the OpenSearch Service cluster nodes. This is "synonym_path" when the package is for synonym files. * **ErrorDetails** *(dict) --* Additional information if the package is in an error state. Null otherwise. * **ErrorType** *(string) --* The type of error that occurred. * **ErrorMessage** *(string) --* A message describing the error. * **AssociationConfiguration** *(dict) --* The configuration for associating a package with an Amazon OpenSearch Service domain. * **KeyStoreAccessOption** *(dict) --* The configuration parameters to enable accessing the key store required by the package. * **KeyAccessRoleArn** *(string) --* Role ARN to access the KeyStore Key * **KeyStoreAccessEnabled** *(boolean) --* This indicates whether Key Store access is enabled **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.ConflictException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / describe_reserved_instances describe_reserved_instances *************************** OpenSearchService.Client.describe_reserved_instances(**kwargs) Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.describe_reserved_instances( ReservedInstanceId='string', MaxResults=123, NextToken='string' ) Parameters: * **ReservedInstanceId** (*string*) -- The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID. * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "DescribeReservedInstances" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "DescribeReservedInstances" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'ReservedInstances': [ { 'ReservationName': 'string', 'ReservedInstanceId': 'string', 'BillingSubscriptionId': 123, 'ReservedInstanceOfferingId': 'string', 'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search', 'StartTime': datetime(2015, 1, 1), 'Duration': 123, 'FixedPrice': 123.0, 'UsagePrice': 123.0, 'CurrencyCode': 'string', 'InstanceCount': 123, 'State': 'string', 'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT', 'RecurringCharges': [ { 'RecurringChargeAmount': 123.0, 'RecurringChargeFrequency': 'string' }, ] }, ] } **Response Structure** * *(dict) --* Container for results from "DescribeReservedInstances" * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. * **ReservedInstances** *(list) --* List of Reserved Instances in the current Region. * *(dict) --* Details of an OpenSearch Reserved Instance. * **ReservationName** *(string) --* The customer-specified identifier to track this reservation. * **ReservedInstanceId** *(string) --* The unique identifier for the reservation. * **BillingSubscriptionId** *(integer) --* The unique identifier of the billing subscription. * **ReservedInstanceOfferingId** *(string) --* The unique identifier of the Reserved Instance offering. * **InstanceType** *(string) --* The OpenSearch instance type offered by theReserved Instance offering. * **StartTime** *(datetime) --* The date and time when the reservation was purchased. * **Duration** *(integer) --* The duration, in seconds, for which the OpenSearch instance is reserved. * **FixedPrice** *(float) --* The upfront fixed charge you will paid to purchase the specific Reserved Instance offering. * **UsagePrice** *(float) --* The hourly rate at which you're charged for the domain using this Reserved Instance. * **CurrencyCode** *(string) --* The currency code for the offering. * **InstanceCount** *(integer) --* The number of OpenSearch instances that have been reserved. * **State** *(string) --* The state of the Reserved Instance. * **PaymentOption** *(string) --* The payment option as defined in the Reserved Instance offering. * **RecurringCharges** *(list) --* The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering. * *(dict) --* Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering. * **RecurringChargeAmount** *(float) --* The monetary amount of the recurring charge. * **RecurringChargeFrequency** *(string) --* The frequency of the recurring charge. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / can_paginate can_paginate ************ OpenSearchService.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. OpenSearchService / Client / list_tags list_tags ********* OpenSearchService.Client.list_tags(**kwargs) Returns all resource tags for an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources. See also: AWS API Documentation **Request Syntax** response = client.list_tags( ARN='string' ) Parameters: **ARN** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) for the domain, data source, or application to view tags for. Return type: dict Returns: **Response Syntax** { 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* The results of a "ListTags" operation. * **TagList** *(list) --* List of resource tags associated with the specified domain, data source, or application. * *(dict) --* A tag (key-value pair) for an Amazon OpenSearch Service resource. * **Key** *(string) --* The tag key. Tag keys must be unique for the domain to which they are attached. * **Value** *(string) --* The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.InternalException" OpenSearchService / Client / describe_domain_change_progress describe_domain_change_progress ******************************* OpenSearchService.Client.describe_domain_change_progress(**kwargs) Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.describe_domain_change_progress( DomainName='string', ChangeId='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain to get progress information for. * **ChangeId** (*string*) -- The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change. Return type: dict Returns: **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) }, ], 'LastUpdatedTime': datetime(2015, 1, 1), 'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled', 'InitiatedBy': 'CUSTOMER'|'SERVICE' } } **Response Structure** * *(dict) --* The result of a "DescribeDomainChangeProgress" request. Contains progress information for the requested domain change. * **ChangeProgressStatus** *(dict) --* Container for information about the stages of a configuration change happening on a domain. * **ChangeId** *(string) --* The unique change identifier associated with a specific domain configuration change. * **StartTime** *(datetime) --* The time at which the configuration change is made on the domain. * **Status** *(string) --* The overall status of the domain configuration change. * **PendingProperties** *(list) --* The list of properties in the domain configuration change that are still pending. * *(string) --* * **CompletedProperties** *(list) --* The list of properties in the domain configuration change that have 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) --* Progress details for each stage of a domain update. * **Name** *(string) --* The name of the stage. * **Status** *(string) --* The status of the stage. * **Description** *(string) --* The description of the stage. * **LastUpdated** *(datetime) --* The most recent updated timestamp of the stage. * **LastUpdatedTime** *(datetime) --* The last time that the status of the configuration change was updated. * **ConfigChangeStatus** *(string) --* The current status of the configuration change. * **InitiatedBy** *(string) --* The IAM principal who initiated the configuration change. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / create_package create_package ************** OpenSearchService.Client.create_package(**kwargs) Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.create_package( PackageName='string', PackageType='TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', PackageDescription='string', PackageSource={ 'S3BucketName': 'string', 'S3Key': 'string' }, PackageConfiguration={ 'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'LicenseFilepath': 'string', 'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'RequiresRestartForConfigurationUpdate': True|False }, EngineVersion='string', PackageVendingOptions={ 'VendingEnabled': True|False }, PackageEncryptionOptions={ 'KmsKeyIdentifier': 'string', 'EncryptionEnabled': True|False } ) Parameters: * **PackageName** (*string*) -- **[REQUIRED]** Unique name for the package. * **PackageType** (*string*) -- **[REQUIRED]** The type of package. * **PackageDescription** (*string*) -- Description of the package. * **PackageSource** (*dict*) -- **[REQUIRED]** The Amazon S3 location from which to import the package. * **S3BucketName** *(string) --* The name of the Amazon S3 bucket containing the package. * **S3Key** *(string) --* Key (file name) of the package. * **PackageConfiguration** (*dict*) -- The configuration parameters for the package being created. * **LicenseRequirement** *(string) --* **[REQUIRED]** The license requirements for the package. * **LicenseFilepath** *(string) --* The relative file path for the license associated with the package. * **ConfigurationRequirement** *(string) --* **[REQUIRED]** The configuration requirements for the package. * **RequiresRestartForConfigurationUpdate** *(boolean) --* This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for. * **EngineVersion** (*string*) -- The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type "ZIP- PLUGIN" * **PackageVendingOptions** (*dict*) -- The vending options for the package being created. They determine if the package can be vended to other users. * **VendingEnabled** *(boolean) --* **[REQUIRED]** Indicates whether the package vending feature is enabled, allowing the package to be used by other users. * **PackageEncryptionOptions** (*dict*) -- The encryption parameters for the package being created. * **KmsKeyIdentifier** *(string) --* KMS key ID for encrypting the package. * **EncryptionEnabled** *(boolean) --* **[REQUIRED]** Whether encryption is enabled for the package. Return type: dict Returns: **Response Syntax** { 'PackageDetails': { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', 'PackageDescription': 'string', 'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'AvailablePackageVersion': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'EngineVersion': 'string', 'AvailablePluginProperties': { 'Name': 'string', 'Description': 'string', 'Version': 'string', 'ClassName': 'string', 'UncompressedSizeInBytes': 123 }, 'AvailablePackageConfiguration': { 'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'LicenseFilepath': 'string', 'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'RequiresRestartForConfigurationUpdate': True|False }, 'AllowListedUserList': [ 'string', ], 'PackageOwner': 'string', 'PackageVendingOptions': { 'VendingEnabled': True|False }, 'PackageEncryptionOptions': { 'KmsKeyIdentifier': 'string', 'EncryptionEnabled': True|False } } } **Response Structure** * *(dict) --* Container for the response returned by the "CreatePackage" operation. * **PackageDetails** *(dict) --* Basic information about an OpenSearch Service package. * **PackageID** *(string) --* The unique identifier of the package. * **PackageName** *(string) --* The user-specified name of the package. * **PackageType** *(string) --* The type of package. * **PackageDescription** *(string) --* User-specified description of the package. * **PackageStatus** *(string) --* The current status of the package. The available options are "AVAILABLE", "COPYING", "COPY_FAILED", "VALIDATNG", "VALIDATION_FAILED", "DELETING", and "DELETE_FAILED". * **CreatedAt** *(datetime) --* The timestamp when the package was created. * **LastUpdatedAt** *(datetime) --* Date and time when the package was last updated. * **AvailablePackageVersion** *(string) --* The package version. * **ErrorDetails** *(dict) --* Additional information if the package is in an error state. Null otherwise. * **ErrorType** *(string) --* The type of error that occurred. * **ErrorMessage** *(string) --* A message describing the error. * **EngineVersion** *(string) --* Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch. * **AvailablePluginProperties** *(dict) --* If the package is a "ZIP-PLUGIN" package, additional information about plugin properties. * **Name** *(string) --* The name of the plugin. * **Description** *(string) --* The description of the plugin. * **Version** *(string) --* The version of the plugin. * **ClassName** *(string) --* The name of the class to load. * **UncompressedSizeInBytes** *(integer) --* The uncompressed size of the plugin. * **AvailablePackageConfiguration** *(dict) --* This represents the available configuration parameters for the package. * **LicenseRequirement** *(string) --* The license requirements for the package. * **LicenseFilepath** *(string) --* The relative file path for the license associated with the package. * **ConfigurationRequirement** *(string) --* The configuration requirements for the package. * **RequiresRestartForConfigurationUpdate** *(boolean) --* This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for. * **AllowListedUserList** *(list) --* A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package. * *(string) --* * **PackageOwner** *(string) --* The owner of the package who is allowed to create and update a package and add users to the package scope. * **PackageVendingOptions** *(dict) --* Package Vending Options for a package. * **VendingEnabled** *(boolean) --* Indicates whether the package vending feature is enabled, allowing the package to be used by other users. * **PackageEncryptionOptions** *(dict) --* Encryption options for a package. * **KmsKeyIdentifier** *(string) --* KMS key ID for encrypting the package. * **EncryptionEnabled** *(boolean) --* Whether encryption is enabled for the package. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.InvalidTypeException" * "OpenSearchService.Client.exceptions.ResourceAlreadyExistsExcept ion" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / get_direct_query_data_source get_direct_query_data_source **************************** OpenSearchService.Client.get_direct_query_data_source(**kwargs) Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.get_direct_query_data_source( DataSourceName='string' ) Parameters: **DataSourceName** (*string*) -- **[REQUIRED]** A unique, user-defined label that identifies the data source within your OpenSearch Service environment. Return type: dict Returns: **Response Syntax** { 'DataSourceName': 'string', 'DataSourceType': { 'CloudWatchLog': { 'RoleArn': 'string' }, 'SecurityLake': { 'RoleArn': 'string' } }, 'Description': 'string', 'OpenSearchArns': [ 'string', ], 'DataSourceArn': 'string' } **Response Structure** * *(dict) --* * **DataSourceName** *(string) --* A unique, user-defined label to identify the data source within your OpenSearch Service environment. * **DataSourceType** *(dict) --* The supported Amazon Web Services service that is used as the source for direct queries in OpenSearch Service. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "CloudWatchLog", "SecurityLake". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **CloudWatchLog** *(dict) --* Specifies CloudWatch Logs as a type of data source for direct queries. * **RoleArn** *(string) --* The unique identifier of the IAM role that grants OpenSearch Service permission to access the specified data source. * **SecurityLake** *(dict) --* Specifies Security Lake as a type of data source for direct queries. * **RoleArn** *(string) --* The unique identifier of the IAM role that grants OpenSearch Service permission to access the specified data source. * **Description** *(string) --* A description that provides additional context and details about the data source. * **OpenSearchArns** *(list) --* A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. * *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **DataSourceArn** *(string) --* The unique, system-generated identifier that represents the data source. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / describe_vpc_endpoints describe_vpc_endpoints ********************** OpenSearchService.Client.describe_vpc_endpoints(**kwargs) Describes one or more Amazon OpenSearch Service-managed VPC endpoints. See also: AWS API Documentation **Request Syntax** response = client.describe_vpc_endpoints( VpcEndpointIds=[ 'string', ] ) Parameters: **VpcEndpointIds** (*list*) -- **[REQUIRED]** The unique identifiers of the endpoints to get information about. * *(string) --* Return type: dict Returns: **Response Syntax** { 'VpcEndpoints': [ { 'VpcEndpointId': 'string', 'VpcEndpointOwner': 'string', 'DomainArn': 'string', 'VpcOptions': { 'VPCId': 'string', 'SubnetIds': [ 'string', ], 'AvailabilityZones': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, 'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED', 'Endpoint': 'string' }, ], 'VpcEndpointErrors': [ { 'VpcEndpointId': 'string', 'ErrorCode': 'ENDPOINT_NOT_FOUND'|'SERVER_ERROR', 'ErrorMessage': 'string' }, ] } **Response Structure** * *(dict) --* * **VpcEndpoints** *(list) --* Information about each requested VPC endpoint. * *(dict) --* The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcEndpointOwner** *(string) --* The creator of the endpoint. * **DomainArn** *(string) --* The Amazon Resource Name (ARN) of the domain associated with the endpoint. * **VpcOptions** *(dict) --* Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. * **VPCId** *(string) --* The ID for your VPC. Amazon VPC generates this value when you create a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. * *(string) --* * **AvailabilityZones** *(list) --* The list of Availability Zones associated with the VPC subnets. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. * *(string) --* * **Status** *(string) --* The current status of the endpoint. * **Endpoint** *(string) --* The connection endpoint ID for connecting to the domain. * **VpcEndpointErrors** *(list) --* Any errors associated with the request. * *(dict) --* Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **ErrorCode** *(string) --* The code associated with the error. * **ErrorMessage** *(string) --* A message describing the error. **Exceptions** * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.BaseException" OpenSearchService / Client / delete_data_source delete_data_source ****************** OpenSearchService.Client.delete_data_source(**kwargs) Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3. See also: AWS API Documentation **Request Syntax** response = client.delete_data_source( DomainName='string', Name='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. * **Name** (*string*) -- **[REQUIRED]** The name of the data source to delete. Return type: dict Returns: **Response Syntax** { 'Message': 'string' } **Response Structure** * *(dict) --* The result of a "GetDataSource" operation. * **Message** *(string) --* A message associated with deletion of the data source. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.DependencyFailureException" OpenSearchService / Client / delete_package delete_package ************** OpenSearchService.Client.delete_package(**kwargs) Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.delete_package( PackageID='string' ) Parameters: **PackageID** (*string*) -- **[REQUIRED]** The internal ID of the package you want to delete. Use "DescribePackages" to find this value. Return type: dict Returns: **Response Syntax** { 'PackageDetails': { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', 'PackageDescription': 'string', 'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'AvailablePackageVersion': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'EngineVersion': 'string', 'AvailablePluginProperties': { 'Name': 'string', 'Description': 'string', 'Version': 'string', 'ClassName': 'string', 'UncompressedSizeInBytes': 123 }, 'AvailablePackageConfiguration': { 'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'LicenseFilepath': 'string', 'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'RequiresRestartForConfigurationUpdate': True|False }, 'AllowListedUserList': [ 'string', ], 'PackageOwner': 'string', 'PackageVendingOptions': { 'VendingEnabled': True|False }, 'PackageEncryptionOptions': { 'KmsKeyIdentifier': 'string', 'EncryptionEnabled': True|False } } } **Response Structure** * *(dict) --* Container for the response parameters to the "DeletePackage" operation. * **PackageDetails** *(dict) --* Information about the deleted package. * **PackageID** *(string) --* The unique identifier of the package. * **PackageName** *(string) --* The user-specified name of the package. * **PackageType** *(string) --* The type of package. * **PackageDescription** *(string) --* User-specified description of the package. * **PackageStatus** *(string) --* The current status of the package. The available options are "AVAILABLE", "COPYING", "COPY_FAILED", "VALIDATNG", "VALIDATION_FAILED", "DELETING", and "DELETE_FAILED". * **CreatedAt** *(datetime) --* The timestamp when the package was created. * **LastUpdatedAt** *(datetime) --* Date and time when the package was last updated. * **AvailablePackageVersion** *(string) --* The package version. * **ErrorDetails** *(dict) --* Additional information if the package is in an error state. Null otherwise. * **ErrorType** *(string) --* The type of error that occurred. * **ErrorMessage** *(string) --* A message describing the error. * **EngineVersion** *(string) --* Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch. * **AvailablePluginProperties** *(dict) --* If the package is a "ZIP-PLUGIN" package, additional information about plugin properties. * **Name** *(string) --* The name of the plugin. * **Description** *(string) --* The description of the plugin. * **Version** *(string) --* The version of the plugin. * **ClassName** *(string) --* The name of the class to load. * **UncompressedSizeInBytes** *(integer) --* The uncompressed size of the plugin. * **AvailablePackageConfiguration** *(dict) --* This represents the available configuration parameters for the package. * **LicenseRequirement** *(string) --* The license requirements for the package. * **LicenseFilepath** *(string) --* The relative file path for the license associated with the package. * **ConfigurationRequirement** *(string) --* The configuration requirements for the package. * **RequiresRestartForConfigurationUpdate** *(boolean) --* This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for. * **AllowListedUserList** *(list) --* A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package. * *(string) --* * **PackageOwner** *(string) --* The owner of the package who is allowed to create and update a package and add users to the package scope. * **PackageVendingOptions** *(dict) --* Package Vending Options for a package. * **VendingEnabled** *(boolean) --* Indicates whether the package vending feature is enabled, allowing the package to be used by other users. * **PackageEncryptionOptions** *(dict) --* Encryption options for a package. * **KmsKeyIdentifier** *(string) --* KMS key ID for encrypting the package. * **EncryptionEnabled** *(boolean) --* Whether encryption is enabled for the package. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.ConflictException" OpenSearchService / Client / delete_vpc_endpoint delete_vpc_endpoint ******************* OpenSearchService.Client.delete_vpc_endpoint(**kwargs) Deletes an Amazon OpenSearch Service-managed interface VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.delete_vpc_endpoint( VpcEndpointId='string' ) Parameters: **VpcEndpointId** (*string*) -- **[REQUIRED]** The unique identifier of the endpoint. Return type: dict Returns: **Response Syntax** { 'VpcEndpointSummary': { 'VpcEndpointId': 'string', 'VpcEndpointOwner': 'string', 'DomainArn': 'string', 'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED' } } **Response Structure** * *(dict) --* * **VpcEndpointSummary** *(dict) --* Information about the deleted endpoint, including its current status ( "DELETING" or "DELETE_FAILED"). * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcEndpointOwner** *(string) --* The creator of the endpoint. * **DomainArn** *(string) --* The Amazon Resource Name (ARN) of the domain associated with the endpoint. * **Status** *(string) --* The current status of the endpoint. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.BaseException" OpenSearchService / Client / cancel_domain_config_change cancel_domain_config_change *************************** OpenSearchService.Client.cancel_domain_config_change(**kwargs) Cancels a pending configuration change on an Amazon OpenSearch Service domain. See also: AWS API Documentation **Request Syntax** response = client.cancel_domain_config_change( DomainName='string', DryRun=True|False ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region. * **DryRun** (*boolean*) -- When set to "True", returns the list of change IDs and properties that will be cancelled without actually cancelling the change. Return type: dict Returns: **Response Syntax** { 'CancelledChangeIds': [ 'string', ], 'CancelledChangeProperties': [ { 'PropertyName': 'string', 'CancelledValue': 'string', 'ActiveValue': 'string' }, ], 'DryRun': True|False } **Response Structure** * *(dict) --* * **CancelledChangeIds** *(list) --* The unique identifiers of the changes that were cancelled. * *(string) --* * **CancelledChangeProperties** *(list) --* The domain change properties that were cancelled. * *(dict) --* A property change that was cancelled for an Amazon OpenSearch Service domain. * **PropertyName** *(string) --* The name of the property whose change was cancelled. * **CancelledValue** *(string) --* The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled. * **ActiveValue** *(string) --* The current value of the property, after the change was cancelled. * **DryRun** *(boolean) --* Whether or not the request was a dry run. If "True", the changes were not actually cancelled. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / update_package update_package ************** OpenSearchService.Client.update_package(**kwargs) Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.update_package( PackageID='string', PackageSource={ 'S3BucketName': 'string', 'S3Key': 'string' }, PackageDescription='string', CommitMessage='string', PackageConfiguration={ 'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'LicenseFilepath': 'string', 'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'RequiresRestartForConfigurationUpdate': True|False }, PackageEncryptionOptions={ 'KmsKeyIdentifier': 'string', 'EncryptionEnabled': True|False } ) Parameters: * **PackageID** (*string*) -- **[REQUIRED]** The unique identifier for the package. * **PackageSource** (*dict*) -- **[REQUIRED]** Amazon S3 bucket and key for the package. * **S3BucketName** *(string) --* The name of the Amazon S3 bucket containing the package. * **S3Key** *(string) --* Key (file name) of the package. * **PackageDescription** (*string*) -- A new description of the package. * **CommitMessage** (*string*) -- Commit message for the updated file, which is shown as part of "GetPackageVersionHistoryResponse". * **PackageConfiguration** (*dict*) -- The updated configuration details for a package. * **LicenseRequirement** *(string) --* **[REQUIRED]** The license requirements for the package. * **LicenseFilepath** *(string) --* The relative file path for the license associated with the package. * **ConfigurationRequirement** *(string) --* **[REQUIRED]** The configuration requirements for the package. * **RequiresRestartForConfigurationUpdate** *(boolean) --* This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for. * **PackageEncryptionOptions** (*dict*) -- Encryption options for a package. * **KmsKeyIdentifier** *(string) --* KMS key ID for encrypting the package. * **EncryptionEnabled** *(boolean) --* **[REQUIRED]** Whether encryption is enabled for the package. Return type: dict Returns: **Response Syntax** { 'PackageDetails': { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', 'PackageDescription': 'string', 'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'AvailablePackageVersion': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'EngineVersion': 'string', 'AvailablePluginProperties': { 'Name': 'string', 'Description': 'string', 'Version': 'string', 'ClassName': 'string', 'UncompressedSizeInBytes': 123 }, 'AvailablePackageConfiguration': { 'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'LicenseFilepath': 'string', 'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'RequiresRestartForConfigurationUpdate': True|False }, 'AllowListedUserList': [ 'string', ], 'PackageOwner': 'string', 'PackageVendingOptions': { 'VendingEnabled': True|False }, 'PackageEncryptionOptions': { 'KmsKeyIdentifier': 'string', 'EncryptionEnabled': True|False } } } **Response Structure** * *(dict) --* Container for the response returned by the "UpdatePackage" operation. * **PackageDetails** *(dict) --* Information about a package. * **PackageID** *(string) --* The unique identifier of the package. * **PackageName** *(string) --* The user-specified name of the package. * **PackageType** *(string) --* The type of package. * **PackageDescription** *(string) --* User-specified description of the package. * **PackageStatus** *(string) --* The current status of the package. The available options are "AVAILABLE", "COPYING", "COPY_FAILED", "VALIDATNG", "VALIDATION_FAILED", "DELETING", and "DELETE_FAILED". * **CreatedAt** *(datetime) --* The timestamp when the package was created. * **LastUpdatedAt** *(datetime) --* Date and time when the package was last updated. * **AvailablePackageVersion** *(string) --* The package version. * **ErrorDetails** *(dict) --* Additional information if the package is in an error state. Null otherwise. * **ErrorType** *(string) --* The type of error that occurred. * **ErrorMessage** *(string) --* A message describing the error. * **EngineVersion** *(string) --* Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch. * **AvailablePluginProperties** *(dict) --* If the package is a "ZIP-PLUGIN" package, additional information about plugin properties. * **Name** *(string) --* The name of the plugin. * **Description** *(string) --* The description of the plugin. * **Version** *(string) --* The version of the plugin. * **ClassName** *(string) --* The name of the class to load. * **UncompressedSizeInBytes** *(integer) --* The uncompressed size of the plugin. * **AvailablePackageConfiguration** *(dict) --* This represents the available configuration parameters for the package. * **LicenseRequirement** *(string) --* The license requirements for the package. * **LicenseFilepath** *(string) --* The relative file path for the license associated with the package. * **ConfigurationRequirement** *(string) --* The configuration requirements for the package. * **RequiresRestartForConfigurationUpdate** *(boolean) --* This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for. * **AllowListedUserList** *(list) --* A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package. * *(string) --* * **PackageOwner** *(string) --* The owner of the package who is allowed to create and update a package and add users to the package scope. * **PackageVendingOptions** *(dict) --* Package Vending Options for a package. * **VendingEnabled** *(boolean) --* Indicates whether the package vending feature is enabled, allowing the package to be used by other users. * **PackageEncryptionOptions** *(dict) --* Encryption options for a package. * **KmsKeyIdentifier** *(string) --* KMS key ID for encrypting the package. * **EncryptionEnabled** *(boolean) --* Whether encryption is enabled for the package. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / delete_direct_query_data_source delete_direct_query_data_source ******************************* OpenSearchService.Client.delete_direct_query_data_source(**kwargs) Deletes a previously configured direct query data source from Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.delete_direct_query_data_source( DataSourceName='string' ) Parameters: **DataSourceName** (*string*) -- **[REQUIRED]** A unique, user-defined label to identify the data source within your OpenSearch Service environment. Returns: None **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / update_data_source update_data_source ****************** OpenSearchService.Client.update_data_source(**kwargs) Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3. See also: AWS API Documentation **Request Syntax** response = client.update_data_source( DomainName='string', Name='string', DataSourceType={ 'S3GlueDataCatalog': { 'RoleArn': 'string' } }, Description='string', Status='ACTIVE'|'DISABLED' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. * **Name** (*string*) -- **[REQUIRED]** The name of the data source to modify. * **DataSourceType** (*dict*) -- **[REQUIRED]** The type of data source. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "S3GlueDataCatalog". * **S3GlueDataCatalog** *(dict) --* An Amazon S3 data source. * **RoleArn** *(string) --* >The Amazon Resource Name (ARN) for the S3 Glue Data Catalog. * **Description** (*string*) -- A new description of the data source. * **Status** (*string*) -- The status of the data source update. Return type: dict Returns: **Response Syntax** { 'Message': 'string' } **Response Structure** * *(dict) --* The result of an "UpdateDataSource" operation. * **Message** *(string) --* A message associated with the updated data source. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.DependencyFailureException" OpenSearchService / Client / update_direct_query_data_source update_direct_query_data_source ******************************* OpenSearchService.Client.update_direct_query_data_source(**kwargs) Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.update_direct_query_data_source( DataSourceName='string', DataSourceType={ 'CloudWatchLog': { 'RoleArn': 'string' }, 'SecurityLake': { 'RoleArn': 'string' } }, Description='string', OpenSearchArns=[ 'string', ] ) Parameters: * **DataSourceName** (*string*) -- **[REQUIRED]** A unique, user-defined label to identify the data source within your OpenSearch Service environment. * **DataSourceType** (*dict*) -- **[REQUIRED]** The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "CloudWatchLog", "SecurityLake". * **CloudWatchLog** *(dict) --* Specifies CloudWatch Logs as a type of data source for direct queries. * **RoleArn** *(string) --* **[REQUIRED]** The unique identifier of the IAM role that grants OpenSearch Service permission to access the specified data source. * **SecurityLake** *(dict) --* Specifies Security Lake as a type of data source for direct queries. * **RoleArn** *(string) --* **[REQUIRED]** The unique identifier of the IAM role that grants OpenSearch Service permission to access the specified data source. * **Description** (*string*) -- An optional text field for providing additional context and details about the data source. * **OpenSearchArns** (*list*) -- **[REQUIRED]** A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. * *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. Return type: dict Returns: **Response Syntax** { 'DataSourceArn': 'string' } **Response Structure** * *(dict) --* * **DataSourceArn** *(string) --* The unique, system-generated identifier that represents the data source. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / get_domain_maintenance_status get_domain_maintenance_status ***************************** OpenSearchService.Client.get_domain_maintenance_status(**kwargs) The status of the maintenance action. See also: AWS API Documentation **Request Syntax** response = client.get_domain_maintenance_status( DomainName='string', MaintenanceId='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. * **MaintenanceId** (*string*) -- **[REQUIRED]** The request ID of the maintenance action. Return type: dict Returns: **Response Syntax** { 'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'TIMED_OUT', 'StatusMessage': 'string', 'NodeId': 'string', 'Action': 'REBOOT_NODE'|'RESTART_SEARCH_PROCESS'|'RESTART_DASHBOARD', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* The result of a "GetDomainMaintenanceStatus" request that information about the requested action. * **Status** *(string) --* The status of the maintenance action. * **StatusMessage** *(string) --* The status message of the maintenance action. * **NodeId** *(string) --* The node ID of the maintenance action. * **Action** *(string) --* The action name. * **CreatedAt** *(datetime) --* The time at which the action was created. * **UpdatedAt** *(datetime) --* The time at which the action was updated. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / delete_inbound_connection delete_inbound_connection ************************* OpenSearchService.Client.delete_inbound_connection(**kwargs) Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.delete_inbound_connection( ConnectionId='string' ) Parameters: **ConnectionId** (*string*) -- **[REQUIRED]** The ID of the inbound connection to permanently delete. Return type: dict Returns: **Response Syntax** { 'Connection': { 'LocalDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'RemoteDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'ConnectionId': 'string', 'ConnectionStatus': { 'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED', 'Message': 'string' }, 'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT' } } **Response Structure** * *(dict) --* The results of a "DeleteInboundConnection" operation. Contains details about the deleted inbound connection. * **Connection** *(dict) --* The deleted inbound connection. * **LocalDomainInfo** *(dict) --* Information about the source (local) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **RemoteDomainInfo** *(dict) --* Information about the destination (remote) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **ConnectionId** *(string) --* The unique identifier of the connection. * **ConnectionStatus** *(dict) --* The current status of the connection. * **StatusCode** *(string) --* The status code for the connection. Can be one of the following: * **PENDING_ACCEPTANCE** - Inbound connection is not yet accepted by the remote domain owner. * **APPROVED**: Inbound connection is pending acceptance by the remote domain owner. * **PROVISIONING**: Inbound connection is being provisioned. * **ACTIVE**: Inbound connection is active and ready to use. * **REJECTING**: Inbound connection rejection is in process. * **REJECTED**: Inbound connection is rejected. * **DELETING**: Inbound connection deletion is in progress. * **DELETED**: Inbound connection is deleted and can no longer be used. * **Message** *(string) --* Information about the connection. * **ConnectionMode** *(string) --* The connection mode. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / describe_instance_type_limits describe_instance_type_limits ***************************** OpenSearchService.Client.describe_instance_type_limits(**kwargs) Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type. See also: AWS API Documentation **Request Syntax** response = client.describe_instance_type_limits( DomainName='string', InstanceType='m3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search', EngineVersion='string' ) Parameters: * **DomainName** (*string*) -- The name of the domain. Only specify if you need the limits for an existing domain. * **InstanceType** (*string*) -- **[REQUIRED]** The OpenSearch Service instance type for which you need limit information. * **EngineVersion** (*string*) -- **[REQUIRED]** Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch. Return type: dict Returns: **Response Syntax** { 'LimitsByRole': { 'string': { 'StorageTypes': [ { 'StorageTypeName': 'string', 'StorageSubTypeName': 'string', 'StorageTypeLimits': [ { 'LimitName': 'string', 'LimitValues': [ 'string', ] }, ] }, ], 'InstanceLimits': { 'InstanceCountLimits': { 'MinimumInstanceCount': 123, 'MaximumInstanceCount': 123 } }, 'AdditionalLimits': [ { 'LimitName': 'string', 'LimitValues': [ 'string', ] }, ] } } } **Response Structure** * *(dict) --* Container for the parameters received from the "DescribeInstanceTypeLimits" operation. * **LimitsByRole** *(dict) --* Map that contains all applicable instance type limits. "data" refers to data nodes. "master" refers to dedicated master nodes. * *(string) --* * *(dict) --* Limits for a given instance type and for each of its roles. * **StorageTypes** *(list) --* Storage-related attributes that are available for a given instance type. * *(dict) --* A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type. * **StorageTypeName** *(string) --* The name of the storage type. * **StorageSubTypeName** *(string) --* The storage sub-type, such as "gp3" or "io1". * **StorageTypeLimits** *(list) --* Limits that are applicable for the given storage type. * *(dict) --* Limits that are applicable for the given Amazon OpenSearch Service storage type. * **LimitName** *(string) --* Name of storage limits that are applicable for the given storage type. If "StorageType" is "ebs", the following options are available: * **MinimumVolumeSize** - Minimum volume size that is available for the given storage type. Can be empty if not applicable. * **MaximumVolumeSize** - Maximum volume size that is available for the given storage type. Can be empty if not applicable. * **MaximumIops** - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable. * **MinimumIops** - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable. * **MaximumThroughput** - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable. * **MinimumThroughput** - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable. * **LimitValues** *(list) --* The limit values. * *(string) --* * **InstanceLimits** *(dict) --* The limits for a given instance type. * **InstanceCountLimits** *(dict) --* Limits on the number of instances that can be created for a given instance type. * **MinimumInstanceCount** *(integer) --* The maximum allowed number of instances. * **MaximumInstanceCount** *(integer) --* The minimum allowed number of instances. * **AdditionalLimits** *(list) --* List of additional limits that are specific to a given instance type for each of its instance roles. * *(dict) --* List of limits that are specific to a given instance type. * **LimitName** *(string) --* * "MaximumNumberOfDataNodesSupported" - This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support. * "MaximumNumberOfDataNodesWithoutMasterNode" - This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them. * **LimitValues** *(list) --* The values of the additional instance type limits. * *(string) --* **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.InvalidTypeException" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / get_compatible_versions get_compatible_versions *********************** OpenSearchService.Client.get_compatible_versions(**kwargs) Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to. See also: AWS API Documentation **Request Syntax** response = client.get_compatible_versions( DomainName='string' ) Parameters: **DomainName** (*string*) -- The name of an existing domain. Provide this parameter to limit the results to a single domain. Return type: dict Returns: **Response Syntax** { 'CompatibleVersions': [ { 'SourceVersion': 'string', 'TargetVersions': [ 'string', ] }, ] } **Response Structure** * *(dict) --* Container for the response returned by the "GetCompatibleVersions" operation. * **CompatibleVersions** *(list) --* A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to. * *(dict) --* A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to. * **SourceVersion** *(string) --* The current version that the OpenSearch Service domain is running. * **TargetVersions** *(list) --* The possible versions that you can upgrade the domain to. * *(string) --* **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.InternalException" OpenSearchService / Client / describe_domain_nodes describe_domain_nodes ********************* OpenSearchService.Client.describe_domain_nodes(**kwargs) Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states. See also: AWS API Documentation **Request Syntax** response = client.describe_domain_nodes( DomainName='string' ) Parameters: **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. Return type: dict Returns: **Response Syntax** { 'DomainNodesStatusList': [ { 'NodeId': 'string', 'NodeType': 'Data'|'Ultrawarm'|'Master', 'AvailabilityZone': 'string', 'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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', 'NodeStatus': 'Active'|'StandBy'|'NotAvailable', 'StorageType': 'string', 'StorageVolumeType': 'standard'|'gp2'|'io1'|'gp3', 'StorageSize': 'string' }, ] } **Response Structure** * *(dict) --* The result of a "DescribeDomainNodes" request. Contains information about the nodes on the requested domain. * **DomainNodesStatusList** *(list) --* Contains nodes information list "DomainNodesStatusList" with details about the all nodes on the requested domain. * *(dict) --* Container for information about nodes on the domain. * **NodeId** *(string) --* The ID of the node. * **NodeType** *(string) --* Indicates whether the nodes is a data, master, or UltraWarm node. * **AvailabilityZone** *(string) --* The Availability Zone of the node. * **InstanceType** *(string) --* The instance type information of the node. * **NodeStatus** *(string) --* Indicates if the node is active or in standby. * **StorageType** *(string) --* Indicates if the node has EBS or instance storage. * **StorageVolumeType** *(string) --* If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only applicable for data nodes. * **StorageSize** *(string) --* The storage size of the node, in GiB. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.DependencyFailureException" OpenSearchService / Client / create_domain create_domain ************* OpenSearchService.Client.create_domain(**kwargs) Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains. See also: AWS API Documentation **Request Syntax** response = client.create_domain( DomainName='string', EngineVersion='string', ClusterConfig={ 'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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 }, 'MultiAZWithStandbyEnabled': True|False, 'NodeOptions': [ { 'NodeType': 'coordinator', 'NodeConfig': { 'Enabled': True|False, 'Type': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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', 'Count': 123 } }, ] }, EBSOptions={ 'EBSEnabled': True|False, 'VolumeType': 'standard'|'gp2'|'io1'|'gp3', 'VolumeSize': 123, 'Iops': 123, 'Throughput': 123 }, AccessPolicies='string', IPAddressType='ipv4'|'dualstack', 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'|'Policy-Min-TLS-1-2-PFS-2023-10', '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 }, 'JWTOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string', 'PublicKey': 'string' }, 'IAMFederationOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string' }, 'AnonymousAuthEnabled': True|False }, IdentityCenterOptions={ 'EnabledAPIAccess': True|False, 'IdentityCenterInstanceARN': 'string', 'SubjectKey': 'UserName'|'UserId'|'Email', 'RolesKey': 'GroupName'|'GroupId' }, TagList=[ { 'Key': 'string', 'Value': 'string' }, ], AutoTuneOptions={ 'DesiredState': 'ENABLED'|'DISABLED', 'MaintenanceSchedules': [ { 'StartAt': datetime(2015, 1, 1), 'Duration': { 'Value': 123, 'Unit': 'HOURS' }, 'CronExpressionForRecurrence': 'string' }, ], 'UseOffPeakWindow': True|False }, OffPeakWindowOptions={ 'Enabled': True|False, 'OffPeakWindow': { 'WindowStartTime': { 'Hours': 123, 'Minutes': 123 } } }, SoftwareUpdateOptions={ 'AutoSoftwareUpdateEnabled': True|False }, AIMLOptions={ 'NaturalLanguageQueryGenerationOptions': { 'DesiredState': 'ENABLED'|'DISABLED' }, 'S3VectorsEngine': { 'Enabled': True|False } } ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region. * **EngineVersion** (*string*) -- String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains. * **ClusterConfig** (*dict*) -- Container for the cluster configuration of a domain. * **InstanceType** *(string) --* Instance type of data nodes in the cluster. * **InstanceCount** *(integer) --* Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. * **DedicatedMasterEnabled** *(boolean) --* Indicates whether dedicated master nodes are enabled for the cluster. "True" if the cluster will use a dedicated master node. "False" if the cluster will not. * **ZoneAwarenessEnabled** *(boolean) --* Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **ZoneAwarenessConfig** *(dict) --* Container for zone awareness configuration options. Only required if "ZoneAwarenessEnabled" is "true". * **AvailabilityZoneCount** *(integer) --* If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are "2" and "3". If your domain is provisioned within a VPC, this value be equal to number of subnets. * **DedicatedMasterType** *(string) --* OpenSearch Service instance type of the dedicated master nodes in the cluster. * **DedicatedMasterCount** *(integer) --* Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. * **WarmEnabled** *(boolean) --* Whether to enable warm storage for the cluster. * **WarmType** *(string) --* The instance type for the cluster's warm nodes. * **WarmCount** *(integer) --* The number of warm nodes in the cluster. * **ColdStorageOptions** *(dict) --* Container for cold storage configuration options. * **Enabled** *(boolean) --* **[REQUIRED]** Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. * **MultiAZWithStandbyEnabled** *(boolean) --* A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **NodeOptions** *(list) --* List of node options for the domain. * *(dict) --* Configuration settings for defining the node type within a cluster. * **NodeType** *(string) --* Defines the type of node, such as coordinating nodes. * **NodeConfig** *(dict) --* Configuration options for defining the setup of any node type. * **Enabled** *(boolean) --* A boolean value indicating whether a specific node type is active or inactive. * **Type** *(string) --* The instance type of a particular node within the cluster. * **Count** *(integer) --* The number of nodes of a specific type within the cluster. * **EBSOptions** (*dict*) -- Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain. * **EBSEnabled** *(boolean) --* Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. * **VolumeType** *(string) --* Specifies the type of EBS volumes attached to data nodes. * **VolumeSize** *(integer) --* Specifies the size (in GiB) of EBS volumes attached to data nodes. * **Iops** *(integer) --* Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the "gp3" and provisioned IOPS EBS volume types. * **Throughput** *(integer) --* Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the "gp3" volume type. * **AccessPolicies** (*string*) -- Identity and Access Management (IAM) policy document specifying the access policies for the new domain. * **IPAddressType** (*string*) -- Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later. * **SnapshotOptions** (*dict*) -- DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes. * **AutomatedSnapshotStartHour** *(integer) --* The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is "0" hours. * **VPCOptions** (*dict*) -- Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC. * *(string) --* * **CognitoOptions** (*dict*) -- Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards. * **Enabled** *(boolean) --* Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. * **UserPoolId** *(string) --* The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **IdentityPoolId** *(string) --* The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **RoleArn** *(string) --* The "AmazonOpenSearchServiceCognitoAccess" role that allows OpenSearch Service to configure your user pool and identity pool. * **EncryptionAtRestOptions** (*dict*) -- Key-value pairs to enable encryption at rest. * **Enabled** *(boolean) --* True to enable encryption at rest. * **KmsKeyId** *(string) --* The KMS key ID. Takes the form "1a2a3a4-1a2a-3a4a-5a6a- 1a2a3a4a5a6a". * **NodeToNodeEncryptionOptions** (*dict*) -- Enables node-to-node encryption. * **Enabled** *(boolean) --* True to enable node-to-node encryption. * **AdvancedOptions** (*dict*) -- Key-value pairs to specify advanced configuration options. The following key-value pairs are supported: * ""rest.action.multi.allow_explicit_index": "true" | "false"" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. * ""indices.fielddata.cache.size": "80"" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. * ""indices.query.bool.max_clause_count": "1024"" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a "TooManyClauses" error. * ""override_main_response_version": "true" | "false"" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain. For more information, see Advanced cluster parameters. * *(string) --* * *(string) --* * **LogPublishingOptions** (*dict*) -- Key-value pairs to configure log publishing. * *(string) --* The type of log file. Can be one of the following: * **INDEX_SLOW_LOGS** - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute. * **SEARCH_SLOW_LOGS** - Search slow logs contain search queries that took more time than the configured search query log threshold to execute. * **ES_APPLICATION_LOGS** - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting. * **AUDIT_LOGS** - Audit logs contain records of user requests for access to the domain. * *(dict) --* Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs. Note: After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. * **Enabled** *(boolean) --* Whether the log should be published. * **DomainEndpointOptions** (*dict*) -- Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. * **EnforceHTTPS** *(boolean) --* True to require that all traffic to the domain arrive over HTTPS. * **TLSSecurityPolicy** *(string) --* Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports TLS version 1.0 to TLS version 1.2 * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports only TLS version 1.2 * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites * **CustomEndpointEnabled** *(boolean) --* Whether to enable a custom endpoint for the domain. * **CustomEndpoint** *(string) --* The fully qualified URL for the custom endpoint. * **CustomEndpointCertificateArn** *(string) --* The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). * **AdvancedSecurityOptions** (*dict*) -- Options for fine-grained access control. * **Enabled** *(boolean) --* True to enable fine-grained access control. * **InternalUserDatabaseEnabled** *(boolean) --* True to enable the internal user database. * **MasterUserOptions** *(dict) --* Container for information about the master user. * **MasterUserARN** *(string) --* Amazon Resource Name (ARN) for the master user. Only specify if "InternalUserDatabaseEnabled" is "false". * **MasterUserName** *(string) --* User name for the master user. Only specify if "InternalUserDatabaseEnabled" is "true". * **MasterUserPassword** *(string) --* Password for the master user. Only specify if "InternalUserDatabaseEnabled" is "true". * **SAMLOptions** *(dict) --* Container for information about the SAML configuration for OpenSearch Dashboards. * **Enabled** *(boolean) --* True to enable SAML authentication for a domain. * **Idp** *(dict) --* The SAML Identity Provider's information. * **MetadataContent** *(string) --* **[REQUIRED]** The metadata of the SAML application, in XML format. * **EntityId** *(string) --* **[REQUIRED]** The unique entity ID of the application in the SAML identity provider. * **MasterUserName** *(string) --* The SAML master user name, which is stored in the domain's internal user database. * **MasterBackendRole** *(string) --* The backend role that the SAML master user is mapped to. * **SubjectKey** *(string) --* Element of the SAML assertion to use for the user name. Default is "NameID". * **RolesKey** *(string) --* Element of the SAML assertion to use for backend roles. Default is "roles". * **SessionTimeoutMinutes** *(integer) --* The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60. * **JWTOptions** *(dict) --* Container for information about the JWT configuration of the Amazon OpenSearch Service. * **Enabled** *(boolean) --* True to enable JWT authentication and authorization for a domain. * **SubjectKey** *(string) --* Element of the JWT assertion to use for the user name. * **RolesKey** *(string) --* Element of the JWT assertion to use for roles. * **PublicKey** *(string) --* Element of the JWT assertion used by the cluster to verify JWT signatures. * **IAMFederationOptions** *(dict) --* Container for information about the IAM federation configuration for an OpenSearch UI application. * **Enabled** *(boolean) --* True to enable IAM federation authentication for a domain. * **SubjectKey** *(string) --* Element of the IAM federation assertion to use for the user name. Default is "sub". * **RolesKey** *(string) --* Element of the IAM federation assertion to use for backend roles. Default is "roles". * **AnonymousAuthEnabled** *(boolean) --* True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. * **IdentityCenterOptions** (*dict*) -- Configuration options for enabling and managing IAM Identity Center integration within a domain. * **EnabledAPIAccess** *(boolean) --* Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service. * **IdentityCenterInstanceARN** *(string) --* The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication. * **SubjectKey** *(string) --* Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center. * **RolesKey** *(string) --* Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center. * **TagList** (*list*) -- List of tags to add to the domain upon creation. * *(dict) --* A tag (key-value pair) for an Amazon OpenSearch Service resource. * **Key** *(string) --* **[REQUIRED]** The tag key. Tag keys must be unique for the domain to which they are attached. * **Value** *(string) --* **[REQUIRED]** The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" * **AutoTuneOptions** (*dict*) -- Options for Auto-Tune. * **DesiredState** *(string) --* Whether Auto-Tune is enabled or disabled. * **MaintenanceSchedules** *(list) --* A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows. * *(dict) --* Note: This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows. The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service. * **StartAt** *(datetime) --* The Epoch timestamp at which the Auto-Tune maintenance schedule starts. * **Duration** *(dict) --* The duration of the maintenance schedule. For example, ""Duration": {"Value": 2, "Unit": "HOURS"}". * **Value** *(integer) --* Integer to specify the value of a maintenance schedule duration. * **Unit** *(string) --* The unit of measurement for the duration of a maintenance schedule. * **CronExpressionForRecurrence** *(string) --* A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes. * **UseOffPeakWindow** *(boolean) --* Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window. * **OffPeakWindowOptions** (*dict*) -- Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used. * **Enabled** *(boolean) --* Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off- peak window enabled by default. You can't disable the off- peak window after it's enabled for a domain. * **OffPeakWindow** *(dict) --* Off-peak window settings for the domain. * **WindowStartTime** *(dict) --* A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. * **Hours** *(integer) --* **[REQUIRED]** The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, "17" refers to 5:00 P.M. UTC. * **Minutes** *(integer) --* **[REQUIRED]** The start minute of the window, in UTC. * **SoftwareUpdateOptions** (*dict*) -- Software update options for the domain. * **AutoSoftwareUpdateEnabled** *(boolean) --* Whether automatic service software updates are enabled for the domain. * **AIMLOptions** (*dict*) -- Options for all machine learning features for the specified domain. * **NaturalLanguageQueryGenerationOptions** *(dict) --* Container for parameters required for natural language query generation on the specified domain. * **DesiredState** *(string) --* The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED. * **S3VectorsEngine** *(dict) --* Container for parameters required to enable S3 vectors engine features on the specified domain. * **Enabled** *(boolean) --* Enables S3 vectors engine features. Return type: dict Returns: **Response Syntax** { 'DomainStatus': { 'DomainId': 'string', 'DomainName': 'string', 'ARN': 'string', 'Created': True|False, 'Deleted': True|False, 'Endpoint': 'string', 'EndpointV2': 'string', 'Endpoints': { 'string': 'string' }, 'DomainEndpointV2HostedZoneId': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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 }, 'MultiAZWithStandbyEnabled': True|False, 'NodeOptions': [ { 'NodeType': 'coordinator', 'NodeConfig': { 'Enabled': True|False, 'Type': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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', 'Count': 123 } }, ] }, 'EBSOptions': { 'EBSEnabled': True|False, 'VolumeType': 'standard'|'gp2'|'io1'|'gp3', 'VolumeSize': 123, 'Iops': 123, 'Throughput': 123 }, 'AccessPolicies': 'string', 'IPAddressType': 'ipv4'|'dualstack', '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'|'Policy-Min-TLS-1-2-PFS-2023-10', '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 }, 'JWTOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string', 'PublicKey': 'string' }, 'IAMFederationOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string' }, 'AnonymousAuthDisableDate': datetime(2015, 1, 1), 'AnonymousAuthEnabled': True|False }, 'IdentityCenterOptions': { 'EnabledAPIAccess': True|False, 'IdentityCenterInstanceARN': 'string', 'SubjectKey': 'UserName'|'UserId'|'Email', 'RolesKey': 'GroupName'|'GroupId', 'IdentityCenterApplicationARN': 'string', 'IdentityStoreId': 'string' }, 'AutoTuneOptions': { 'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR', 'ErrorMessage': 'string', 'UseOffPeakWindow': True|False }, 'ChangeProgressDetails': { 'ChangeId': 'string', 'Message': 'string', 'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled', 'InitiatedBy': 'CUSTOMER'|'SERVICE', 'StartTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, 'OffPeakWindowOptions': { 'Enabled': True|False, 'OffPeakWindow': { 'WindowStartTime': { 'Hours': 123, 'Minutes': 123 } } }, 'SoftwareUpdateOptions': { 'AutoSoftwareUpdateEnabled': True|False }, 'DomainProcessingStatus': 'Creating'|'Active'|'Modifying'|'UpgradingEngineVersion'|'UpdatingServiceSoftware'|'Isolated'|'Deleting', 'ModifyingProperties': [ { 'Name': 'string', 'ActiveValue': 'string', 'PendingValue': 'string', 'ValueType': 'PLAIN_TEXT'|'STRINGIFIED_JSON' }, ], 'AIMLOptions': { 'NaturalLanguageQueryGenerationOptions': { 'DesiredState': 'ENABLED'|'DISABLED', 'CurrentState': 'NOT_ENABLED'|'ENABLE_COMPLETE'|'ENABLE_IN_PROGRESS'|'ENABLE_FAILED'|'DISABLE_COMPLETE'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED' }, 'S3VectorsEngine': { 'Enabled': True|False } } } } **Response Structure** * *(dict) --* The result of a "CreateDomain" operation. Contains the status of the newly created domain. * **DomainStatus** *(dict) --* The status of the newly created domain. * **DomainId** *(string) --* Unique identifier for the domain. * **DomainName** *(string) --* Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the *AWS Identity and Access Management User Guide*. * **Created** *(boolean) --* Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress. * **Deleted** *(boolean) --* Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned. * **Endpoint** *(string) --* Domain-specific endpoint used to submit index, search, and data upload requests to the domain. * **EndpointV2** *(string) --* If "IPAddressType" to set to "dualstack", a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. * **Endpoints** *(dict) --* The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example: * **IPv4 IP addresses** - "'vpc','vpc-endpoint- h2dsd34efgyghrtguk5gt6j2foh4.us- east-1.es.amazonaws.com'" * **Dual stack IP addresses** - "'vpcv2':'vpc-endpoint- h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'" * *(string) --* * *(string) --* The domain endpoint to which index and search requests are submitted. For example, "search-imdb-movies- oopcnjfn6ugo.eu-west-1.es.amazonaws.com" or "doc-imdb- movies-oopcnjfn6u.eu-west-1.es.amazonaws.com". * **DomainEndpointV2HostedZoneId** *(string) --* The dual stack hosted zone ID for the domain. * **Processing** *(boolean) --* The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active. * **UpgradeProcessing** *(boolean) --* The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active. * **EngineVersion** *(string) --* Version of OpenSearch or Elasticsearch that the domain is running, in the format "Elasticsearch_X.Y" or "OpenSearch_X.Y". * **ClusterConfig** *(dict) --* Container for the cluster configuration of the domain. * **InstanceType** *(string) --* Instance type of data nodes in the cluster. * **InstanceCount** *(integer) --* Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. * **DedicatedMasterEnabled** *(boolean) --* Indicates whether dedicated master nodes are enabled for the cluster. "True" if the cluster will use a dedicated master node. "False" if the cluster will not. * **ZoneAwarenessEnabled** *(boolean) --* Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi- AZ domain in Amazon OpenSearch Service. * **ZoneAwarenessConfig** *(dict) --* Container for zone awareness configuration options. Only required if "ZoneAwarenessEnabled" is "true". * **AvailabilityZoneCount** *(integer) --* If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are "2" and "3". If your domain is provisioned within a VPC, this value be equal to number of subnets. * **DedicatedMasterType** *(string) --* OpenSearch Service instance type of the dedicated master nodes in the cluster. * **DedicatedMasterCount** *(integer) --* Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. * **WarmEnabled** *(boolean) --* Whether to enable warm storage for the cluster. * **WarmType** *(string) --* The instance type for the cluster's warm nodes. * **WarmCount** *(integer) --* The number of warm nodes in the cluster. * **ColdStorageOptions** *(dict) --* Container for cold storage configuration options. * **Enabled** *(boolean) --* Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. * **MultiAZWithStandbyEnabled** *(boolean) --* A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **NodeOptions** *(list) --* List of node options for the domain. * *(dict) --* Configuration settings for defining the node type within a cluster. * **NodeType** *(string) --* Defines the type of node, such as coordinating nodes. * **NodeConfig** *(dict) --* Configuration options for defining the setup of any node type. * **Enabled** *(boolean) --* A boolean value indicating whether a specific node type is active or inactive. * **Type** *(string) --* The instance type of a particular node within the cluster. * **Count** *(integer) --* The number of nodes of a specific type within the cluster. * **EBSOptions** *(dict) --* Container for EBS-based storage settings for the domain. * **EBSEnabled** *(boolean) --* Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. * **VolumeType** *(string) --* Specifies the type of EBS volumes attached to data nodes. * **VolumeSize** *(integer) --* Specifies the size (in GiB) of EBS volumes attached to data nodes. * **Iops** *(integer) --* Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the "gp3" and provisioned IOPS EBS volume types. * **Throughput** *(integer) --* Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the "gp3" volume type. * **AccessPolicies** *(string) --* Identity and Access Management (IAM) policy document specifying the access policies for the domain. * **IPAddressType** *(string) --* The type of IP addresses supported by the endpoint for the domain. * **SnapshotOptions** *(dict) --* DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes. * **AutomatedSnapshotStartHour** *(integer) --* The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is "0" hours. * **VPCOptions** *(dict) --* The VPC configuration for the domain. * **VPCId** *(string) --* The ID for your VPC. Amazon VPC generates this value when you create a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. * *(string) --* * **AvailabilityZones** *(list) --* The list of Availability Zones associated with the VPC subnets. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. * *(string) --* * **CognitoOptions** *(dict) --* Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards. * **Enabled** *(boolean) --* Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. * **UserPoolId** *(string) --* The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **IdentityPoolId** *(string) --* The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **RoleArn** *(string) --* The "AmazonOpenSearchServiceCognitoAccess" role that allows OpenSearch Service to configure your user pool and identity pool. * **EncryptionAtRestOptions** *(dict) --* Encryption at rest settings for the domain. * **Enabled** *(boolean) --* True to enable encryption at rest. * **KmsKeyId** *(string) --* The KMS key ID. Takes the form "1a2a3a4-1a2a-3a4a-5a6a- 1a2a3a4a5a6a". * **NodeToNodeEncryptionOptions** *(dict) --* Whether node-to-node encryption is enabled or disabled. * **Enabled** *(boolean) --* True to enable node-to-node encryption. * **AdvancedOptions** *(dict) --* Key-value pairs that specify advanced configuration options. * *(string) --* * *(string) --* * **LogPublishingOptions** *(dict) --* Log publishing options for the domain. * *(string) --* The type of log file. Can be one of the following: * **INDEX_SLOW_LOGS** - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute. * **SEARCH_SLOW_LOGS** - Search slow logs contain search queries that took more time than the configured search query log threshold to execute. * **ES_APPLICATION_LOGS** - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting. * **AUDIT_LOGS** - Audit logs contain records of user requests for access to the domain. * *(dict) --* Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs. Note: After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. * **Enabled** *(boolean) --* Whether the log should be published. * **ServiceSoftwareOptions** *(dict) --* The current status of the domain's service software. * **CurrentVersion** *(string) --* The current service software version present on the domain. * **NewVersion** *(string) --* The new service software version, if one is available. * **UpdateAvailable** *(boolean) --* True if you're able to update your service software version. False if you can't update your service software version. * **Cancellable** *(boolean) --* True if you're able to cancel your service software version update. False if you can't cancel your service software update. * **UpdateStatus** *(string) --* The status of your service software update. * **Description** *(string) --* A description of the service software update status. * **AutomatedUpdateDate** *(datetime) --* The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. * **OptionalDeployment** *(boolean) --* True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date. * **DomainEndpointOptions** *(dict) --* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. * **EnforceHTTPS** *(boolean) --* True to require that all traffic to the domain arrive over HTTPS. * **TLSSecurityPolicy** *(string) --* Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports TLS version 1.0 to TLS version 1.2 * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports only TLS version 1.2 * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites * **CustomEndpointEnabled** *(boolean) --* Whether to enable a custom endpoint for the domain. * **CustomEndpoint** *(string) --* The fully qualified URL for the custom endpoint. * **CustomEndpointCertificateArn** *(string) --* The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). * **AdvancedSecurityOptions** *(dict) --* Settings for fine-grained access control. * **Enabled** *(boolean) --* True if fine-grained access control is enabled. * **InternalUserDatabaseEnabled** *(boolean) --* True if the internal user database is enabled. * **SAMLOptions** *(dict) --* Container for information about the SAML configuration for OpenSearch Dashboards. * **Enabled** *(boolean) --* True if SAML is enabled. * **Idp** *(dict) --* Describes the SAML identity provider's information. * **MetadataContent** *(string) --* The metadata of the SAML application, in XML format. * **EntityId** *(string) --* The unique entity ID of the application in the SAML identity provider. * **SubjectKey** *(string) --* The key used for matching the SAML subject attribute. * **RolesKey** *(string) --* The key used for matching the SAML roles attribute. * **SessionTimeoutMinutes** *(integer) --* The duration, in minutes, after which a user session becomes inactive. * **JWTOptions** *(dict) --* Container for information about the JWT configuration of the Amazon OpenSearch Service. * **Enabled** *(boolean) --* True if JWT use is enabled. * **SubjectKey** *(string) --* The key used for matching the JWT subject attribute. * **RolesKey** *(string) --* The key used for matching the JWT roles attribute. * **PublicKey** *(string) --* The key used to verify the signature of incoming JWT requests. * **IAMFederationOptions** *(dict) --* Container for information about the IAM federation configuration for an OpenSearch UI application. * **Enabled** *(boolean) --* True if IAM federation is enabled. * **SubjectKey** *(string) --* The key used for matching the IAM federation subject attribute. * **RolesKey** *(string) --* The key used for matching the IAM federation roles attribute. * **AnonymousAuthDisableDate** *(datetime) --* Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain. * **AnonymousAuthEnabled** *(boolean) --* True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. * **IdentityCenterOptions** *(dict) --* Configuration options for controlling IAM Identity Center integration within a domain. * **EnabledAPIAccess** *(boolean) --* Indicates whether IAM Identity Center is enabled for the application. * **IdentityCenterInstanceARN** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center instance. * **SubjectKey** *(string) --* Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center. * **RolesKey** *(string) --* Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center. * **IdentityCenterApplicationARN** *(string) --* The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service. * **IdentityStoreId** *(string) --* The identifier of the IAM Identity Store. * **AutoTuneOptions** *(dict) --* Auto-Tune settings for the domain. * **State** *(string) --* The current state of Auto-Tune on the domain. * **ErrorMessage** *(string) --* Any errors that occurred while enabling or disabling Auto-Tune. * **UseOffPeakWindow** *(boolean) --* Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule. * **ChangeProgressDetails** *(dict) --* Information about a configuration change happening on the domain. * **ChangeId** *(string) --* The ID of the configuration change. * **Message** *(string) --* A message corresponding to the status of the configuration change. * **ConfigChangeStatus** *(string) --* The current status of the configuration change. * **InitiatedBy** *(string) --* The IAM principal who initiated the configuration change. * **StartTime** *(datetime) --* The time that the configuration change was initiated, in Universal Coordinated Time (UTC). * **LastUpdatedTime** *(datetime) --* The last time that the configuration change was updated. * **OffPeakWindowOptions** *(dict) --* Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain. * **Enabled** *(boolean) --* Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain. * **OffPeakWindow** *(dict) --* Off-peak window settings for the domain. * **WindowStartTime** *(dict) --* A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. * **Hours** *(integer) --* The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, "17" refers to 5:00 P.M. UTC. * **Minutes** *(integer) --* The start minute of the window, in UTC. * **SoftwareUpdateOptions** *(dict) --* Service software update options for the domain. * **AutoSoftwareUpdateEnabled** *(boolean) --* Whether automatic service software updates are enabled for the domain. * **DomainProcessingStatus** *(string) --* The status of any changes that are currently in progress for the domain. * **ModifyingProperties** *(list) --* Information about the domain properties that are currently being modified. * *(dict) --* Information about the domain properties that are currently being modified. * **Name** *(string) --* The name of the property that is currently being modified. * **ActiveValue** *(string) --* The current value of the domain property that is being modified. * **PendingValue** *(string) --* The value that the property that is currently being modified will eventually have. * **ValueType** *(string) --* The type of value that is currently being modified. Properties can have two types: * "PLAIN_TEXT": Contain direct values such as "1", "True", or "c5.large.search". * "STRINGIFIED_JSON": Contain content in JSON format, such as {"Enabled":"True"}". * **AIMLOptions** *(dict) --* Container for parameters required to enable all machine learning features. * **NaturalLanguageQueryGenerationOptions** *(dict) --* Container for parameters required for natural language query generation on the specified domain. * **DesiredState** *(string) --* The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED. * **CurrentState** *(string) --* The current state of the natural language query generation feature, indicating completion, in progress, or failure. * **S3VectorsEngine** *(dict) --* Container for parameters representing the state of S3 vectors engine features on the specified domain. * **Enabled** *(boolean) --* Enables S3 vectors engine features. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.InvalidTypeException" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.ResourceAlreadyExistsExcept ion" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / delete_domain delete_domain ************* OpenSearchService.Client.delete_domain(**kwargs) Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it. See also: AWS API Documentation **Request Syntax** response = client.delete_domain( DomainName='string' ) Parameters: **DomainName** (*string*) -- **[REQUIRED]** The name of the domain you want to permanently delete. Return type: dict Returns: **Response Syntax** { 'DomainStatus': { 'DomainId': 'string', 'DomainName': 'string', 'ARN': 'string', 'Created': True|False, 'Deleted': True|False, 'Endpoint': 'string', 'EndpointV2': 'string', 'Endpoints': { 'string': 'string' }, 'DomainEndpointV2HostedZoneId': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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 }, 'MultiAZWithStandbyEnabled': True|False, 'NodeOptions': [ { 'NodeType': 'coordinator', 'NodeConfig': { 'Enabled': True|False, 'Type': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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', 'Count': 123 } }, ] }, 'EBSOptions': { 'EBSEnabled': True|False, 'VolumeType': 'standard'|'gp2'|'io1'|'gp3', 'VolumeSize': 123, 'Iops': 123, 'Throughput': 123 }, 'AccessPolicies': 'string', 'IPAddressType': 'ipv4'|'dualstack', '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'|'Policy-Min-TLS-1-2-PFS-2023-10', '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 }, 'JWTOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string', 'PublicKey': 'string' }, 'IAMFederationOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string' }, 'AnonymousAuthDisableDate': datetime(2015, 1, 1), 'AnonymousAuthEnabled': True|False }, 'IdentityCenterOptions': { 'EnabledAPIAccess': True|False, 'IdentityCenterInstanceARN': 'string', 'SubjectKey': 'UserName'|'UserId'|'Email', 'RolesKey': 'GroupName'|'GroupId', 'IdentityCenterApplicationARN': 'string', 'IdentityStoreId': 'string' }, 'AutoTuneOptions': { 'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR', 'ErrorMessage': 'string', 'UseOffPeakWindow': True|False }, 'ChangeProgressDetails': { 'ChangeId': 'string', 'Message': 'string', 'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled', 'InitiatedBy': 'CUSTOMER'|'SERVICE', 'StartTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, 'OffPeakWindowOptions': { 'Enabled': True|False, 'OffPeakWindow': { 'WindowStartTime': { 'Hours': 123, 'Minutes': 123 } } }, 'SoftwareUpdateOptions': { 'AutoSoftwareUpdateEnabled': True|False }, 'DomainProcessingStatus': 'Creating'|'Active'|'Modifying'|'UpgradingEngineVersion'|'UpdatingServiceSoftware'|'Isolated'|'Deleting', 'ModifyingProperties': [ { 'Name': 'string', 'ActiveValue': 'string', 'PendingValue': 'string', 'ValueType': 'PLAIN_TEXT'|'STRINGIFIED_JSON' }, ], 'AIMLOptions': { 'NaturalLanguageQueryGenerationOptions': { 'DesiredState': 'ENABLED'|'DISABLED', 'CurrentState': 'NOT_ENABLED'|'ENABLE_COMPLETE'|'ENABLE_IN_PROGRESS'|'ENABLE_FAILED'|'DISABLE_COMPLETE'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED' }, 'S3VectorsEngine': { 'Enabled': True|False } } } } **Response Structure** * *(dict) --* The results of a "DeleteDomain" request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted. * **DomainStatus** *(dict) --* The status of the domain being deleted. * **DomainId** *(string) --* Unique identifier for the domain. * **DomainName** *(string) --* Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the *AWS Identity and Access Management User Guide*. * **Created** *(boolean) --* Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress. * **Deleted** *(boolean) --* Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned. * **Endpoint** *(string) --* Domain-specific endpoint used to submit index, search, and data upload requests to the domain. * **EndpointV2** *(string) --* If "IPAddressType" to set to "dualstack", a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. * **Endpoints** *(dict) --* The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example: * **IPv4 IP addresses** - "'vpc','vpc-endpoint- h2dsd34efgyghrtguk5gt6j2foh4.us- east-1.es.amazonaws.com'" * **Dual stack IP addresses** - "'vpcv2':'vpc-endpoint- h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'" * *(string) --* * *(string) --* The domain endpoint to which index and search requests are submitted. For example, "search-imdb-movies- oopcnjfn6ugo.eu-west-1.es.amazonaws.com" or "doc-imdb- movies-oopcnjfn6u.eu-west-1.es.amazonaws.com". * **DomainEndpointV2HostedZoneId** *(string) --* The dual stack hosted zone ID for the domain. * **Processing** *(boolean) --* The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active. * **UpgradeProcessing** *(boolean) --* The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active. * **EngineVersion** *(string) --* Version of OpenSearch or Elasticsearch that the domain is running, in the format "Elasticsearch_X.Y" or "OpenSearch_X.Y". * **ClusterConfig** *(dict) --* Container for the cluster configuration of the domain. * **InstanceType** *(string) --* Instance type of data nodes in the cluster. * **InstanceCount** *(integer) --* Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. * **DedicatedMasterEnabled** *(boolean) --* Indicates whether dedicated master nodes are enabled for the cluster. "True" if the cluster will use a dedicated master node. "False" if the cluster will not. * **ZoneAwarenessEnabled** *(boolean) --* Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi- AZ domain in Amazon OpenSearch Service. * **ZoneAwarenessConfig** *(dict) --* Container for zone awareness configuration options. Only required if "ZoneAwarenessEnabled" is "true". * **AvailabilityZoneCount** *(integer) --* If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are "2" and "3". If your domain is provisioned within a VPC, this value be equal to number of subnets. * **DedicatedMasterType** *(string) --* OpenSearch Service instance type of the dedicated master nodes in the cluster. * **DedicatedMasterCount** *(integer) --* Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. * **WarmEnabled** *(boolean) --* Whether to enable warm storage for the cluster. * **WarmType** *(string) --* The instance type for the cluster's warm nodes. * **WarmCount** *(integer) --* The number of warm nodes in the cluster. * **ColdStorageOptions** *(dict) --* Container for cold storage configuration options. * **Enabled** *(boolean) --* Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. * **MultiAZWithStandbyEnabled** *(boolean) --* A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **NodeOptions** *(list) --* List of node options for the domain. * *(dict) --* Configuration settings for defining the node type within a cluster. * **NodeType** *(string) --* Defines the type of node, such as coordinating nodes. * **NodeConfig** *(dict) --* Configuration options for defining the setup of any node type. * **Enabled** *(boolean) --* A boolean value indicating whether a specific node type is active or inactive. * **Type** *(string) --* The instance type of a particular node within the cluster. * **Count** *(integer) --* The number of nodes of a specific type within the cluster. * **EBSOptions** *(dict) --* Container for EBS-based storage settings for the domain. * **EBSEnabled** *(boolean) --* Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. * **VolumeType** *(string) --* Specifies the type of EBS volumes attached to data nodes. * **VolumeSize** *(integer) --* Specifies the size (in GiB) of EBS volumes attached to data nodes. * **Iops** *(integer) --* Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the "gp3" and provisioned IOPS EBS volume types. * **Throughput** *(integer) --* Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the "gp3" volume type. * **AccessPolicies** *(string) --* Identity and Access Management (IAM) policy document specifying the access policies for the domain. * **IPAddressType** *(string) --* The type of IP addresses supported by the endpoint for the domain. * **SnapshotOptions** *(dict) --* DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes. * **AutomatedSnapshotStartHour** *(integer) --* The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is "0" hours. * **VPCOptions** *(dict) --* The VPC configuration for the domain. * **VPCId** *(string) --* The ID for your VPC. Amazon VPC generates this value when you create a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. * *(string) --* * **AvailabilityZones** *(list) --* The list of Availability Zones associated with the VPC subnets. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. * *(string) --* * **CognitoOptions** *(dict) --* Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards. * **Enabled** *(boolean) --* Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. * **UserPoolId** *(string) --* The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **IdentityPoolId** *(string) --* The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **RoleArn** *(string) --* The "AmazonOpenSearchServiceCognitoAccess" role that allows OpenSearch Service to configure your user pool and identity pool. * **EncryptionAtRestOptions** *(dict) --* Encryption at rest settings for the domain. * **Enabled** *(boolean) --* True to enable encryption at rest. * **KmsKeyId** *(string) --* The KMS key ID. Takes the form "1a2a3a4-1a2a-3a4a-5a6a- 1a2a3a4a5a6a". * **NodeToNodeEncryptionOptions** *(dict) --* Whether node-to-node encryption is enabled or disabled. * **Enabled** *(boolean) --* True to enable node-to-node encryption. * **AdvancedOptions** *(dict) --* Key-value pairs that specify advanced configuration options. * *(string) --* * *(string) --* * **LogPublishingOptions** *(dict) --* Log publishing options for the domain. * *(string) --* The type of log file. Can be one of the following: * **INDEX_SLOW_LOGS** - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute. * **SEARCH_SLOW_LOGS** - Search slow logs contain search queries that took more time than the configured search query log threshold to execute. * **ES_APPLICATION_LOGS** - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting. * **AUDIT_LOGS** - Audit logs contain records of user requests for access to the domain. * *(dict) --* Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs. Note: After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. * **Enabled** *(boolean) --* Whether the log should be published. * **ServiceSoftwareOptions** *(dict) --* The current status of the domain's service software. * **CurrentVersion** *(string) --* The current service software version present on the domain. * **NewVersion** *(string) --* The new service software version, if one is available. * **UpdateAvailable** *(boolean) --* True if you're able to update your service software version. False if you can't update your service software version. * **Cancellable** *(boolean) --* True if you're able to cancel your service software version update. False if you can't cancel your service software update. * **UpdateStatus** *(string) --* The status of your service software update. * **Description** *(string) --* A description of the service software update status. * **AutomatedUpdateDate** *(datetime) --* The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. * **OptionalDeployment** *(boolean) --* True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date. * **DomainEndpointOptions** *(dict) --* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. * **EnforceHTTPS** *(boolean) --* True to require that all traffic to the domain arrive over HTTPS. * **TLSSecurityPolicy** *(string) --* Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports TLS version 1.0 to TLS version 1.2 * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports only TLS version 1.2 * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites * **CustomEndpointEnabled** *(boolean) --* Whether to enable a custom endpoint for the domain. * **CustomEndpoint** *(string) --* The fully qualified URL for the custom endpoint. * **CustomEndpointCertificateArn** *(string) --* The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). * **AdvancedSecurityOptions** *(dict) --* Settings for fine-grained access control. * **Enabled** *(boolean) --* True if fine-grained access control is enabled. * **InternalUserDatabaseEnabled** *(boolean) --* True if the internal user database is enabled. * **SAMLOptions** *(dict) --* Container for information about the SAML configuration for OpenSearch Dashboards. * **Enabled** *(boolean) --* True if SAML is enabled. * **Idp** *(dict) --* Describes the SAML identity provider's information. * **MetadataContent** *(string) --* The metadata of the SAML application, in XML format. * **EntityId** *(string) --* The unique entity ID of the application in the SAML identity provider. * **SubjectKey** *(string) --* The key used for matching the SAML subject attribute. * **RolesKey** *(string) --* The key used for matching the SAML roles attribute. * **SessionTimeoutMinutes** *(integer) --* The duration, in minutes, after which a user session becomes inactive. * **JWTOptions** *(dict) --* Container for information about the JWT configuration of the Amazon OpenSearch Service. * **Enabled** *(boolean) --* True if JWT use is enabled. * **SubjectKey** *(string) --* The key used for matching the JWT subject attribute. * **RolesKey** *(string) --* The key used for matching the JWT roles attribute. * **PublicKey** *(string) --* The key used to verify the signature of incoming JWT requests. * **IAMFederationOptions** *(dict) --* Container for information about the IAM federation configuration for an OpenSearch UI application. * **Enabled** *(boolean) --* True if IAM federation is enabled. * **SubjectKey** *(string) --* The key used for matching the IAM federation subject attribute. * **RolesKey** *(string) --* The key used for matching the IAM federation roles attribute. * **AnonymousAuthDisableDate** *(datetime) --* Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain. * **AnonymousAuthEnabled** *(boolean) --* True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. * **IdentityCenterOptions** *(dict) --* Configuration options for controlling IAM Identity Center integration within a domain. * **EnabledAPIAccess** *(boolean) --* Indicates whether IAM Identity Center is enabled for the application. * **IdentityCenterInstanceARN** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center instance. * **SubjectKey** *(string) --* Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center. * **RolesKey** *(string) --* Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center. * **IdentityCenterApplicationARN** *(string) --* The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service. * **IdentityStoreId** *(string) --* The identifier of the IAM Identity Store. * **AutoTuneOptions** *(dict) --* Auto-Tune settings for the domain. * **State** *(string) --* The current state of Auto-Tune on the domain. * **ErrorMessage** *(string) --* Any errors that occurred while enabling or disabling Auto-Tune. * **UseOffPeakWindow** *(boolean) --* Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule. * **ChangeProgressDetails** *(dict) --* Information about a configuration change happening on the domain. * **ChangeId** *(string) --* The ID of the configuration change. * **Message** *(string) --* A message corresponding to the status of the configuration change. * **ConfigChangeStatus** *(string) --* The current status of the configuration change. * **InitiatedBy** *(string) --* The IAM principal who initiated the configuration change. * **StartTime** *(datetime) --* The time that the configuration change was initiated, in Universal Coordinated Time (UTC). * **LastUpdatedTime** *(datetime) --* The last time that the configuration change was updated. * **OffPeakWindowOptions** *(dict) --* Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain. * **Enabled** *(boolean) --* Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain. * **OffPeakWindow** *(dict) --* Off-peak window settings for the domain. * **WindowStartTime** *(dict) --* A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. * **Hours** *(integer) --* The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, "17" refers to 5:00 P.M. UTC. * **Minutes** *(integer) --* The start minute of the window, in UTC. * **SoftwareUpdateOptions** *(dict) --* Service software update options for the domain. * **AutoSoftwareUpdateEnabled** *(boolean) --* Whether automatic service software updates are enabled for the domain. * **DomainProcessingStatus** *(string) --* The status of any changes that are currently in progress for the domain. * **ModifyingProperties** *(list) --* Information about the domain properties that are currently being modified. * *(dict) --* Information about the domain properties that are currently being modified. * **Name** *(string) --* The name of the property that is currently being modified. * **ActiveValue** *(string) --* The current value of the domain property that is being modified. * **PendingValue** *(string) --* The value that the property that is currently being modified will eventually have. * **ValueType** *(string) --* The type of value that is currently being modified. Properties can have two types: * "PLAIN_TEXT": Contain direct values such as "1", "True", or "c5.large.search". * "STRINGIFIED_JSON": Contain content in JSON format, such as {"Enabled":"True"}". * **AIMLOptions** *(dict) --* Container for parameters required to enable all machine learning features. * **NaturalLanguageQueryGenerationOptions** *(dict) --* Container for parameters required for natural language query generation on the specified domain. * **DesiredState** *(string) --* The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED. * **CurrentState** *(string) --* The current state of the natural language query generation feature, indicating completion, in progress, or failure. * **S3VectorsEngine** *(dict) --* Container for parameters representing the state of S3 vectors engine features on the specified domain. * **Enabled** *(boolean) --* Enables S3 vectors engine features. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / list_vpc_endpoint_access list_vpc_endpoint_access ************************ OpenSearchService.Client.list_vpc_endpoint_access(**kwargs) Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.list_vpc_endpoint_access( DomainName='string', NextToken='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the OpenSearch Service domain to retrieve access information for. * **NextToken** (*string*) -- If your initial "ListVpcEndpointAccess" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListVpcEndpointAccess" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'AuthorizedPrincipalList': [ { 'PrincipalType': 'AWS_ACCOUNT'|'AWS_SERVICE', 'Principal': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **AuthorizedPrincipalList** *(list) --* A list of IAM principals that can currently access the domain. * *(dict) --* Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint. * **PrincipalType** *(string) --* The type of principal. * **Principal** *(string) --* The IAM principal that is allowed access to the domain. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.BaseException" OpenSearchService / Client / purchase_reserved_instance_offering purchase_reserved_instance_offering *********************************** OpenSearchService.Client.purchase_reserved_instance_offering(**kwargs) Allows you to purchase Amazon OpenSearch Service Reserved Instances. See also: AWS API Documentation **Request Syntax** response = client.purchase_reserved_instance_offering( ReservedInstanceOfferingId='string', ReservationName='string', InstanceCount=123 ) Parameters: * **ReservedInstanceOfferingId** (*string*) -- **[REQUIRED]** The ID of the Reserved Instance offering to purchase. * **ReservationName** (*string*) -- **[REQUIRED]** A customer-specified identifier to track this reservation. * **InstanceCount** (*integer*) -- The number of OpenSearch instances to reserve. Return type: dict Returns: **Response Syntax** { 'ReservedInstanceId': 'string', 'ReservationName': 'string' } **Response Structure** * *(dict) --* Represents the output of a "PurchaseReservedInstanceOffering" operation. * **ReservedInstanceId** *(string) --* The ID of the Reserved Instance offering that was purchased. * **ReservationName** *(string) --* The customer-specified identifier used to track this reservation. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ResourceAlreadyExistsExcept ion" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.InternalException" OpenSearchService / Client / list_data_sources list_data_sources ***************** OpenSearchService.Client.list_data_sources(**kwargs) Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3. See also: AWS API Documentation **Request Syntax** response = client.list_data_sources( DomainName='string' ) Parameters: **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. Return type: dict Returns: **Response Syntax** { 'DataSources': [ { 'DataSourceType': { 'S3GlueDataCatalog': { 'RoleArn': 'string' } }, 'Name': 'string', 'Description': 'string', 'Status': 'ACTIVE'|'DISABLED' }, ] } **Response Structure** * *(dict) --* The result of a "ListDataSources" operation. * **DataSources** *(list) --* A list of data sources associated with specified domain. * *(dict) --* Details about a direct-query data source. * **DataSourceType** *(dict) --* The type of data source. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "S3GlueDataCatalog". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **S3GlueDataCatalog** *(dict) --* An Amazon S3 data source. * **RoleArn** *(string) --* >The Amazon Resource Name (ARN) for the S3 Glue Data Catalog. * **Name** *(string) --* The name of the data source. * **Description** *(string) --* A description of the data source. * **Status** *(string) --* The status of the data source. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.DependencyFailureException" OpenSearchService / Client / get_waiter get_waiter ********** OpenSearchService.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" OpenSearchService / Client / describe_reserved_instance_offerings describe_reserved_instance_offerings ************************************ OpenSearchService.Client.describe_reserved_instance_offerings(**kwargs) Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.describe_reserved_instance_offerings( ReservedInstanceOfferingId='string', MaxResults=123, NextToken='string' ) Parameters: * **ReservedInstanceOfferingId** (*string*) -- The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier. * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "DescribeReservedInstanceOfferings" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "DescribeReservedInstanceOfferings" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'ReservedInstanceOfferings': [ { 'ReservedInstanceOfferingId': 'string', 'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search', 'Duration': 123, 'FixedPrice': 123.0, 'UsagePrice': 123.0, 'CurrencyCode': 'string', 'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT', 'RecurringCharges': [ { 'RecurringChargeAmount': 123.0, 'RecurringChargeFrequency': 'string' }, ] }, ] } **Response Structure** * *(dict) --* Container for results of a "DescribeReservedInstanceOfferings" request. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. * **ReservedInstanceOfferings** *(list) --* List of Reserved Instance offerings. * *(dict) --* Details of an OpenSearch Reserved Instance offering. * **ReservedInstanceOfferingId** *(string) --* The unique identifier of the Reserved Instance offering. * **InstanceType** *(string) --* The OpenSearch instance type offered by the Reserved Instance offering. * **Duration** *(integer) --* The duration, in seconds, for which the offering will reserve the OpenSearch instance. * **FixedPrice** *(float) --* The upfront fixed charge you will pay to purchase the specific Reserved Instance offering. * **UsagePrice** *(float) --* The hourly rate at which you're charged for the domain using this Reserved Instance. * **CurrencyCode** *(string) --* The currency code for the Reserved Instance offering. * **PaymentOption** *(string) --* Payment option for the Reserved Instance offering * **RecurringCharges** *(list) --* The recurring charge to your account, regardless of whether you creates any domains using the offering. * *(dict) --* Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering. * **RecurringChargeAmount** *(float) --* The monetary amount of the recurring charge. * **RecurringChargeFrequency** *(string) --* The frequency of the recurring charge. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.InternalException" OpenSearchService / Client / describe_outbound_connections describe_outbound_connections ***************************** OpenSearchService.Client.describe_outbound_connections(**kwargs) Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.describe_outbound_connections( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **Filters** (*list*) -- List of filter names and values that you can use for requests. * *(dict) --* A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation. * **Name** *(string) --* The name of the filter. * **Values** *(list) --* One or more values for the filter. * *(string) --* * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "DescribeOutboundConnections" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "DescribeOutboundConnections" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'Connections': [ { 'LocalDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'RemoteDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'ConnectionId': 'string', 'ConnectionAlias': 'string', 'ConnectionStatus': { 'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED', 'Message': 'string' }, 'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT', 'ConnectionProperties': { 'Endpoint': 'string', 'CrossClusterSearch': { 'SkipUnavailable': 'ENABLED'|'DISABLED' } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains a list of connections matching the filter criteria. * **Connections** *(list) --* List of outbound connections that match the filter criteria. * *(dict) --* Specifies details about an outbound cross-cluster connection. * **LocalDomainInfo** *(dict) --* Information about the source (local) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **RemoteDomainInfo** *(dict) --* Information about the destination (remote) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **ConnectionId** *(string) --* Unique identifier of the connection. * **ConnectionAlias** *(string) --* Name of the connection. * **ConnectionStatus** *(dict) --* Status of the connection. * **StatusCode** *(string) --* The status code for the outbound connection. Can be one of the following: * **VALIDATING** - The outbound connection request is being validated. * **VALIDATION_FAILED** - Validation failed for the connection request. * **PENDING_ACCEPTANCE**: Outbound connection request is validated and is not yet accepted by the remote domain owner. * **APPROVED** - Outbound connection has been approved by the remote domain owner for getting provisioned. * **PROVISIONING** - Outbound connection request is in process. * **ACTIVE** - Outbound connection is active and ready to use. * **REJECTING** - Outbound connection rejection by remote domain owner is in progress. * **REJECTED** - Outbound connection request is rejected by remote domain owner. * **DELETING** - Outbound connection deletion is in progress. * **DELETED** - Outbound connection is deleted and can no longer be used. * **Message** *(string) --* Verbose information for the outbound connection. * **ConnectionMode** *(string) --* The connection mode. * **ConnectionProperties** *(dict) --* Properties for the outbound connection. * **Endpoint** *(string) --* Warning: The Endpoint attribute cannot be modified. The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode. * **CrossClusterSearch** *(dict) --* The connection properties for cross cluster search. * **SkipUnavailable** *(string) --* The status of the "SkipUnavailable" setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.InvalidPaginationTokenExcep tion" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / list_versions list_versions ************* OpenSearchService.Client.list_versions(**kwargs) Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports. See also: AWS API Documentation **Request Syntax** response = client.list_versions( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "ListVersions" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListVersions" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'Versions': [ 'string', ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Container for the parameters for response received from the "ListVersions" operation. * **Versions** *(list) --* A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports. * *(string) --* * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / cancel_service_software_update cancel_service_software_update ****************************** OpenSearchService.Client.cancel_service_software_update(**kwargs) Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the "AutomatedUpdateDate" and when the domain's "UpdateStatus" is "PENDING_UPDATE". For more information, see Service software updates in Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.cancel_service_software_update( DomainName='string' ) Parameters: **DomainName** (*string*) -- **[REQUIRED]** Name of the OpenSearch Service domain that you want to cancel the service software update on. Return type: dict Returns: **Response Syntax** { 'ServiceSoftwareOptions': { 'CurrentVersion': 'string', 'NewVersion': 'string', 'UpdateAvailable': True|False, 'Cancellable': True|False, 'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE', 'Description': 'string', 'AutomatedUpdateDate': datetime(2015, 1, 1), 'OptionalDeployment': True|False } } **Response Structure** * *(dict) --* Container for the response to a "CancelServiceSoftwareUpdate" operation. Contains the status of the update. * **ServiceSoftwareOptions** *(dict) --* Container for the state of your domain relative to the latest service software. * **CurrentVersion** *(string) --* The current service software version present on the domain. * **NewVersion** *(string) --* The new service software version, if one is available. * **UpdateAvailable** *(boolean) --* True if you're able to update your service software version. False if you can't update your service software version. * **Cancellable** *(boolean) --* True if you're able to cancel your service software version update. False if you can't cancel your service software update. * **UpdateStatus** *(string) --* The status of your service software update. * **Description** *(string) --* A description of the service software update status. * **AutomatedUpdateDate** *(datetime) --* The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. * **OptionalDeployment** *(boolean) --* True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / get_upgrade_history get_upgrade_history ******************* OpenSearchService.Client.get_upgrade_history(**kwargs) Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain. See also: AWS API Documentation **Request Syntax** response = client.get_upgrade_history( DomainName='string', MaxResults=123, NextToken='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of an existing domain. * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "GetUpgradeHistory" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "GetUpgradeHistory" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'UpgradeHistories': [ { 'UpgradeName': 'string', 'StartTimestamp': datetime(2015, 1, 1), 'UpgradeStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED', 'StepsList': [ { 'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE', 'UpgradeStepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED', 'Issues': [ 'string', ], 'ProgressPercent': 123.0 }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Container for the response returned by the "GetUpgradeHistory" operation. * **UpgradeHistories** *(list) --* A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain. * *(dict) --* History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain. * **UpgradeName** *(string) --* A string that describes the upgrade. * **StartTimestamp** *(datetime) --* UTC timestamp at which the upgrade API call was made, in the format "yyyy-MM-ddTHH:mm:ssZ". * **UpgradeStatus** *(string) --* The current status of the upgrade. The status can take one of the following values: * In Progress * Succeeded * Succeeded with Issues * Failed * **StepsList** *(list) --* A list of each step performed as part of a specific upgrade or upgrade eligibility check. * *(dict) --* Represents a single step of an upgrade or upgrade eligibility check workflow. * **UpgradeStep** *(string) --* One of three steps that an upgrade or upgrade eligibility check goes through: * PreUpgradeCheck * Snapshot * Upgrade * **UpgradeStepStatus** *(string) --* The current status of the upgrade. The status can take one of the following values: * In Progress * Succeeded * Succeeded with Issues * Failed * **Issues** *(list) --* A list of strings containing detailed information about the errors encountered in a particular step. * *(string) --* * **ProgressPercent** *(float) --* The floating point value representing the progress percentage of a particular step. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.InternalException" OpenSearchService / Client / update_domain_config update_domain_config ******************** OpenSearchService.Client.update_domain_config(**kwargs) Modifies the cluster configuration of the specified Amazon OpenSearch Service domain. See also: AWS API Documentation **Request Syntax** response = client.update_domain_config( DomainName='string', ClusterConfig={ 'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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 }, 'MultiAZWithStandbyEnabled': True|False, 'NodeOptions': [ { 'NodeType': 'coordinator', 'NodeConfig': { 'Enabled': True|False, 'Type': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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', 'Count': 123 } }, ] }, EBSOptions={ 'EBSEnabled': True|False, 'VolumeType': 'standard'|'gp2'|'io1'|'gp3', 'VolumeSize': 123, 'Iops': 123, 'Throughput': 123 }, SnapshotOptions={ 'AutomatedSnapshotStartHour': 123 }, VPCOptions={ 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, CognitoOptions={ 'Enabled': True|False, 'UserPoolId': 'string', 'IdentityPoolId': 'string', 'RoleArn': 'string' }, AdvancedOptions={ 'string': 'string' }, AccessPolicies='string', IPAddressType='ipv4'|'dualstack', 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'|'Policy-Min-TLS-1-2-PFS-2023-10', '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 }, 'JWTOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string', 'PublicKey': 'string' }, 'IAMFederationOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string' }, 'AnonymousAuthEnabled': True|False }, IdentityCenterOptions={ 'EnabledAPIAccess': True|False, 'IdentityCenterInstanceARN': 'string', 'SubjectKey': 'UserName'|'UserId'|'Email', 'RolesKey': 'GroupName'|'GroupId' }, AutoTuneOptions={ 'DesiredState': 'ENABLED'|'DISABLED', 'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK', 'MaintenanceSchedules': [ { 'StartAt': datetime(2015, 1, 1), 'Duration': { 'Value': 123, 'Unit': 'HOURS' }, 'CronExpressionForRecurrence': 'string' }, ], 'UseOffPeakWindow': True|False }, DryRun=True|False, DryRunMode='Basic'|'Verbose', OffPeakWindowOptions={ 'Enabled': True|False, 'OffPeakWindow': { 'WindowStartTime': { 'Hours': 123, 'Minutes': 123 } } }, SoftwareUpdateOptions={ 'AutoSoftwareUpdateEnabled': True|False }, AIMLOptions={ 'NaturalLanguageQueryGenerationOptions': { 'DesiredState': 'ENABLED'|'DISABLED' }, 'S3VectorsEngine': { 'Enabled': True|False } } ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain that you're updating. * **ClusterConfig** (*dict*) -- Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances. * **InstanceType** *(string) --* Instance type of data nodes in the cluster. * **InstanceCount** *(integer) --* Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. * **DedicatedMasterEnabled** *(boolean) --* Indicates whether dedicated master nodes are enabled for the cluster. "True" if the cluster will use a dedicated master node. "False" if the cluster will not. * **ZoneAwarenessEnabled** *(boolean) --* Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **ZoneAwarenessConfig** *(dict) --* Container for zone awareness configuration options. Only required if "ZoneAwarenessEnabled" is "true". * **AvailabilityZoneCount** *(integer) --* If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are "2" and "3". If your domain is provisioned within a VPC, this value be equal to number of subnets. * **DedicatedMasterType** *(string) --* OpenSearch Service instance type of the dedicated master nodes in the cluster. * **DedicatedMasterCount** *(integer) --* Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. * **WarmEnabled** *(boolean) --* Whether to enable warm storage for the cluster. * **WarmType** *(string) --* The instance type for the cluster's warm nodes. * **WarmCount** *(integer) --* The number of warm nodes in the cluster. * **ColdStorageOptions** *(dict) --* Container for cold storage configuration options. * **Enabled** *(boolean) --* **[REQUIRED]** Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. * **MultiAZWithStandbyEnabled** *(boolean) --* A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **NodeOptions** *(list) --* List of node options for the domain. * *(dict) --* Configuration settings for defining the node type within a cluster. * **NodeType** *(string) --* Defines the type of node, such as coordinating nodes. * **NodeConfig** *(dict) --* Configuration options for defining the setup of any node type. * **Enabled** *(boolean) --* A boolean value indicating whether a specific node type is active or inactive. * **Type** *(string) --* The instance type of a particular node within the cluster. * **Count** *(integer) --* The number of nodes of a specific type within the cluster. * **EBSOptions** (*dict*) -- The type and size of the EBS volume to attach to instances in the domain. * **EBSEnabled** *(boolean) --* Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. * **VolumeType** *(string) --* Specifies the type of EBS volumes attached to data nodes. * **VolumeSize** *(integer) --* Specifies the size (in GiB) of EBS volumes attached to data nodes. * **Iops** *(integer) --* Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the "gp3" and provisioned IOPS EBS volume types. * **Throughput** *(integer) --* Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the "gp3" volume type. * **SnapshotOptions** (*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 OpenSearch Service takes a daily automated snapshot of the specified domain. Default is "0" hours. * **VPCOptions** (*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) --* A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC. * *(string) --* * **CognitoOptions** (*dict*) -- Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards. * **Enabled** *(boolean) --* Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. * **UserPoolId** *(string) --* The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **IdentityPoolId** *(string) --* The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **RoleArn** *(string) --* The "AmazonOpenSearchServiceCognitoAccess" role that allows OpenSearch Service to configure your user pool and identity pool. * **AdvancedOptions** (*dict*) -- Key-value pairs to specify advanced configuration options. The following key-value pairs are supported: * ""rest.action.multi.allow_explicit_index": "true" | "false"" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. * ""indices.fielddata.cache.size": "80"" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. * ""indices.query.bool.max_clause_count": "1024"" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a "TooManyClauses" error. For more information, see Advanced cluster parameters. * *(string) --* * *(string) --* * **AccessPolicies** (*string*) -- Identity and Access Management (IAM) access policy as a JSON-formatted string. * **IPAddressType** (*string*) -- Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it. * **LogPublishingOptions** (*dict*) -- Options to publish OpenSearch logs to Amazon CloudWatch Logs. * *(string) --* The type of log file. Can be one of the following: * **INDEX_SLOW_LOGS** - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute. * **SEARCH_SLOW_LOGS** - Search slow logs contain search queries that took more time than the configured search query log threshold to execute. * **ES_APPLICATION_LOGS** - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting. * **AUDIT_LOGS** - Audit logs contain records of user requests for access to the domain. * *(dict) --* Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs. Note: After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. * **Enabled** *(boolean) --* Whether the log should be published. * **EncryptionAtRestOptions** (*dict*) -- Encryption at rest options for the domain. * **Enabled** *(boolean) --* True to enable encryption at rest. * **KmsKeyId** *(string) --* The KMS key ID. Takes the form "1a2a3a4-1a2a-3a4a-5a6a- 1a2a3a4a5a6a". * **DomainEndpointOptions** (*dict*) -- Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. * **EnforceHTTPS** *(boolean) --* True to require that all traffic to the domain arrive over HTTPS. * **TLSSecurityPolicy** *(string) --* Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports TLS version 1.0 to TLS version 1.2 * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports only TLS version 1.2 * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites * **CustomEndpointEnabled** *(boolean) --* Whether to enable a custom endpoint for the domain. * **CustomEndpoint** *(string) --* The fully qualified URL for the custom endpoint. * **CustomEndpointCertificateArn** *(string) --* The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). * **NodeToNodeEncryptionOptions** (*dict*) -- Node-to-node encryption options for the domain. * **Enabled** *(boolean) --* True to enable node-to-node encryption. * **AdvancedSecurityOptions** (*dict*) -- Options for fine-grained access control. * **Enabled** *(boolean) --* True to enable fine-grained access control. * **InternalUserDatabaseEnabled** *(boolean) --* True to enable the internal user database. * **MasterUserOptions** *(dict) --* Container for information about the master user. * **MasterUserARN** *(string) --* Amazon Resource Name (ARN) for the master user. Only specify if "InternalUserDatabaseEnabled" is "false". * **MasterUserName** *(string) --* User name for the master user. Only specify if "InternalUserDatabaseEnabled" is "true". * **MasterUserPassword** *(string) --* Password for the master user. Only specify if "InternalUserDatabaseEnabled" is "true". * **SAMLOptions** *(dict) --* Container for information about the SAML configuration for OpenSearch Dashboards. * **Enabled** *(boolean) --* True to enable SAML authentication for a domain. * **Idp** *(dict) --* The SAML Identity Provider's information. * **MetadataContent** *(string) --* **[REQUIRED]** The metadata of the SAML application, in XML format. * **EntityId** *(string) --* **[REQUIRED]** The unique entity ID of the application in the SAML identity provider. * **MasterUserName** *(string) --* The SAML master user name, which is stored in the domain's internal user database. * **MasterBackendRole** *(string) --* The backend role that the SAML master user is mapped to. * **SubjectKey** *(string) --* Element of the SAML assertion to use for the user name. Default is "NameID". * **RolesKey** *(string) --* Element of the SAML assertion to use for backend roles. Default is "roles". * **SessionTimeoutMinutes** *(integer) --* The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60. * **JWTOptions** *(dict) --* Container for information about the JWT configuration of the Amazon OpenSearch Service. * **Enabled** *(boolean) --* True to enable JWT authentication and authorization for a domain. * **SubjectKey** *(string) --* Element of the JWT assertion to use for the user name. * **RolesKey** *(string) --* Element of the JWT assertion to use for roles. * **PublicKey** *(string) --* Element of the JWT assertion used by the cluster to verify JWT signatures. * **IAMFederationOptions** *(dict) --* Container for information about the IAM federation configuration for an OpenSearch UI application. * **Enabled** *(boolean) --* True to enable IAM federation authentication for a domain. * **SubjectKey** *(string) --* Element of the IAM federation assertion to use for the user name. Default is "sub". * **RolesKey** *(string) --* Element of the IAM federation assertion to use for backend roles. Default is "roles". * **AnonymousAuthEnabled** *(boolean) --* True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. * **IdentityCenterOptions** (*dict*) -- Configuration settings for enabling and managing IAM Identity Center. * **EnabledAPIAccess** *(boolean) --* Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service. * **IdentityCenterInstanceARN** *(string) --* The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication. * **SubjectKey** *(string) --* Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center. * **RolesKey** *(string) --* Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center. * **AutoTuneOptions** (*dict*) -- Options for Auto-Tune. * **DesiredState** *(string) --* Whether Auto-Tune is enabled or disabled. * **RollbackOnDisable** *(string) --* When disabling Auto-Tune, specify "NO_ROLLBACK" to retain all prior Auto-Tune settings or "DEFAULT_ROLLBACK" to revert to the OpenSearch Service defaults. If you specify "DEFAULT_ROLLBACK", you must include a "MaintenanceSchedule" in the request. Otherwise, OpenSearch Service is unable to perform the rollback. * **MaintenanceSchedules** *(list) --* DEPRECATED. Use off-peak window instead. A list of maintenance schedules during which Auto-Tune can deploy changes. * *(dict) --* Note: This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows. The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service. * **StartAt** *(datetime) --* The Epoch timestamp at which the Auto-Tune maintenance schedule starts. * **Duration** *(dict) --* The duration of the maintenance schedule. For example, ""Duration": {"Value": 2, "Unit": "HOURS"}". * **Value** *(integer) --* Integer to specify the value of a maintenance schedule duration. * **Unit** *(string) --* The unit of measurement for the duration of a maintenance schedule. * **CronExpressionForRecurrence** *(string) --* A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes. * **UseOffPeakWindow** *(boolean) --* Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule. * **DryRun** (*boolean*) -- This flag, when set to True, specifies whether the "UpdateDomain" request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause. * **DryRunMode** (*string*) -- The type of dry run to perform. * "Basic" only returns the type of deployment (blue/green or dynamic) that the update will cause. * "Verbose" runs an additional check to validate the changes you're making. For more information, see Validating a domain update. * **OffPeakWindowOptions** (*dict*) -- Off-peak window options for the domain. * **Enabled** *(boolean) --* Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off- peak window enabled by default. You can't disable the off- peak window after it's enabled for a domain. * **OffPeakWindow** *(dict) --* Off-peak window settings for the domain. * **WindowStartTime** *(dict) --* A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. * **Hours** *(integer) --* **[REQUIRED]** The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, "17" refers to 5:00 P.M. UTC. * **Minutes** *(integer) --* **[REQUIRED]** The start minute of the window, in UTC. * **SoftwareUpdateOptions** (*dict*) -- Service software update options for the domain. * **AutoSoftwareUpdateEnabled** *(boolean) --* Whether automatic service software updates are enabled for the domain. * **AIMLOptions** (*dict*) -- Options for all machine learning features for the specified domain. * **NaturalLanguageQueryGenerationOptions** *(dict) --* Container for parameters required for natural language query generation on the specified domain. * **DesiredState** *(string) --* The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED. * **S3VectorsEngine** *(dict) --* Container for parameters required to enable S3 vectors engine features on the specified domain. * **Enabled** *(boolean) --* Enables S3 vectors engine features. Return type: dict Returns: **Response Syntax** { 'DomainConfig': { 'EngineVersion': { 'Options': 'string', 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'ClusterConfig': { 'Options': { 'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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 }, 'MultiAZWithStandbyEnabled': True|False, 'NodeOptions': [ { 'NodeType': 'coordinator', 'NodeConfig': { 'Enabled': True|False, 'Type': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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', 'Count': 123 } }, ] }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'EBSOptions': { 'Options': { 'EBSEnabled': True|False, 'VolumeType': 'standard'|'gp2'|'io1'|'gp3', 'VolumeSize': 123, 'Iops': 123, 'Throughput': 123 }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'AccessPolicies': { 'Options': 'string', 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'IPAddressType': { 'Options': 'ipv4'|'dualstack', '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'|'Policy-Min-TLS-1-2-PFS-2023-10', '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 }, 'JWTOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string', 'PublicKey': 'string' }, 'IAMFederationOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string' }, '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 } }, 'IdentityCenterOptions': { 'Options': { 'EnabledAPIAccess': True|False, 'IdentityCenterInstanceARN': 'string', 'SubjectKey': 'UserName'|'UserId'|'Email', 'RolesKey': 'GroupName'|'GroupId', 'IdentityCenterApplicationARN': 'string', 'IdentityStoreId': 'string' }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'AutoTuneOptions': { 'Options': { 'DesiredState': 'ENABLED'|'DISABLED', 'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK', 'MaintenanceSchedules': [ { 'StartAt': datetime(2015, 1, 1), 'Duration': { 'Value': 123, 'Unit': 'HOURS' }, 'CronExpressionForRecurrence': 'string' }, ], 'UseOffPeakWindow': True|False }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR', 'ErrorMessage': 'string', 'PendingDeletion': True|False } }, 'ChangeProgressDetails': { 'ChangeId': 'string', 'Message': 'string', 'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled', 'InitiatedBy': 'CUSTOMER'|'SERVICE', 'StartTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, 'OffPeakWindowOptions': { 'Options': { 'Enabled': True|False, 'OffPeakWindow': { 'WindowStartTime': { 'Hours': 123, 'Minutes': 123 } } }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'SoftwareUpdateOptions': { 'Options': { 'AutoSoftwareUpdateEnabled': True|False }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'ModifyingProperties': [ { 'Name': 'string', 'ActiveValue': 'string', 'PendingValue': 'string', 'ValueType': 'PLAIN_TEXT'|'STRINGIFIED_JSON' }, ], 'AIMLOptions': { 'Options': { 'NaturalLanguageQueryGenerationOptions': { 'DesiredState': 'ENABLED'|'DISABLED', 'CurrentState': 'NOT_ENABLED'|'ENABLE_COMPLETE'|'ENABLE_IN_PROGRESS'|'ENABLE_FAILED'|'DISABLE_COMPLETE'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED' }, 'S3VectorsEngine': { 'Enabled': True|False } }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } } }, 'DryRunResults': { 'DeploymentType': 'string', 'Message': 'string' }, 'DryRunProgressStatus': { 'DryRunId': 'string', 'DryRunStatus': 'string', 'CreationDate': 'string', 'UpdateDate': 'string', 'ValidationFailures': [ { 'Code': 'string', 'Message': 'string' }, ] } } **Response Structure** * *(dict) --* The results of an "UpdateDomain" request. Contains the status of the domain being updated. * **DomainConfig** *(dict) --* The status of the updated domain. * **EngineVersion** *(dict) --* The OpenSearch or Elasticsearch version that the domain is running. * **Options** *(string) --* The OpenSearch or Elasticsearch version for the specified domain. * **Status** *(dict) --* The status of the version options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **ClusterConfig** *(dict) --* Container for the cluster configuration of a the domain. * **Options** *(dict) --* Cluster configuration options for the specified domain. * **InstanceType** *(string) --* Instance type of data nodes in the cluster. * **InstanceCount** *(integer) --* Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. * **DedicatedMasterEnabled** *(boolean) --* Indicates whether dedicated master nodes are enabled for the cluster. "True" if the cluster will use a dedicated master node. "False" if the cluster will not. * **ZoneAwarenessEnabled** *(boolean) --* Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **ZoneAwarenessConfig** *(dict) --* Container for zone awareness configuration options. Only required if "ZoneAwarenessEnabled" is "true". * **AvailabilityZoneCount** *(integer) --* If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are "2" and "3". If your domain is provisioned within a VPC, this value be equal to number of subnets. * **DedicatedMasterType** *(string) --* OpenSearch Service instance type of the dedicated master nodes in the cluster. * **DedicatedMasterCount** *(integer) --* Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. * **WarmEnabled** *(boolean) --* Whether to enable warm storage for the cluster. * **WarmType** *(string) --* The instance type for the cluster's warm nodes. * **WarmCount** *(integer) --* The number of warm nodes in the cluster. * **ColdStorageOptions** *(dict) --* Container for cold storage configuration options. * **Enabled** *(boolean) --* Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. * **MultiAZWithStandbyEnabled** *(boolean) --* A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **NodeOptions** *(list) --* List of node options for the domain. * *(dict) --* Configuration settings for defining the node type within a cluster. * **NodeType** *(string) --* Defines the type of node, such as coordinating nodes. * **NodeConfig** *(dict) --* Configuration options for defining the setup of any node type. * **Enabled** *(boolean) --* A boolean value indicating whether a specific node type is active or inactive. * **Type** *(string) --* The instance type of a particular node within the cluster. * **Count** *(integer) --* The number of nodes of a specific type within the cluster. * **Status** *(dict) --* The status of cluster configuration options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **EBSOptions** *(dict) --* Container for EBS options configured for the domain. * **Options** *(dict) --* The configured EBS options for the specified domain. * **EBSEnabled** *(boolean) --* Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. * **VolumeType** *(string) --* Specifies the type of EBS volumes attached to data nodes. * **VolumeSize** *(integer) --* Specifies the size (in GiB) of EBS volumes attached to data nodes. * **Iops** *(integer) --* Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the "gp3" and provisioned IOPS EBS volume types. * **Throughput** *(integer) --* Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the "gp3" volume type. * **Status** *(dict) --* The status of the EBS options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **AccessPolicies** *(dict) --* Specifies the access policies for the domain. * **Options** *(string) --* The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies. * **Status** *(dict) --* The status of the access policy for the domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **IPAddressType** *(dict) --* Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later. * **Options** *(string) --* The IP address options for the domain. * **Status** *(dict) --* Provides the current status of an entity. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **SnapshotOptions** *(dict) --* DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes. * **Options** *(dict) --* The daily snapshot options specified for the domain. * **AutomatedSnapshotStartHour** *(integer) --* The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is "0" hours. * **Status** *(dict) --* The status of a daily automated snapshot. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **VPCOptions** *(dict) --* The current VPC options for the domain and the status of any updates to their configuration. * **Options** *(dict) --* The VPC options for the specified domain. * **VPCId** *(string) --* The ID for your VPC. Amazon VPC generates this value when you create a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. * *(string) --* * **AvailabilityZones** *(list) --* The list of Availability Zones associated with the VPC subnets. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. * *(string) --* * **Status** *(dict) --* The status of the VPC options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **CognitoOptions** *(dict) --* Container for Amazon Cognito options for the domain. * **Options** *(dict) --* Cognito options for the specified domain. * **Enabled** *(boolean) --* Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. * **UserPoolId** *(string) --* The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **IdentityPoolId** *(string) --* The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **RoleArn** *(string) --* The "AmazonOpenSearchServiceCognitoAccess" role that allows OpenSearch Service to configure your user pool and identity pool. * **Status** *(dict) --* The status of the Cognito options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **EncryptionAtRestOptions** *(dict) --* Key-value pairs to enable encryption at rest. * **Options** *(dict) --* Encryption at rest options for the specified domain. * **Enabled** *(boolean) --* True to enable encryption at rest. * **KmsKeyId** *(string) --* The KMS key ID. Takes the form "1a2a3a4-1a2a-3a4a- 5a6a-1a2a3a4a5a6a". * **Status** *(dict) --* The status of the encryption at rest options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **NodeToNodeEncryptionOptions** *(dict) --* Whether node-to-node encryption is enabled or disabled. * **Options** *(dict) --* The node-to-node encryption options for the specified domain. * **Enabled** *(boolean) --* True to enable node-to-node encryption. * **Status** *(dict) --* The status of the node-to-node encryption options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **AdvancedOptions** *(dict) --* Key-value pairs to specify advanced configuration options. For more information, see Advanced options. * **Options** *(dict) --* The status of advanced options for the specified domain. * *(string) --* * *(string) --* * **Status** *(dict) --* The status of advanced options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **LogPublishingOptions** *(dict) --* Key-value pairs to configure log publishing. * **Options** *(dict) --* The log publishing options configured for the domain. * *(string) --* The type of log file. Can be one of the following: * **INDEX_SLOW_LOGS** - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute. * **SEARCH_SLOW_LOGS** - Search slow logs contain search queries that took more time than the configured search query log threshold to execute. * **ES_APPLICATION_LOGS** - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting. * **AUDIT_LOGS** - Audit logs contain records of user requests for access to the domain. * *(dict) --* Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs. Note: After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. * **Enabled** *(boolean) --* Whether the log should be published. * **Status** *(dict) --* The status of the log publishing options for the domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **DomainEndpointOptions** *(dict) --* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. * **Options** *(dict) --* Options to configure the endpoint for a domain. * **EnforceHTTPS** *(boolean) --* True to require that all traffic to the domain arrive over HTTPS. * **TLSSecurityPolicy** *(string) --* Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports TLS version 1.0 to TLS version 1.2 * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports only TLS version 1.2 * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites * **CustomEndpointEnabled** *(boolean) --* Whether to enable a custom endpoint for the domain. * **CustomEndpoint** *(string) --* The fully qualified URL for the custom endpoint. * **CustomEndpointCertificateArn** *(string) --* The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). * **Status** *(dict) --* The status of the endpoint options for a domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **AdvancedSecurityOptions** *(dict) --* Container for fine-grained access control settings for the domain. * **Options** *(dict) --* Container for fine-grained access control settings. * **Enabled** *(boolean) --* True if fine-grained access control is enabled. * **InternalUserDatabaseEnabled** *(boolean) --* True if the internal user database is enabled. * **SAMLOptions** *(dict) --* Container for information about the SAML configuration for OpenSearch Dashboards. * **Enabled** *(boolean) --* True if SAML is enabled. * **Idp** *(dict) --* Describes the SAML identity provider's information. * **MetadataContent** *(string) --* The metadata of the SAML application, in XML format. * **EntityId** *(string) --* The unique entity ID of the application in the SAML identity provider. * **SubjectKey** *(string) --* The key used for matching the SAML subject attribute. * **RolesKey** *(string) --* The key used for matching the SAML roles attribute. * **SessionTimeoutMinutes** *(integer) --* The duration, in minutes, after which a user session becomes inactive. * **JWTOptions** *(dict) --* Container for information about the JWT configuration of the Amazon OpenSearch Service. * **Enabled** *(boolean) --* True if JWT use is enabled. * **SubjectKey** *(string) --* The key used for matching the JWT subject attribute. * **RolesKey** *(string) --* The key used for matching the JWT roles attribute. * **PublicKey** *(string) --* The key used to verify the signature of incoming JWT requests. * **IAMFederationOptions** *(dict) --* Container for information about the IAM federation configuration for an OpenSearch UI application. * **Enabled** *(boolean) --* True if IAM federation is enabled. * **SubjectKey** *(string) --* The key used for matching the IAM federation subject attribute. * **RolesKey** *(string) --* The key used for matching the IAM federation roles attribute. * **AnonymousAuthDisableDate** *(datetime) --* Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain. * **AnonymousAuthEnabled** *(boolean) --* True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. * **Status** *(dict) --* Status of the fine-grained access control settings for a domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **IdentityCenterOptions** *(dict) --* Configuration options for enabling and managing IAM Identity Center integration within a domain. * **Options** *(dict) --* Configuration settings for IAM Identity Center integration. * **EnabledAPIAccess** *(boolean) --* Indicates whether IAM Identity Center is enabled for the application. * **IdentityCenterInstanceARN** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center instance. * **SubjectKey** *(string) --* Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center. * **RolesKey** *(string) --* Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center. * **IdentityCenterApplicationARN** *(string) --* The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service. * **IdentityStoreId** *(string) --* The identifier of the IAM Identity Store. * **Status** *(dict) --* The status of IAM Identity Center configuration settings for a domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **AutoTuneOptions** *(dict) --* Container for Auto-Tune settings for the domain. * **Options** *(dict) --* Auto-Tune settings for updating a domain. * **DesiredState** *(string) --* Whether Auto-Tune is enabled or disabled. * **RollbackOnDisable** *(string) --* When disabling Auto-Tune, specify "NO_ROLLBACK" to retain all prior Auto-Tune settings or "DEFAULT_ROLLBACK" to revert to the OpenSearch Service defaults. If you specify "DEFAULT_ROLLBACK", you must include a "MaintenanceSchedule" in the request. Otherwise, OpenSearch Service is unable to perform the rollback. * **MaintenanceSchedules** *(list) --* DEPRECATED. Use off-peak window instead. A list of maintenance schedules during which Auto-Tune can deploy changes. * *(dict) --* Note: This object is deprecated. Use the domain's off- peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows. The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service. * **StartAt** *(datetime) --* The Epoch timestamp at which the Auto-Tune maintenance schedule starts. * **Duration** *(dict) --* The duration of the maintenance schedule. For example, ""Duration": {"Value": 2, "Unit": "HOURS"}". * **Value** *(integer) --* Integer to specify the value of a maintenance schedule duration. * **Unit** *(string) --* The unit of measurement for the duration of a maintenance schedule. * **CronExpressionForRecurrence** *(string) --* A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes. * **UseOffPeakWindow** *(boolean) --* Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule. * **Status** *(dict) --* The current status of Auto-Tune for a domain. * **CreationDate** *(datetime) --* Date and time when Auto-Tune was enabled for the domain. * **UpdateDate** *(datetime) --* Date and time when the Auto-Tune options were last updated for the domain. * **UpdateVersion** *(integer) --* The latest version of the Auto-Tune options. * **State** *(string) --* The current state of Auto-Tune on the domain. * **ErrorMessage** *(string) --* Any errors that occurred while enabling or disabling Auto-Tune. * **PendingDeletion** *(boolean) --* Indicates whether the domain is being deleted. * **ChangeProgressDetails** *(dict) --* Container for information about the progress of an existing configuration change. * **ChangeId** *(string) --* The ID of the configuration change. * **Message** *(string) --* A message corresponding to the status of the configuration change. * **ConfigChangeStatus** *(string) --* The current status of the configuration change. * **InitiatedBy** *(string) --* The IAM principal who initiated the configuration change. * **StartTime** *(datetime) --* The time that the configuration change was initiated, in Universal Coordinated Time (UTC). * **LastUpdatedTime** *(datetime) --* The last time that the configuration change was updated. * **OffPeakWindowOptions** *(dict) --* Container for off-peak window options for the domain. * **Options** *(dict) --* The domain's off-peak window configuration. * **Enabled** *(boolean) --* Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain. * **OffPeakWindow** *(dict) --* Off-peak window settings for the domain. * **WindowStartTime** *(dict) --* A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. * **Hours** *(integer) --* The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, "17" refers to 5:00 P.M. UTC. * **Minutes** *(integer) --* The start minute of the window, in UTC. * **Status** *(dict) --* The current status of off-peak window options. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **SoftwareUpdateOptions** *(dict) --* Software update options for the domain. * **Options** *(dict) --* The service software update options for a domain. * **AutoSoftwareUpdateEnabled** *(boolean) --* Whether automatic service software updates are enabled for the domain. * **Status** *(dict) --* The status of service software update options, including creation date and last updated date. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **ModifyingProperties** *(list) --* Information about the domain properties that are currently being modified. * *(dict) --* Information about the domain properties that are currently being modified. * **Name** *(string) --* The name of the property that is currently being modified. * **ActiveValue** *(string) --* The current value of the domain property that is being modified. * **PendingValue** *(string) --* The value that the property that is currently being modified will eventually have. * **ValueType** *(string) --* The type of value that is currently being modified. Properties can have two types: * "PLAIN_TEXT": Contain direct values such as "1", "True", or "c5.large.search". * "STRINGIFIED_JSON": Contain content in JSON format, such as {"Enabled":"True"}". * **AIMLOptions** *(dict) --* Container for parameters required to enable all machine learning features. * **Options** *(dict) --* Machine learning options on the specified domain. * **NaturalLanguageQueryGenerationOptions** *(dict) --* Container for parameters required for natural language query generation on the specified domain. * **DesiredState** *(string) --* The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED. * **CurrentState** *(string) --* The current state of the natural language query generation feature, indicating completion, in progress, or failure. * **S3VectorsEngine** *(dict) --* Container for parameters representing the state of S3 vectors engine features on the specified domain. * **Enabled** *(boolean) --* Enables S3 vectors engine features. * **Status** *(dict) --* Provides the current status of an entity. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **DryRunResults** *(dict) --* Results of the dry run performed in the update domain request. * **DeploymentType** *(string) --* Specifies the way in which OpenSearch Service will apply an update. Possible values are: * **Blue/Green** - The update requires a blue/green deployment. * **DynamicUpdate** - No blue/green deployment required * **Undetermined** - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete. * **None** - The request doesn't include any configuration changes. * **Message** *(string) --* A message corresponding to the deployment type. * **DryRunProgressStatus** *(dict) --* The status of the dry run being performed on the domain, if any. * **DryRunId** *(string) --* The unique identifier of the dry run. * **DryRunStatus** *(string) --* The current status of the dry run. * **CreationDate** *(string) --* The timestamp when the dry run was initiated. * **UpdateDate** *(string) --* The timestamp when the dry run was last updated. * **ValidationFailures** *(list) --* Any validation failures that occurred as a result of the dry run. * *(dict) --* A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain. * **Code** *(string) --* The error code of the failure. * **Message** *(string) --* A message corresponding to the failure. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.InvalidTypeException" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / update_package_scope update_package_scope ******************** OpenSearchService.Client.update_package_scope(**kwargs) Updates the scope of a package. Scope of the package defines users who can view and associate a package. See also: AWS API Documentation **Request Syntax** response = client.update_package_scope( PackageID='string', Operation='ADD'|'OVERRIDE'|'REMOVE', PackageUserList=[ 'string', ] ) Parameters: * **PackageID** (*string*) -- **[REQUIRED]** ID of the package whose scope is being updated. * **Operation** (*string*) -- **[REQUIRED]** The operation to perform on the package scope (e.g., add/remove/override users). * **PackageUserList** (*list*) -- **[REQUIRED]** List of users to be added or removed from the package scope. * *(string) --* Return type: dict Returns: **Response Syntax** { 'PackageID': 'string', 'Operation': 'ADD'|'OVERRIDE'|'REMOVE', 'PackageUserList': [ 'string', ] } **Response Structure** * *(dict) --* * **PackageID** *(string) --* ID of the package whose scope was updated. * **Operation** *(string) --* The operation that was performed on the package scope. * **PackageUserList** *(list) --* List of users who have access to the package after the scope update. * *(string) --* **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / list_vpc_endpoints list_vpc_endpoints ****************** OpenSearchService.Client.list_vpc_endpoints(**kwargs) Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region. See also: AWS API Documentation **Request Syntax** response = client.list_vpc_endpoints( NextToken='string' ) Parameters: **NextToken** (*string*) -- If your initial "ListVpcEndpoints" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListVpcEndpoints" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'VpcEndpointSummaryList': [ { 'VpcEndpointId': 'string', 'VpcEndpointOwner': 'string', 'DomainArn': 'string', 'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **VpcEndpointSummaryList** *(list) --* Information about each endpoint. * *(dict) --* Summary information for an Amazon OpenSearch Service- managed VPC endpoint. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcEndpointOwner** *(string) --* The creator of the endpoint. * **DomainArn** *(string) --* The Amazon Resource Name (ARN) of the domain associated with the endpoint. * **Status** *(string) --* The current status of the endpoint. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.BaseException" OpenSearchService / Client / list_direct_query_data_sources list_direct_query_data_sources ****************************** OpenSearchService.Client.list_direct_query_data_sources(**kwargs) Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.list_direct_query_data_sources( NextToken='string' ) Parameters: **NextToken** (*string*) -- When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'DirectQueryDataSources': [ { 'DataSourceName': 'string', 'DataSourceType': { 'CloudWatchLog': { 'RoleArn': 'string' }, 'SecurityLake': { 'RoleArn': 'string' } }, 'Description': 'string', 'OpenSearchArns': [ 'string', ], 'DataSourceArn': 'string', 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. * **DirectQueryDataSources** *(list) --* A list of the direct query data sources that are returned by the "ListDirectQueryDataSources" API operation. * *(dict) --* The configuration details for a data source that can be directly queried. * **DataSourceName** *(string) --* A unique, user-defined label to identify the data source within your OpenSearch Service environment. * **DataSourceType** *(dict) --* The supported Amazon Web Services service that is used as the source for direct queries in OpenSearch Service. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "CloudWatchLog", "SecurityLake". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **CloudWatchLog** *(dict) --* Specifies CloudWatch Logs as a type of data source for direct queries. * **RoleArn** *(string) --* The unique identifier of the IAM role that grants OpenSearch Service permission to access the specified data source. * **SecurityLake** *(dict) --* Specifies Security Lake as a type of data source for direct queries. * **RoleArn** *(string) --* The unique identifier of the IAM role that grants OpenSearch Service permission to access the specified data source. * **Description** *(string) --* A description that provides additional context and details about the data source. * **OpenSearchArns** *(list) --* A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. * *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **DataSourceArn** *(string) --* The unique, system-generated identifier that represents the data source. * **TagList** *(list) --* A list of tags attached to a direct query data source. * *(dict) --* A tag (key-value pair) for an Amazon OpenSearch Service resource. * **Key** *(string) --* The tag key. Tag keys must be unique for the domain to which they are attached. * **Value** *(string) --* The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / list_instance_type_details list_instance_type_details ************************** OpenSearchService.Client.list_instance_type_details(**kwargs) Lists all instance types and available features for a given OpenSearch or Elasticsearch version. See also: AWS API Documentation **Request Syntax** response = client.list_instance_type_details( EngineVersion='string', DomainName='string', MaxResults=123, NextToken='string', RetrieveAZs=True|False, InstanceType='string' ) Parameters: * **EngineVersion** (*string*) -- **[REQUIRED]** The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch. * **DomainName** (*string*) -- The name of the domain. * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "ListInstanceTypeDetails" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListInstanceTypeDetails" operations, which returns results in the next page. * **RetrieveAZs** (*boolean*) -- An optional parameter that specifies the Availability Zones for the domain. * **InstanceType** (*string*) -- An optional parameter that lists information for a given instance type. Return type: dict Returns: **Response Syntax** { 'InstanceTypeDetails': [ { 'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search', 'EncryptionEnabled': True|False, 'CognitoEnabled': True|False, 'AppLogsEnabled': True|False, 'AdvancedSecurityEnabled': True|False, 'WarmEnabled': True|False, 'InstanceRole': [ 'string', ], 'AvailabilityZones': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **InstanceTypeDetails** *(list) --* Lists all supported instance types and features for the given OpenSearch or Elasticsearch version. * *(dict) --* Lists all instance types and available features for a given OpenSearch or Elasticsearch version. * **InstanceType** *(string) --* The instance type. * **EncryptionEnabled** *(boolean) --* Whether encryption at rest and node-to-node encryption are supported for the instance type. * **CognitoEnabled** *(boolean) --* Whether Amazon Cognito access is supported for the instance type. * **AppLogsEnabled** *(boolean) --* Whether logging is supported for the instance type. * **AdvancedSecurityEnabled** *(boolean) --* Whether fine-grained access control is supported for the instance type. * **WarmEnabled** *(boolean) --* Whether UltraWarm is supported for the instance type. * **InstanceRole** *(list) --* Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node. * *(string) --* * **AvailabilityZones** *(list) --* The supported Availability Zones for the instance type. * *(string) --* * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / start_service_software_update start_service_software_update ***************************** OpenSearchService.Client.start_service_software_update(**kwargs) Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.start_service_software_update( DomainName='string', ScheduleAt='NOW'|'TIMESTAMP'|'OFF_PEAK_WINDOW', DesiredStartTime=123 ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain that you want to update to the latest service software. * **ScheduleAt** (*string*) -- When to start the service software update. * "NOW" - Immediately schedules the update to happen in the current hour if there's capacity available. * "TIMESTAMP" - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for "DesiredStartTime". * "OFF_PEAK_WINDOW" - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days. Default: "NOW" if you don't specify a value for "DesiredStartTime", and "TIMESTAMP" if you do. * **DesiredStartTime** (*integer*) -- The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set "ScheduleAt" to "TIMESTAMP". Return type: dict Returns: **Response Syntax** { 'ServiceSoftwareOptions': { 'CurrentVersion': 'string', 'NewVersion': 'string', 'UpdateAvailable': True|False, 'Cancellable': True|False, 'UpdateStatus': 'PENDING_UPDATE'|'IN_PROGRESS'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE', 'Description': 'string', 'AutomatedUpdateDate': datetime(2015, 1, 1), 'OptionalDeployment': True|False } } **Response Structure** * *(dict) --* Represents the output of a "StartServiceSoftwareUpdate" operation. Contains the status of the update. * **ServiceSoftwareOptions** *(dict) --* The current status of the OpenSearch Service software update. * **CurrentVersion** *(string) --* The current service software version present on the domain. * **NewVersion** *(string) --* The new service software version, if one is available. * **UpdateAvailable** *(boolean) --* True if you're able to update your service software version. False if you can't update your service software version. * **Cancellable** *(boolean) --* True if you're able to cancel your service software version update. False if you can't cancel your service software update. * **UpdateStatus** *(string) --* The status of your service software update. * **Description** *(string) --* A description of the service software update status. * **AutomatedUpdateDate** *(datetime) --* The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. * **OptionalDeployment** *(boolean) --* True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / update_application update_application ****************** OpenSearchService.Client.update_application(**kwargs) Updates the configuration and settings of an existing OpenSearch application. See also: AWS API Documentation **Request Syntax** response = client.update_application( id='string', dataSources=[ { 'dataSourceArn': 'string', 'dataSourceDescription': 'string' }, ], appConfigs=[ { 'key': 'opensearchDashboards.dashboardAdmin.users'|'opensearchDashboards.dashboardAdmin.groups', 'value': 'string' }, ] ) Parameters: * **id** (*string*) -- **[REQUIRED]** The unique identifier for the OpenSearch application to be updated. * **dataSources** (*list*) -- The data sources to associate with the OpenSearch application. * *(dict) --* Data sources that are associated with an OpenSearch application. * **dataSourceArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **dataSourceDescription** *(string) --* Detailed description of a data source. * **appConfigs** (*list*) -- The configuration settings to modify for the OpenSearch application. * *(dict) --* Configuration settings for an OpenSearch application. For more information, see see Using the OpenSearch user interface in Amazon OpenSearch Service. * **key** *(string) --* The configuration item to set, such as the admin role for the OpenSearch application. * **value** *(string) --* The value assigned to the configuration key, such as an IAM user ARN. Return type: dict Returns: **Response Syntax** { 'id': 'string', 'name': 'string', 'arn': 'string', 'dataSources': [ { 'dataSourceArn': 'string', 'dataSourceDescription': 'string' }, ], 'iamIdentityCenterOptions': { 'enabled': True|False, 'iamIdentityCenterInstanceArn': 'string', 'iamRoleForIdentityCenterApplicationArn': 'string', 'iamIdentityCenterApplicationArn': 'string' }, 'appConfigs': [ { 'key': 'opensearchDashboards.dashboardAdmin.users'|'opensearchDashboards.dashboardAdmin.groups', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **id** *(string) --* The unique identifier of the updated OpenSearch application. * **name** *(string) --* The name of the updated OpenSearch application. * **arn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **dataSources** *(list) --* The data sources associated with the updated OpenSearch application. * *(dict) --* Data sources that are associated with an OpenSearch application. * **dataSourceArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **dataSourceDescription** *(string) --* Detailed description of a data source. * **iamIdentityCenterOptions** *(dict) --* The IAM Identity Center configuration for the updated OpenSearch application. * **enabled** *(boolean) --* Indicates whether IAM Identity Center is enabled for the OpenSearch application. * **iamIdentityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **iamRoleForIdentityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch application. * **iamIdentityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **appConfigs** *(list) --* The configuration settings for the updated OpenSearch application. * *(dict) --* Configuration settings for an OpenSearch application. For more information, see see Using the OpenSearch user interface in Amazon OpenSearch Service. * **key** *(string) --* The configuration item to set, such as the admin role for the OpenSearch application. * **value** *(string) --* The value assigned to the configuration key, such as an IAM user ARN. * **createdAt** *(datetime) --* The timestamp when the OpenSearch application was originally created. * **lastUpdatedAt** *(datetime) --* The timestamp when the OpenSearch application was last updated. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ConflictException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / add_tags add_tags ******** OpenSearchService.Client.add_tags(**kwargs) Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application. Tags are a set of case-sensitive key-value pairs. A domain, data source, or application can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service resources. See also: AWS API Documentation **Request Syntax** response = client.add_tags( ARN='string', TagList=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ARN** (*string*) -- **[REQUIRED]** Amazon Resource Name (ARN) for the OpenSearch Service domain, data source, or application to which you want to attach resource tags. * **TagList** (*list*) -- **[REQUIRED]** List of resource tags. * *(dict) --* A tag (key-value pair) for an Amazon OpenSearch Service resource. * **Key** *(string) --* **[REQUIRED]** The tag key. Tag keys must be unique for the domain to which they are attached. * **Value** *(string) --* **[REQUIRED]** The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" Returns: None **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.InternalException" OpenSearchService / Client / add_direct_query_data_source add_direct_query_data_source **************************** OpenSearchService.Client.add_direct_query_data_source(**kwargs) Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data. See also: AWS API Documentation **Request Syntax** response = client.add_direct_query_data_source( DataSourceName='string', DataSourceType={ 'CloudWatchLog': { 'RoleArn': 'string' }, 'SecurityLake': { 'RoleArn': 'string' } }, Description='string', OpenSearchArns=[ 'string', ], TagList=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DataSourceName** (*string*) -- **[REQUIRED]** A unique, user-defined label to identify the data source within your OpenSearch Service environment. * **DataSourceType** (*dict*) -- **[REQUIRED]** The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "CloudWatchLog", "SecurityLake". * **CloudWatchLog** *(dict) --* Specifies CloudWatch Logs as a type of data source for direct queries. * **RoleArn** *(string) --* **[REQUIRED]** The unique identifier of the IAM role that grants OpenSearch Service permission to access the specified data source. * **SecurityLake** *(dict) --* Specifies Security Lake as a type of data source for direct queries. * **RoleArn** *(string) --* **[REQUIRED]** The unique identifier of the IAM role that grants OpenSearch Service permission to access the specified data source. * **Description** (*string*) -- An optional text field for providing additional context and details about the data source. * **OpenSearchArns** (*list*) -- **[REQUIRED]** A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source. * *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **TagList** (*list*) -- A list of tags attached to a domain. * *(dict) --* A tag (key-value pair) for an Amazon OpenSearch Service resource. * **Key** *(string) --* **[REQUIRED]** The tag key. Tag keys must be unique for the domain to which they are attached. * **Value** *(string) --* **[REQUIRED]** The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" Return type: dict Returns: **Response Syntax** { 'DataSourceArn': 'string' } **Response Structure** * *(dict) --* * **DataSourceArn** *(string) --* The unique, system-generated identifier that represents the data source. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.LimitExceededException" OpenSearchService / Client / dissociate_packages dissociate_packages ******************* OpenSearchService.Client.dissociate_packages(**kwargs) Dissociates multiple packages from a domain simulatneously. See also: AWS API Documentation **Request Syntax** response = client.dissociate_packages( PackageList=[ 'string', ], DomainName='string' ) Parameters: * **PackageList** (*list*) -- **[REQUIRED]** A list of package IDs to be dissociated from a domain. * *(string) --* * **DomainName** (*string*) -- **[REQUIRED]** The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region. Return type: dict Returns: **Response Syntax** { 'DomainPackageDetailsList': [ { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', 'LastUpdated': datetime(2015, 1, 1), 'DomainName': 'string', 'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED', 'PackageVersion': 'string', 'PrerequisitePackageIDList': [ 'string', ], 'ReferencePath': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'AssociationConfiguration': { 'KeyStoreAccessOption': { 'KeyAccessRoleArn': 'string', 'KeyStoreAccessEnabled': True|False } } }, ] } **Response Structure** * *(dict) --* * **DomainPackageDetailsList** *(list) --* A list of package details for the packages that were dissociated from the domain. * *(dict) --* Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service. * **PackageID** *(string) --* Internal ID of the package. * **PackageName** *(string) --* User-specified name of the package. * **PackageType** *(string) --* The type of package. * **LastUpdated** *(datetime) --* Timestamp of the most recent update to the package association status. * **DomainName** *(string) --* Name of the domain that the package is associated with. * **DomainPackageStatus** *(string) --* State of the association. * **PackageVersion** *(string) --* The current version of the package. * **PrerequisitePackageIDList** *(list) --* A list of package IDs that must be associated with the domain before or with the package can be associated. * *(string) --* * **ReferencePath** *(string) --* The relative path of the package on the OpenSearch Service cluster nodes. This is "synonym_path" when the package is for synonym files. * **ErrorDetails** *(dict) --* Additional information if the package is in an error state. Null otherwise. * **ErrorType** *(string) --* The type of error that occurred. * **ErrorMessage** *(string) --* A message describing the error. * **AssociationConfiguration** *(dict) --* The configuration for associating a package with an Amazon OpenSearch Service domain. * **KeyStoreAccessOption** *(dict) --* The configuration parameters to enable accessing the key store required by the package. * **KeyAccessRoleArn** *(string) --* Role ARN to access the KeyStore Key * **KeyStoreAccessEnabled** *(boolean) --* This indicates whether Key Store access is enabled **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.ConflictException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / dissociate_package dissociate_package ****************** OpenSearchService.Client.dissociate_package(**kwargs) Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.dissociate_package( PackageID='string', DomainName='string' ) Parameters: * **PackageID** (*string*) -- **[REQUIRED]** Internal ID of the package to dissociate from the domain. Use "ListPackagesForDomain" to find this value. * **DomainName** (*string*) -- **[REQUIRED]** Name of the domain to dissociate the package from. Return type: dict Returns: **Response Syntax** { 'DomainPackageDetails': { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', 'LastUpdated': datetime(2015, 1, 1), 'DomainName': 'string', 'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED', 'PackageVersion': 'string', 'PrerequisitePackageIDList': [ 'string', ], 'ReferencePath': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'AssociationConfiguration': { 'KeyStoreAccessOption': { 'KeyAccessRoleArn': 'string', 'KeyStoreAccessEnabled': True|False } } } } **Response Structure** * *(dict) --* Container for the response returned by an "DissociatePackage" operation. * **DomainPackageDetails** *(dict) --* Information about a package that has been dissociated from the domain. * **PackageID** *(string) --* Internal ID of the package. * **PackageName** *(string) --* User-specified name of the package. * **PackageType** *(string) --* The type of package. * **LastUpdated** *(datetime) --* Timestamp of the most recent update to the package association status. * **DomainName** *(string) --* Name of the domain that the package is associated with. * **DomainPackageStatus** *(string) --* State of the association. * **PackageVersion** *(string) --* The current version of the package. * **PrerequisitePackageIDList** *(list) --* A list of package IDs that must be associated with the domain before or with the package can be associated. * *(string) --* * **ReferencePath** *(string) --* The relative path of the package on the OpenSearch Service cluster nodes. This is "synonym_path" when the package is for synonym files. * **ErrorDetails** *(dict) --* Additional information if the package is in an error state. Null otherwise. * **ErrorType** *(string) --* The type of error that occurred. * **ErrorMessage** *(string) --* A message describing the error. * **AssociationConfiguration** *(dict) --* The configuration for associating a package with an Amazon OpenSearch Service domain. * **KeyStoreAccessOption** *(dict) --* The configuration parameters to enable accessing the key store required by the package. * **KeyAccessRoleArn** *(string) --* Role ARN to access the KeyStore Key * **KeyStoreAccessEnabled** *(boolean) --* This indicates whether Key Store access is enabled **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.ConflictException" OpenSearchService / Client / update_vpc_endpoint update_vpc_endpoint ******************* OpenSearchService.Client.update_vpc_endpoint(**kwargs) Modifies an Amazon OpenSearch Service-managed interface VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.update_vpc_endpoint( VpcEndpointId='string', VpcOptions={ 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] } ) Parameters: * **VpcEndpointId** (*string*) -- **[REQUIRED]** The unique identifier of the endpoint. * **VpcOptions** (*dict*) -- **[REQUIRED]** The security groups and/or subnets to add, remove, or modify. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC. * *(string) --* Return type: dict Returns: **Response Syntax** { 'VpcEndpoint': { 'VpcEndpointId': 'string', 'VpcEndpointOwner': 'string', 'DomainArn': 'string', 'VpcOptions': { 'VPCId': 'string', 'SubnetIds': [ 'string', ], 'AvailabilityZones': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, 'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED', 'Endpoint': 'string' } } **Response Structure** * *(dict) --* * **VpcEndpoint** *(dict) --* The endpoint to be updated. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcEndpointOwner** *(string) --* The creator of the endpoint. * **DomainArn** *(string) --* The Amazon Resource Name (ARN) of the domain associated with the endpoint. * **VpcOptions** *(dict) --* Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. * **VPCId** *(string) --* The ID for your VPC. Amazon VPC generates this value when you create a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. * *(string) --* * **AvailabilityZones** *(list) --* The list of Availability Zones associated with the VPC subnets. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. * *(string) --* * **Status** *(string) --* The current status of the endpoint. * **Endpoint** *(string) --* The connection endpoint ID for connecting to the domain. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.ConflictException" * "OpenSearchService.Client.exceptions.BaseException" OpenSearchService / Client / describe_domain_config describe_domain_config ********************** OpenSearchService.Client.describe_domain_config(**kwargs) Returns the configuration of an Amazon OpenSearch Service domain. See also: AWS API Documentation **Request Syntax** response = client.describe_domain_config( DomainName='string' ) Parameters: **DomainName** (*string*) -- **[REQUIRED]** Name of the OpenSearch Service domain configuration that you want to describe. Return type: dict Returns: **Response Syntax** { 'DomainConfig': { 'EngineVersion': { 'Options': 'string', 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'ClusterConfig': { 'Options': { 'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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 }, 'MultiAZWithStandbyEnabled': True|False, 'NodeOptions': [ { 'NodeType': 'coordinator', 'NodeConfig': { 'Enabled': True|False, 'Type': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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', 'Count': 123 } }, ] }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'EBSOptions': { 'Options': { 'EBSEnabled': True|False, 'VolumeType': 'standard'|'gp2'|'io1'|'gp3', 'VolumeSize': 123, 'Iops': 123, 'Throughput': 123 }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'AccessPolicies': { 'Options': 'string', 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'IPAddressType': { 'Options': 'ipv4'|'dualstack', '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'|'Policy-Min-TLS-1-2-PFS-2023-10', '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 }, 'JWTOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string', 'PublicKey': 'string' }, 'IAMFederationOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string' }, '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 } }, 'IdentityCenterOptions': { 'Options': { 'EnabledAPIAccess': True|False, 'IdentityCenterInstanceARN': 'string', 'SubjectKey': 'UserName'|'UserId'|'Email', 'RolesKey': 'GroupName'|'GroupId', 'IdentityCenterApplicationARN': 'string', 'IdentityStoreId': 'string' }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'AutoTuneOptions': { 'Options': { 'DesiredState': 'ENABLED'|'DISABLED', 'RollbackOnDisable': 'NO_ROLLBACK'|'DEFAULT_ROLLBACK', 'MaintenanceSchedules': [ { 'StartAt': datetime(2015, 1, 1), 'Duration': { 'Value': 123, 'Unit': 'HOURS' }, 'CronExpressionForRecurrence': 'string' }, ], 'UseOffPeakWindow': True|False }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR', 'ErrorMessage': 'string', 'PendingDeletion': True|False } }, 'ChangeProgressDetails': { 'ChangeId': 'string', 'Message': 'string', 'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled', 'InitiatedBy': 'CUSTOMER'|'SERVICE', 'StartTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, 'OffPeakWindowOptions': { 'Options': { 'Enabled': True|False, 'OffPeakWindow': { 'WindowStartTime': { 'Hours': 123, 'Minutes': 123 } } }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'SoftwareUpdateOptions': { 'Options': { 'AutoSoftwareUpdateEnabled': True|False }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } }, 'ModifyingProperties': [ { 'Name': 'string', 'ActiveValue': 'string', 'PendingValue': 'string', 'ValueType': 'PLAIN_TEXT'|'STRINGIFIED_JSON' }, ], 'AIMLOptions': { 'Options': { 'NaturalLanguageQueryGenerationOptions': { 'DesiredState': 'ENABLED'|'DISABLED', 'CurrentState': 'NOT_ENABLED'|'ENABLE_COMPLETE'|'ENABLE_IN_PROGRESS'|'ENABLE_FAILED'|'DISABLE_COMPLETE'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED' }, 'S3VectorsEngine': { 'Enabled': True|False } }, 'Status': { 'CreationDate': datetime(2015, 1, 1), 'UpdateDate': datetime(2015, 1, 1), 'UpdateVersion': 123, 'State': 'RequiresIndexDocuments'|'Processing'|'Active', 'PendingDeletion': True|False } } } } **Response Structure** * *(dict) --* Contains the configuration information of the requested domain. * **DomainConfig** *(dict) --* Container for the configuration of the OpenSearch Service domain. * **EngineVersion** *(dict) --* The OpenSearch or Elasticsearch version that the domain is running. * **Options** *(string) --* The OpenSearch or Elasticsearch version for the specified domain. * **Status** *(dict) --* The status of the version options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **ClusterConfig** *(dict) --* Container for the cluster configuration of a the domain. * **Options** *(dict) --* Cluster configuration options for the specified domain. * **InstanceType** *(string) --* Instance type of data nodes in the cluster. * **InstanceCount** *(integer) --* Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. * **DedicatedMasterEnabled** *(boolean) --* Indicates whether dedicated master nodes are enabled for the cluster. "True" if the cluster will use a dedicated master node. "False" if the cluster will not. * **ZoneAwarenessEnabled** *(boolean) --* Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **ZoneAwarenessConfig** *(dict) --* Container for zone awareness configuration options. Only required if "ZoneAwarenessEnabled" is "true". * **AvailabilityZoneCount** *(integer) --* If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are "2" and "3". If your domain is provisioned within a VPC, this value be equal to number of subnets. * **DedicatedMasterType** *(string) --* OpenSearch Service instance type of the dedicated master nodes in the cluster. * **DedicatedMasterCount** *(integer) --* Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. * **WarmEnabled** *(boolean) --* Whether to enable warm storage for the cluster. * **WarmType** *(string) --* The instance type for the cluster's warm nodes. * **WarmCount** *(integer) --* The number of warm nodes in the cluster. * **ColdStorageOptions** *(dict) --* Container for cold storage configuration options. * **Enabled** *(boolean) --* Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. * **MultiAZWithStandbyEnabled** *(boolean) --* A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **NodeOptions** *(list) --* List of node options for the domain. * *(dict) --* Configuration settings for defining the node type within a cluster. * **NodeType** *(string) --* Defines the type of node, such as coordinating nodes. * **NodeConfig** *(dict) --* Configuration options for defining the setup of any node type. * **Enabled** *(boolean) --* A boolean value indicating whether a specific node type is active or inactive. * **Type** *(string) --* The instance type of a particular node within the cluster. * **Count** *(integer) --* The number of nodes of a specific type within the cluster. * **Status** *(dict) --* The status of cluster configuration options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **EBSOptions** *(dict) --* Container for EBS options configured for the domain. * **Options** *(dict) --* The configured EBS options for the specified domain. * **EBSEnabled** *(boolean) --* Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. * **VolumeType** *(string) --* Specifies the type of EBS volumes attached to data nodes. * **VolumeSize** *(integer) --* Specifies the size (in GiB) of EBS volumes attached to data nodes. * **Iops** *(integer) --* Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the "gp3" and provisioned IOPS EBS volume types. * **Throughput** *(integer) --* Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the "gp3" volume type. * **Status** *(dict) --* The status of the EBS options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **AccessPolicies** *(dict) --* Specifies the access policies for the domain. * **Options** *(string) --* The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies. * **Status** *(dict) --* The status of the access policy for the domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **IPAddressType** *(dict) --* Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later. * **Options** *(string) --* The IP address options for the domain. * **Status** *(dict) --* Provides the current status of an entity. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **SnapshotOptions** *(dict) --* DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes. * **Options** *(dict) --* The daily snapshot options specified for the domain. * **AutomatedSnapshotStartHour** *(integer) --* The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is "0" hours. * **Status** *(dict) --* The status of a daily automated snapshot. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **VPCOptions** *(dict) --* The current VPC options for the domain and the status of any updates to their configuration. * **Options** *(dict) --* The VPC options for the specified domain. * **VPCId** *(string) --* The ID for your VPC. Amazon VPC generates this value when you create a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. * *(string) --* * **AvailabilityZones** *(list) --* The list of Availability Zones associated with the VPC subnets. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. * *(string) --* * **Status** *(dict) --* The status of the VPC options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **CognitoOptions** *(dict) --* Container for Amazon Cognito options for the domain. * **Options** *(dict) --* Cognito options for the specified domain. * **Enabled** *(boolean) --* Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. * **UserPoolId** *(string) --* The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **IdentityPoolId** *(string) --* The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **RoleArn** *(string) --* The "AmazonOpenSearchServiceCognitoAccess" role that allows OpenSearch Service to configure your user pool and identity pool. * **Status** *(dict) --* The status of the Cognito options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **EncryptionAtRestOptions** *(dict) --* Key-value pairs to enable encryption at rest. * **Options** *(dict) --* Encryption at rest options for the specified domain. * **Enabled** *(boolean) --* True to enable encryption at rest. * **KmsKeyId** *(string) --* The KMS key ID. Takes the form "1a2a3a4-1a2a-3a4a- 5a6a-1a2a3a4a5a6a". * **Status** *(dict) --* The status of the encryption at rest options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **NodeToNodeEncryptionOptions** *(dict) --* Whether node-to-node encryption is enabled or disabled. * **Options** *(dict) --* The node-to-node encryption options for the specified domain. * **Enabled** *(boolean) --* True to enable node-to-node encryption. * **Status** *(dict) --* The status of the node-to-node encryption options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **AdvancedOptions** *(dict) --* Key-value pairs to specify advanced configuration options. For more information, see Advanced options. * **Options** *(dict) --* The status of advanced options for the specified domain. * *(string) --* * *(string) --* * **Status** *(dict) --* The status of advanced options for the specified domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **LogPublishingOptions** *(dict) --* Key-value pairs to configure log publishing. * **Options** *(dict) --* The log publishing options configured for the domain. * *(string) --* The type of log file. Can be one of the following: * **INDEX_SLOW_LOGS** - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute. * **SEARCH_SLOW_LOGS** - Search slow logs contain search queries that took more time than the configured search query log threshold to execute. * **ES_APPLICATION_LOGS** - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting. * **AUDIT_LOGS** - Audit logs contain records of user requests for access to the domain. * *(dict) --* Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs. Note: After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. * **Enabled** *(boolean) --* Whether the log should be published. * **Status** *(dict) --* The status of the log publishing options for the domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **DomainEndpointOptions** *(dict) --* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. * **Options** *(dict) --* Options to configure the endpoint for a domain. * **EnforceHTTPS** *(boolean) --* True to require that all traffic to the domain arrive over HTTPS. * **TLSSecurityPolicy** *(string) --* Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports TLS version 1.0 to TLS version 1.2 * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports only TLS version 1.2 * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites * **CustomEndpointEnabled** *(boolean) --* Whether to enable a custom endpoint for the domain. * **CustomEndpoint** *(string) --* The fully qualified URL for the custom endpoint. * **CustomEndpointCertificateArn** *(string) --* The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). * **Status** *(dict) --* The status of the endpoint options for a domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **AdvancedSecurityOptions** *(dict) --* Container for fine-grained access control settings for the domain. * **Options** *(dict) --* Container for fine-grained access control settings. * **Enabled** *(boolean) --* True if fine-grained access control is enabled. * **InternalUserDatabaseEnabled** *(boolean) --* True if the internal user database is enabled. * **SAMLOptions** *(dict) --* Container for information about the SAML configuration for OpenSearch Dashboards. * **Enabled** *(boolean) --* True if SAML is enabled. * **Idp** *(dict) --* Describes the SAML identity provider's information. * **MetadataContent** *(string) --* The metadata of the SAML application, in XML format. * **EntityId** *(string) --* The unique entity ID of the application in the SAML identity provider. * **SubjectKey** *(string) --* The key used for matching the SAML subject attribute. * **RolesKey** *(string) --* The key used for matching the SAML roles attribute. * **SessionTimeoutMinutes** *(integer) --* The duration, in minutes, after which a user session becomes inactive. * **JWTOptions** *(dict) --* Container for information about the JWT configuration of the Amazon OpenSearch Service. * **Enabled** *(boolean) --* True if JWT use is enabled. * **SubjectKey** *(string) --* The key used for matching the JWT subject attribute. * **RolesKey** *(string) --* The key used for matching the JWT roles attribute. * **PublicKey** *(string) --* The key used to verify the signature of incoming JWT requests. * **IAMFederationOptions** *(dict) --* Container for information about the IAM federation configuration for an OpenSearch UI application. * **Enabled** *(boolean) --* True if IAM federation is enabled. * **SubjectKey** *(string) --* The key used for matching the IAM federation subject attribute. * **RolesKey** *(string) --* The key used for matching the IAM federation roles attribute. * **AnonymousAuthDisableDate** *(datetime) --* Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain. * **AnonymousAuthEnabled** *(boolean) --* True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. * **Status** *(dict) --* Status of the fine-grained access control settings for a domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **IdentityCenterOptions** *(dict) --* Configuration options for enabling and managing IAM Identity Center integration within a domain. * **Options** *(dict) --* Configuration settings for IAM Identity Center integration. * **EnabledAPIAccess** *(boolean) --* Indicates whether IAM Identity Center is enabled for the application. * **IdentityCenterInstanceARN** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center instance. * **SubjectKey** *(string) --* Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center. * **RolesKey** *(string) --* Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center. * **IdentityCenterApplicationARN** *(string) --* The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service. * **IdentityStoreId** *(string) --* The identifier of the IAM Identity Store. * **Status** *(dict) --* The status of IAM Identity Center configuration settings for a domain. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **AutoTuneOptions** *(dict) --* Container for Auto-Tune settings for the domain. * **Options** *(dict) --* Auto-Tune settings for updating a domain. * **DesiredState** *(string) --* Whether Auto-Tune is enabled or disabled. * **RollbackOnDisable** *(string) --* When disabling Auto-Tune, specify "NO_ROLLBACK" to retain all prior Auto-Tune settings or "DEFAULT_ROLLBACK" to revert to the OpenSearch Service defaults. If you specify "DEFAULT_ROLLBACK", you must include a "MaintenanceSchedule" in the request. Otherwise, OpenSearch Service is unable to perform the rollback. * **MaintenanceSchedules** *(list) --* DEPRECATED. Use off-peak window instead. A list of maintenance schedules during which Auto-Tune can deploy changes. * *(dict) --* Note: This object is deprecated. Use the domain's off- peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows. The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service. * **StartAt** *(datetime) --* The Epoch timestamp at which the Auto-Tune maintenance schedule starts. * **Duration** *(dict) --* The duration of the maintenance schedule. For example, ""Duration": {"Value": 2, "Unit": "HOURS"}". * **Value** *(integer) --* Integer to specify the value of a maintenance schedule duration. * **Unit** *(string) --* The unit of measurement for the duration of a maintenance schedule. * **CronExpressionForRecurrence** *(string) --* A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes. * **UseOffPeakWindow** *(boolean) --* Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule. * **Status** *(dict) --* The current status of Auto-Tune for a domain. * **CreationDate** *(datetime) --* Date and time when Auto-Tune was enabled for the domain. * **UpdateDate** *(datetime) --* Date and time when the Auto-Tune options were last updated for the domain. * **UpdateVersion** *(integer) --* The latest version of the Auto-Tune options. * **State** *(string) --* The current state of Auto-Tune on the domain. * **ErrorMessage** *(string) --* Any errors that occurred while enabling or disabling Auto-Tune. * **PendingDeletion** *(boolean) --* Indicates whether the domain is being deleted. * **ChangeProgressDetails** *(dict) --* Container for information about the progress of an existing configuration change. * **ChangeId** *(string) --* The ID of the configuration change. * **Message** *(string) --* A message corresponding to the status of the configuration change. * **ConfigChangeStatus** *(string) --* The current status of the configuration change. * **InitiatedBy** *(string) --* The IAM principal who initiated the configuration change. * **StartTime** *(datetime) --* The time that the configuration change was initiated, in Universal Coordinated Time (UTC). * **LastUpdatedTime** *(datetime) --* The last time that the configuration change was updated. * **OffPeakWindowOptions** *(dict) --* Container for off-peak window options for the domain. * **Options** *(dict) --* The domain's off-peak window configuration. * **Enabled** *(boolean) --* Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain. * **OffPeakWindow** *(dict) --* Off-peak window settings for the domain. * **WindowStartTime** *(dict) --* A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. * **Hours** *(integer) --* The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, "17" refers to 5:00 P.M. UTC. * **Minutes** *(integer) --* The start minute of the window, in UTC. * **Status** *(dict) --* The current status of off-peak window options. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **SoftwareUpdateOptions** *(dict) --* Software update options for the domain. * **Options** *(dict) --* The service software update options for a domain. * **AutoSoftwareUpdateEnabled** *(boolean) --* Whether automatic service software updates are enabled for the domain. * **Status** *(dict) --* The status of service software update options, including creation date and last updated date. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. * **ModifyingProperties** *(list) --* Information about the domain properties that are currently being modified. * *(dict) --* Information about the domain properties that are currently being modified. * **Name** *(string) --* The name of the property that is currently being modified. * **ActiveValue** *(string) --* The current value of the domain property that is being modified. * **PendingValue** *(string) --* The value that the property that is currently being modified will eventually have. * **ValueType** *(string) --* The type of value that is currently being modified. Properties can have two types: * "PLAIN_TEXT": Contain direct values such as "1", "True", or "c5.large.search". * "STRINGIFIED_JSON": Contain content in JSON format, such as {"Enabled":"True"}". * **AIMLOptions** *(dict) --* Container for parameters required to enable all machine learning features. * **Options** *(dict) --* Machine learning options on the specified domain. * **NaturalLanguageQueryGenerationOptions** *(dict) --* Container for parameters required for natural language query generation on the specified domain. * **DesiredState** *(string) --* The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED. * **CurrentState** *(string) --* The current state of the natural language query generation feature, indicating completion, in progress, or failure. * **S3VectorsEngine** *(dict) --* Container for parameters representing the state of S3 vectors engine features on the specified domain. * **Enabled** *(boolean) --* Enables S3 vectors engine features. * **Status** *(dict) --* Provides the current status of an entity. * **CreationDate** *(datetime) --* The timestamp when the entity was created. * **UpdateDate** *(datetime) --* The timestamp of the last time the entity was updated. * **UpdateVersion** *(integer) --* The latest version of the entity. * **State** *(string) --* The state of the entity. * **PendingDeletion** *(boolean) --* Indicates whether the entity is being deleted. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / describe_dry_run_progress describe_dry_run_progress ************************* OpenSearchService.Client.describe_dry_run_progress(**kwargs) Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment. See also: AWS API Documentation **Request Syntax** response = client.describe_dry_run_progress( DomainName='string', DryRunId='string', LoadDryRunConfig=True|False ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. * **DryRunId** (*string*) -- The unique identifier of the dry run. * **LoadDryRunConfig** (*boolean*) -- Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make on the domain. Return type: dict Returns: **Response Syntax** { 'DryRunProgressStatus': { 'DryRunId': 'string', 'DryRunStatus': 'string', 'CreationDate': 'string', 'UpdateDate': 'string', 'ValidationFailures': [ { 'Code': 'string', 'Message': 'string' }, ] }, 'DryRunConfig': { 'DomainId': 'string', 'DomainName': 'string', 'ARN': 'string', 'Created': True|False, 'Deleted': True|False, 'Endpoint': 'string', 'EndpointV2': 'string', 'Endpoints': { 'string': 'string' }, 'DomainEndpointV2HostedZoneId': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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 }, 'MultiAZWithStandbyEnabled': True|False, 'NodeOptions': [ { 'NodeType': 'coordinator', 'NodeConfig': { 'Enabled': True|False, 'Type': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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', 'Count': 123 } }, ] }, 'EBSOptions': { 'EBSEnabled': True|False, 'VolumeType': 'standard'|'gp2'|'io1'|'gp3', 'VolumeSize': 123, 'Iops': 123, 'Throughput': 123 }, 'AccessPolicies': 'string', 'IPAddressType': 'ipv4'|'dualstack', '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'|'Policy-Min-TLS-1-2-PFS-2023-10', '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 }, 'JWTOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string', 'PublicKey': 'string' }, 'IAMFederationOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string' }, 'AnonymousAuthDisableDate': datetime(2015, 1, 1), 'AnonymousAuthEnabled': True|False }, 'IdentityCenterOptions': { 'EnabledAPIAccess': True|False, 'IdentityCenterInstanceARN': 'string', 'SubjectKey': 'UserName'|'UserId'|'Email', 'RolesKey': 'GroupName'|'GroupId', 'IdentityCenterApplicationARN': 'string', 'IdentityStoreId': 'string' }, 'AutoTuneOptions': { 'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR', 'ErrorMessage': 'string', 'UseOffPeakWindow': True|False }, 'ChangeProgressDetails': { 'ChangeId': 'string', 'Message': 'string', 'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled', 'InitiatedBy': 'CUSTOMER'|'SERVICE', 'StartTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, 'OffPeakWindowOptions': { 'Enabled': True|False, 'OffPeakWindow': { 'WindowStartTime': { 'Hours': 123, 'Minutes': 123 } } }, 'SoftwareUpdateOptions': { 'AutoSoftwareUpdateEnabled': True|False }, 'DomainProcessingStatus': 'Creating'|'Active'|'Modifying'|'UpgradingEngineVersion'|'UpdatingServiceSoftware'|'Isolated'|'Deleting', 'ModifyingProperties': [ { 'Name': 'string', 'ActiveValue': 'string', 'PendingValue': 'string', 'ValueType': 'PLAIN_TEXT'|'STRINGIFIED_JSON' }, ], 'AIMLOptions': { 'NaturalLanguageQueryGenerationOptions': { 'DesiredState': 'ENABLED'|'DISABLED', 'CurrentState': 'NOT_ENABLED'|'ENABLE_COMPLETE'|'ENABLE_IN_PROGRESS'|'ENABLE_FAILED'|'DISABLE_COMPLETE'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED' }, 'S3VectorsEngine': { 'Enabled': True|False } } }, 'DryRunResults': { 'DeploymentType': 'string', 'Message': 'string' } } **Response Structure** * *(dict) --* * **DryRunProgressStatus** *(dict) --* The current status of the dry run, including any validation errors. * **DryRunId** *(string) --* The unique identifier of the dry run. * **DryRunStatus** *(string) --* The current status of the dry run. * **CreationDate** *(string) --* The timestamp when the dry run was initiated. * **UpdateDate** *(string) --* The timestamp when the dry run was last updated. * **ValidationFailures** *(list) --* Any validation failures that occurred as a result of the dry run. * *(dict) --* A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain. * **Code** *(string) --* The error code of the failure. * **Message** *(string) --* A message corresponding to the failure. * **DryRunConfig** *(dict) --* Details about the changes you're planning to make on the domain. * **DomainId** *(string) --* Unique identifier for the domain. * **DomainName** *(string) --* Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the *AWS Identity and Access Management User Guide*. * **Created** *(boolean) --* Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress. * **Deleted** *(boolean) --* Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned. * **Endpoint** *(string) --* Domain-specific endpoint used to submit index, search, and data upload requests to the domain. * **EndpointV2** *(string) --* If "IPAddressType" to set to "dualstack", a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. * **Endpoints** *(dict) --* The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example: * **IPv4 IP addresses** - "'vpc','vpc-endpoint- h2dsd34efgyghrtguk5gt6j2foh4.us- east-1.es.amazonaws.com'" * **Dual stack IP addresses** - "'vpcv2':'vpc-endpoint- h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'" * *(string) --* * *(string) --* The domain endpoint to which index and search requests are submitted. For example, "search-imdb-movies- oopcnjfn6ugo.eu-west-1.es.amazonaws.com" or "doc-imdb- movies-oopcnjfn6u.eu-west-1.es.amazonaws.com". * **DomainEndpointV2HostedZoneId** *(string) --* The dual stack hosted zone ID for the domain. * **Processing** *(boolean) --* The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active. * **UpgradeProcessing** *(boolean) --* The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active. * **EngineVersion** *(string) --* Version of OpenSearch or Elasticsearch that the domain is running, in the format "Elasticsearch_X.Y" or "OpenSearch_X.Y". * **ClusterConfig** *(dict) --* Container for the cluster configuration of the domain. * **InstanceType** *(string) --* Instance type of data nodes in the cluster. * **InstanceCount** *(integer) --* Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. * **DedicatedMasterEnabled** *(boolean) --* Indicates whether dedicated master nodes are enabled for the cluster. "True" if the cluster will use a dedicated master node. "False" if the cluster will not. * **ZoneAwarenessEnabled** *(boolean) --* Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi- AZ domain in Amazon OpenSearch Service. * **ZoneAwarenessConfig** *(dict) --* Container for zone awareness configuration options. Only required if "ZoneAwarenessEnabled" is "true". * **AvailabilityZoneCount** *(integer) --* If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are "2" and "3". If your domain is provisioned within a VPC, this value be equal to number of subnets. * **DedicatedMasterType** *(string) --* OpenSearch Service instance type of the dedicated master nodes in the cluster. * **DedicatedMasterCount** *(integer) --* Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. * **WarmEnabled** *(boolean) --* Whether to enable warm storage for the cluster. * **WarmType** *(string) --* The instance type for the cluster's warm nodes. * **WarmCount** *(integer) --* The number of warm nodes in the cluster. * **ColdStorageOptions** *(dict) --* Container for cold storage configuration options. * **Enabled** *(boolean) --* Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. * **MultiAZWithStandbyEnabled** *(boolean) --* A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **NodeOptions** *(list) --* List of node options for the domain. * *(dict) --* Configuration settings for defining the node type within a cluster. * **NodeType** *(string) --* Defines the type of node, such as coordinating nodes. * **NodeConfig** *(dict) --* Configuration options for defining the setup of any node type. * **Enabled** *(boolean) --* A boolean value indicating whether a specific node type is active or inactive. * **Type** *(string) --* The instance type of a particular node within the cluster. * **Count** *(integer) --* The number of nodes of a specific type within the cluster. * **EBSOptions** *(dict) --* Container for EBS-based storage settings for the domain. * **EBSEnabled** *(boolean) --* Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. * **VolumeType** *(string) --* Specifies the type of EBS volumes attached to data nodes. * **VolumeSize** *(integer) --* Specifies the size (in GiB) of EBS volumes attached to data nodes. * **Iops** *(integer) --* Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the "gp3" and provisioned IOPS EBS volume types. * **Throughput** *(integer) --* Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the "gp3" volume type. * **AccessPolicies** *(string) --* Identity and Access Management (IAM) policy document specifying the access policies for the domain. * **IPAddressType** *(string) --* The type of IP addresses supported by the endpoint for the domain. * **SnapshotOptions** *(dict) --* DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes. * **AutomatedSnapshotStartHour** *(integer) --* The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is "0" hours. * **VPCOptions** *(dict) --* The VPC configuration for the domain. * **VPCId** *(string) --* The ID for your VPC. Amazon VPC generates this value when you create a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. * *(string) --* * **AvailabilityZones** *(list) --* The list of Availability Zones associated with the VPC subnets. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. * *(string) --* * **CognitoOptions** *(dict) --* Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards. * **Enabled** *(boolean) --* Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. * **UserPoolId** *(string) --* The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **IdentityPoolId** *(string) --* The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **RoleArn** *(string) --* The "AmazonOpenSearchServiceCognitoAccess" role that allows OpenSearch Service to configure your user pool and identity pool. * **EncryptionAtRestOptions** *(dict) --* Encryption at rest settings for the domain. * **Enabled** *(boolean) --* True to enable encryption at rest. * **KmsKeyId** *(string) --* The KMS key ID. Takes the form "1a2a3a4-1a2a-3a4a-5a6a- 1a2a3a4a5a6a". * **NodeToNodeEncryptionOptions** *(dict) --* Whether node-to-node encryption is enabled or disabled. * **Enabled** *(boolean) --* True to enable node-to-node encryption. * **AdvancedOptions** *(dict) --* Key-value pairs that specify advanced configuration options. * *(string) --* * *(string) --* * **LogPublishingOptions** *(dict) --* Log publishing options for the domain. * *(string) --* The type of log file. Can be one of the following: * **INDEX_SLOW_LOGS** - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute. * **SEARCH_SLOW_LOGS** - Search slow logs contain search queries that took more time than the configured search query log threshold to execute. * **ES_APPLICATION_LOGS** - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting. * **AUDIT_LOGS** - Audit logs contain records of user requests for access to the domain. * *(dict) --* Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs. Note: After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. * **Enabled** *(boolean) --* Whether the log should be published. * **ServiceSoftwareOptions** *(dict) --* The current status of the domain's service software. * **CurrentVersion** *(string) --* The current service software version present on the domain. * **NewVersion** *(string) --* The new service software version, if one is available. * **UpdateAvailable** *(boolean) --* True if you're able to update your service software version. False if you can't update your service software version. * **Cancellable** *(boolean) --* True if you're able to cancel your service software version update. False if you can't cancel your service software update. * **UpdateStatus** *(string) --* The status of your service software update. * **Description** *(string) --* A description of the service software update status. * **AutomatedUpdateDate** *(datetime) --* The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. * **OptionalDeployment** *(boolean) --* True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date. * **DomainEndpointOptions** *(dict) --* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. * **EnforceHTTPS** *(boolean) --* True to require that all traffic to the domain arrive over HTTPS. * **TLSSecurityPolicy** *(string) --* Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports TLS version 1.0 to TLS version 1.2 * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports only TLS version 1.2 * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites * **CustomEndpointEnabled** *(boolean) --* Whether to enable a custom endpoint for the domain. * **CustomEndpoint** *(string) --* The fully qualified URL for the custom endpoint. * **CustomEndpointCertificateArn** *(string) --* The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). * **AdvancedSecurityOptions** *(dict) --* Settings for fine-grained access control. * **Enabled** *(boolean) --* True if fine-grained access control is enabled. * **InternalUserDatabaseEnabled** *(boolean) --* True if the internal user database is enabled. * **SAMLOptions** *(dict) --* Container for information about the SAML configuration for OpenSearch Dashboards. * **Enabled** *(boolean) --* True if SAML is enabled. * **Idp** *(dict) --* Describes the SAML identity provider's information. * **MetadataContent** *(string) --* The metadata of the SAML application, in XML format. * **EntityId** *(string) --* The unique entity ID of the application in the SAML identity provider. * **SubjectKey** *(string) --* The key used for matching the SAML subject attribute. * **RolesKey** *(string) --* The key used for matching the SAML roles attribute. * **SessionTimeoutMinutes** *(integer) --* The duration, in minutes, after which a user session becomes inactive. * **JWTOptions** *(dict) --* Container for information about the JWT configuration of the Amazon OpenSearch Service. * **Enabled** *(boolean) --* True if JWT use is enabled. * **SubjectKey** *(string) --* The key used for matching the JWT subject attribute. * **RolesKey** *(string) --* The key used for matching the JWT roles attribute. * **PublicKey** *(string) --* The key used to verify the signature of incoming JWT requests. * **IAMFederationOptions** *(dict) --* Container for information about the IAM federation configuration for an OpenSearch UI application. * **Enabled** *(boolean) --* True if IAM federation is enabled. * **SubjectKey** *(string) --* The key used for matching the IAM federation subject attribute. * **RolesKey** *(string) --* The key used for matching the IAM federation roles attribute. * **AnonymousAuthDisableDate** *(datetime) --* Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain. * **AnonymousAuthEnabled** *(boolean) --* True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. * **IdentityCenterOptions** *(dict) --* Configuration options for controlling IAM Identity Center integration within a domain. * **EnabledAPIAccess** *(boolean) --* Indicates whether IAM Identity Center is enabled for the application. * **IdentityCenterInstanceARN** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center instance. * **SubjectKey** *(string) --* Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center. * **RolesKey** *(string) --* Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center. * **IdentityCenterApplicationARN** *(string) --* The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service. * **IdentityStoreId** *(string) --* The identifier of the IAM Identity Store. * **AutoTuneOptions** *(dict) --* Auto-Tune settings for the domain. * **State** *(string) --* The current state of Auto-Tune on the domain. * **ErrorMessage** *(string) --* Any errors that occurred while enabling or disabling Auto-Tune. * **UseOffPeakWindow** *(boolean) --* Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule. * **ChangeProgressDetails** *(dict) --* Information about a configuration change happening on the domain. * **ChangeId** *(string) --* The ID of the configuration change. * **Message** *(string) --* A message corresponding to the status of the configuration change. * **ConfigChangeStatus** *(string) --* The current status of the configuration change. * **InitiatedBy** *(string) --* The IAM principal who initiated the configuration change. * **StartTime** *(datetime) --* The time that the configuration change was initiated, in Universal Coordinated Time (UTC). * **LastUpdatedTime** *(datetime) --* The last time that the configuration change was updated. * **OffPeakWindowOptions** *(dict) --* Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain. * **Enabled** *(boolean) --* Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain. * **OffPeakWindow** *(dict) --* Off-peak window settings for the domain. * **WindowStartTime** *(dict) --* A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. * **Hours** *(integer) --* The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, "17" refers to 5:00 P.M. UTC. * **Minutes** *(integer) --* The start minute of the window, in UTC. * **SoftwareUpdateOptions** *(dict) --* Service software update options for the domain. * **AutoSoftwareUpdateEnabled** *(boolean) --* Whether automatic service software updates are enabled for the domain. * **DomainProcessingStatus** *(string) --* The status of any changes that are currently in progress for the domain. * **ModifyingProperties** *(list) --* Information about the domain properties that are currently being modified. * *(dict) --* Information about the domain properties that are currently being modified. * **Name** *(string) --* The name of the property that is currently being modified. * **ActiveValue** *(string) --* The current value of the domain property that is being modified. * **PendingValue** *(string) --* The value that the property that is currently being modified will eventually have. * **ValueType** *(string) --* The type of value that is currently being modified. Properties can have two types: * "PLAIN_TEXT": Contain direct values such as "1", "True", or "c5.large.search". * "STRINGIFIED_JSON": Contain content in JSON format, such as {"Enabled":"True"}". * **AIMLOptions** *(dict) --* Container for parameters required to enable all machine learning features. * **NaturalLanguageQueryGenerationOptions** *(dict) --* Container for parameters required for natural language query generation on the specified domain. * **DesiredState** *(string) --* The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED. * **CurrentState** *(string) --* The current state of the natural language query generation feature, indicating completion, in progress, or failure. * **S3VectorsEngine** *(dict) --* Container for parameters representing the state of S3 vectors engine features on the specified domain. * **Enabled** *(boolean) --* Enables S3 vectors engine features. * **DryRunResults** *(dict) --* The results of the dry run. * **DeploymentType** *(string) --* Specifies the way in which OpenSearch Service will apply an update. Possible values are: * **Blue/Green** - The update requires a blue/green deployment. * **DynamicUpdate** - No blue/green deployment required * **Undetermined** - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete. * **None** - The request doesn't include any configuration changes. * **Message** *(string) --* A message corresponding to the deployment type. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / revoke_vpc_endpoint_access revoke_vpc_endpoint_access ************************** OpenSearchService.Client.revoke_vpc_endpoint_access(**kwargs) Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.revoke_vpc_endpoint_access( DomainName='string', Account='string', Service='application.opensearchservice.amazonaws.com' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the OpenSearch Service domain. * **Account** (*string*) -- The account ID to revoke access from. * **Service** (*string*) -- The service SP to revoke access from. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.BaseException" OpenSearchService / Client / list_domain_names list_domain_names ***************** OpenSearchService.Client.list_domain_names(**kwargs) Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region. See also: AWS API Documentation **Request Syntax** response = client.list_domain_names( EngineType='OpenSearch'|'Elasticsearch' ) Parameters: **EngineType** (*string*) -- Filters the output by domain engine type. Return type: dict Returns: **Response Syntax** { 'DomainNames': [ { 'DomainName': 'string', 'EngineType': 'OpenSearch'|'Elasticsearch' }, ] } **Response Structure** * *(dict) --* The results of a "ListDomainNames" operation. Contains the names of all domains owned by this account and their respective engine types. * **DomainNames** *(list) --* The names of all OpenSearch Service domains owned by the current user and their respective engine types. * *(dict) --* Information about an OpenSearch Service domain. * **DomainName** *(string) --* Name of the domain. * **EngineType** *(string) --* The type of search engine that the domain is running. "OpenSearch" for an OpenSearch engine, or "Elasticsearch" for a legacy Elasticsearch OSS engine. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / close close ***** OpenSearchService.Client.close() Closes underlying endpoint connections. OpenSearchService / Client / describe_inbound_connections describe_inbound_connections **************************** OpenSearchService.Client.describe_inbound_connections(**kwargs) Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.describe_inbound_connections( Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **Filters** (*list*) -- A list of filters used to match properties for inbound cross- cluster connections. * *(dict) --* A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation. * **Name** *(string) --* The name of the filter. * **Values** *(list) --* One or more values for the filter. * *(string) --* * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "DescribeInboundConnections" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "DescribeInboundConnections" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'Connections': [ { 'LocalDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'RemoteDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'ConnectionId': 'string', 'ConnectionStatus': { 'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED', 'Message': 'string' }, 'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains a list of connections matching the filter criteria. * **Connections** *(list) --* List of inbound connections. * *(dict) --* Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross- cluster search for Amazon OpenSearch Service. * **LocalDomainInfo** *(dict) --* Information about the source (local) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **RemoteDomainInfo** *(dict) --* Information about the destination (remote) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **ConnectionId** *(string) --* The unique identifier of the connection. * **ConnectionStatus** *(dict) --* The current status of the connection. * **StatusCode** *(string) --* The status code for the connection. Can be one of the following: * **PENDING_ACCEPTANCE** - Inbound connection is not yet accepted by the remote domain owner. * **APPROVED**: Inbound connection is pending acceptance by the remote domain owner. * **PROVISIONING**: Inbound connection is being provisioned. * **ACTIVE**: Inbound connection is active and ready to use. * **REJECTING**: Inbound connection rejection is in process. * **REJECTED**: Inbound connection is rejected. * **DELETING**: Inbound connection deletion is in progress. * **DELETED**: Inbound connection is deleted and can no longer be used. * **Message** *(string) --* Information about the connection. * **ConnectionMode** *(string) --* The connection mode. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.InvalidPaginationTokenExcep tion" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / describe_domain_auto_tunes describe_domain_auto_tunes ************************** OpenSearchService.Client.describe_domain_auto_tunes(**kwargs) Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto- Tune for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.describe_domain_auto_tunes( DomainName='string', MaxResults=123, NextToken='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** Name of the domain that you want Auto-Tune details about. * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "DescribeDomainAutoTunes" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "DescribeDomainAutoTunes" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'AutoTunes': [ { 'AutoTuneType': 'SCHEDULED_ACTION', 'AutoTuneDetails': { 'ScheduledAutoTuneDetails': { 'Date': datetime(2015, 1, 1), 'ActionType': 'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING', 'Action': 'string', 'Severity': 'LOW'|'MEDIUM'|'HIGH' } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The result of a "DescribeDomainAutoTunes" request. * **AutoTunes** *(list) --* The list of setting adjustments that Auto-Tune has made to the domain. * *(dict) --* Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service. * **AutoTuneType** *(string) --* The type of Auto-Tune action. * **AutoTuneDetails** *(dict) --* Details about an Auto-Tune action. * **ScheduledAutoTuneDetails** *(dict) --* Container for details about a scheduled Auto-Tune action. * **Date** *(datetime) --* The date and time when the Auto-Tune action is scheduled for the domain. * **ActionType** *(string) --* The type of Auto-Tune action. * **Action** *(string) --* A description of the Auto-Tune action. * **Severity** *(string) --* The severity of the Auto-Tune action. Valid values are "LOW", "MEDIUM", and "HIGH". * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / remove_tags remove_tags *********** OpenSearchService.Client.remove_tags(**kwargs) Removes the specified set of tags from an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources. See also: AWS API Documentation **Request Syntax** response = client.remove_tags( ARN='string', TagKeys=[ 'string', ] ) Parameters: * **ARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the domain, data source, or application from which you want to delete the specified tags. * **TagKeys** (*list*) -- **[REQUIRED]** The list of tag keys to remove from the domain, data source, or application. * *(string) --* Returns: None **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.InternalException" OpenSearchService / Client / get_upgrade_status get_upgrade_status ****************** OpenSearchService.Client.get_upgrade_status(**kwargs) Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain. See also: AWS API Documentation **Request Syntax** response = client.get_upgrade_status( DomainName='string' ) Parameters: **DomainName** (*string*) -- **[REQUIRED]** The domain of the domain to get upgrade status information for. Return type: dict Returns: **Response Syntax** { 'UpgradeStep': 'PRE_UPGRADE_CHECK'|'SNAPSHOT'|'UPGRADE', 'StepStatus': 'IN_PROGRESS'|'SUCCEEDED'|'SUCCEEDED_WITH_ISSUES'|'FAILED', 'UpgradeName': 'string' } **Response Structure** * *(dict) --* Container for the response returned by the "GetUpgradeStatus" operation. * **UpgradeStep** *(string) --* One of three steps that an upgrade or upgrade eligibility check goes through. * **StepStatus** *(string) --* The status of the current step that an upgrade is on. * **UpgradeName** *(string) --* A string that describes the update. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.InternalException" OpenSearchService / Client / associate_package associate_package ***************** OpenSearchService.Client.associate_package(**kwargs) Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.associate_package( PackageID='string', DomainName='string', PrerequisitePackageIDList=[ 'string', ], AssociationConfiguration={ 'KeyStoreAccessOption': { 'KeyAccessRoleArn': 'string', 'KeyStoreAccessEnabled': True|False } } ) Parameters: * **PackageID** (*string*) -- **[REQUIRED]** Internal ID of the package to associate with a domain. Use "DescribePackages" to find this value. * **DomainName** (*string*) -- **[REQUIRED]** Name of the domain to associate the package with. * **PrerequisitePackageIDList** (*list*) -- A list of package IDs that must be associated with the domain before the package specified in the request can be associated. * *(string) --* * **AssociationConfiguration** (*dict*) -- The configuration for associating a package with an Amazon OpenSearch Service domain. * **KeyStoreAccessOption** *(dict) --* The configuration parameters to enable accessing the key store required by the package. * **KeyAccessRoleArn** *(string) --* Role ARN to access the KeyStore Key * **KeyStoreAccessEnabled** *(boolean) --* **[REQUIRED]** This indicates whether Key Store access is enabled Return type: dict Returns: **Response Syntax** { 'DomainPackageDetails': { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', 'LastUpdated': datetime(2015, 1, 1), 'DomainName': 'string', 'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED', 'PackageVersion': 'string', 'PrerequisitePackageIDList': [ 'string', ], 'ReferencePath': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'AssociationConfiguration': { 'KeyStoreAccessOption': { 'KeyAccessRoleArn': 'string', 'KeyStoreAccessEnabled': True|False } } } } **Response Structure** * *(dict) --* Container for the response returned by the "AssociatePackage" operation. * **DomainPackageDetails** *(dict) --* Information about a package that is associated with a domain. * **PackageID** *(string) --* Internal ID of the package. * **PackageName** *(string) --* User-specified name of the package. * **PackageType** *(string) --* The type of package. * **LastUpdated** *(datetime) --* Timestamp of the most recent update to the package association status. * **DomainName** *(string) --* Name of the domain that the package is associated with. * **DomainPackageStatus** *(string) --* State of the association. * **PackageVersion** *(string) --* The current version of the package. * **PrerequisitePackageIDList** *(list) --* A list of package IDs that must be associated with the domain before or with the package can be associated. * *(string) --* * **ReferencePath** *(string) --* The relative path of the package on the OpenSearch Service cluster nodes. This is "synonym_path" when the package is for synonym files. * **ErrorDetails** *(dict) --* Additional information if the package is in an error state. Null otherwise. * **ErrorType** *(string) --* The type of error that occurred. * **ErrorMessage** *(string) --* A message describing the error. * **AssociationConfiguration** *(dict) --* The configuration for associating a package with an Amazon OpenSearch Service domain. * **KeyStoreAccessOption** *(dict) --* The configuration parameters to enable accessing the key store required by the package. * **KeyAccessRoleArn** *(string) --* Role ARN to access the KeyStore Key * **KeyStoreAccessEnabled** *(boolean) --* This indicates whether Key Store access is enabled **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.ConflictException" OpenSearchService / Client / reject_inbound_connection reject_inbound_connection ************************* OpenSearchService.Client.reject_inbound_connection(**kwargs) Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request. See also: AWS API Documentation **Request Syntax** response = client.reject_inbound_connection( ConnectionId='string' ) Parameters: **ConnectionId** (*string*) -- **[REQUIRED]** The unique identifier of the inbound connection to reject. Return type: dict Returns: **Response Syntax** { 'Connection': { 'LocalDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'RemoteDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'ConnectionId': 'string', 'ConnectionStatus': { 'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED', 'Message': 'string' }, 'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT' } } **Response Structure** * *(dict) --* Represents the output of a "RejectInboundConnection" operation. * **Connection** *(dict) --* Contains details about the rejected inbound connection. * **LocalDomainInfo** *(dict) --* Information about the source (local) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **RemoteDomainInfo** *(dict) --* Information about the destination (remote) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **ConnectionId** *(string) --* The unique identifier of the connection. * **ConnectionStatus** *(dict) --* The current status of the connection. * **StatusCode** *(string) --* The status code for the connection. Can be one of the following: * **PENDING_ACCEPTANCE** - Inbound connection is not yet accepted by the remote domain owner. * **APPROVED**: Inbound connection is pending acceptance by the remote domain owner. * **PROVISIONING**: Inbound connection is being provisioned. * **ACTIVE**: Inbound connection is active and ready to use. * **REJECTING**: Inbound connection rejection is in process. * **REJECTED**: Inbound connection is rejected. * **DELETING**: Inbound connection deletion is in progress. * **DELETED**: Inbound connection is deleted and can no longer be used. * **Message** *(string) --* Information about the connection. * **ConnectionMode** *(string) --* The connection mode. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / start_domain_maintenance start_domain_maintenance ************************ OpenSearchService.Client.start_domain_maintenance(**kwargs) Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart. See also: AWS API Documentation **Request Syntax** response = client.start_domain_maintenance( DomainName='string', Action='REBOOT_NODE'|'RESTART_SEARCH_PROCESS'|'RESTART_DASHBOARD', NodeId='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. * **Action** (*string*) -- **[REQUIRED]** The name of the action. * **NodeId** (*string*) -- The ID of the data node. Return type: dict Returns: **Response Syntax** { 'MaintenanceId': 'string' } **Response Structure** * *(dict) --* The result of a "StartDomainMaintenance" request that information about the requested action. * **MaintenanceId** *(string) --* The request ID of requested action. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / update_scheduled_action update_scheduled_action *********************** OpenSearchService.Client.update_scheduled_action(**kwargs) Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement. See also: AWS API Documentation **Request Syntax** response = client.update_scheduled_action( DomainName='string', ActionID='string', ActionType='SERVICE_SOFTWARE_UPDATE'|'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING', ScheduleAt='NOW'|'TIMESTAMP'|'OFF_PEAK_WINDOW', DesiredStartTime=123 ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain to reschedule an action for. * **ActionID** (*string*) -- **[REQUIRED]** The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request. * **ActionType** (*string*) -- **[REQUIRED]** The type of action to reschedule. Can be one of "SERVICE_SOFTWARE_UPDATE", "JVM_HEAP_SIZE_TUNING", or "JVM_YOUNG_GEN_TUNING". To retrieve this value, send a ListScheduledActions request. * **ScheduleAt** (*string*) -- **[REQUIRED]** When to schedule the action. * "NOW" - Immediately schedules the update to happen in the current hour if there's capacity available. * "TIMESTAMP" - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for "DesiredStartTime". * "OFF_PEAK_WINDOW" - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days. * **DesiredStartTime** (*integer*) -- The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set "ScheduleAt" to "TIMESTAMP". Return type: dict Returns: **Response Syntax** { 'ScheduledAction': { 'Id': 'string', 'Type': 'SERVICE_SOFTWARE_UPDATE'|'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING', 'Severity': 'HIGH'|'MEDIUM'|'LOW', 'ScheduledTime': 123, 'Description': 'string', 'ScheduledBy': 'CUSTOMER'|'SYSTEM', 'Status': 'PENDING_UPDATE'|'IN_PROGRESS'|'FAILED'|'COMPLETED'|'NOT_ELIGIBLE'|'ELIGIBLE', 'Mandatory': True|False, 'Cancellable': True|False } } **Response Structure** * *(dict) --* * **ScheduledAction** *(dict) --* Information about the rescheduled action. * **Id** *(string) --* The unique identifier of the scheduled action. * **Type** *(string) --* The type of action that will be taken on the domain. * **Severity** *(string) --* The severity of the action. * **ScheduledTime** *(integer) --* The time when the change is scheduled to happen. * **Description** *(string) --* A description of the action to be taken. * **ScheduledBy** *(string) --* Whether the action was scheduled manually ( "CUSTOMER", or by OpenSearch Service automatically ( "SYSTEM"). * **Status** *(string) --* The current status of the scheduled action. * **Mandatory** *(boolean) --* Whether the action is required or optional. * **Cancellable** *(boolean) --* Whether or not the scheduled action is cancellable. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.SlotNotAvailableException" * "OpenSearchService.Client.exceptions.ConflictException" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / list_packages_for_domain list_packages_for_domain ************************ OpenSearchService.Client.list_packages_for_domain(**kwargs) Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.list_packages_for_domain( DomainName='string', MaxResults=123, NextToken='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain for which you want to list associated packages. * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "ListPackagesForDomain" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListPackagesForDomain" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'DomainPackageDetailsList': [ { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', 'LastUpdated': datetime(2015, 1, 1), 'DomainName': 'string', 'DomainPackageStatus': 'ASSOCIATING'|'ASSOCIATION_FAILED'|'ACTIVE'|'DISSOCIATING'|'DISSOCIATION_FAILED', 'PackageVersion': 'string', 'PrerequisitePackageIDList': [ 'string', ], 'ReferencePath': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'AssociationConfiguration': { 'KeyStoreAccessOption': { 'KeyAccessRoleArn': 'string', 'KeyStoreAccessEnabled': True|False } } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Container for the response parameters to the "ListPackagesForDomain" operation. * **DomainPackageDetailsList** *(list) --* List of all packages associated with a domain. * *(dict) --* Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service. * **PackageID** *(string) --* Internal ID of the package. * **PackageName** *(string) --* User-specified name of the package. * **PackageType** *(string) --* The type of package. * **LastUpdated** *(datetime) --* Timestamp of the most recent update to the package association status. * **DomainName** *(string) --* Name of the domain that the package is associated with. * **DomainPackageStatus** *(string) --* State of the association. * **PackageVersion** *(string) --* The current version of the package. * **PrerequisitePackageIDList** *(list) --* A list of package IDs that must be associated with the domain before or with the package can be associated. * *(string) --* * **ReferencePath** *(string) --* The relative path of the package on the OpenSearch Service cluster nodes. This is "synonym_path" when the package is for synonym files. * **ErrorDetails** *(dict) --* Additional information if the package is in an error state. Null otherwise. * **ErrorType** *(string) --* The type of error that occurred. * **ErrorMessage** *(string) --* A message describing the error. * **AssociationConfiguration** *(dict) --* The configuration for associating a package with an Amazon OpenSearch Service domain. * **KeyStoreAccessOption** *(dict) --* The configuration parameters to enable accessing the key store required by the package. * **KeyAccessRoleArn** *(string) --* Role ARN to access the KeyStore Key * **KeyStoreAccessEnabled** *(boolean) --* This indicates whether Key Store access is enabled * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / delete_application delete_application ****************** OpenSearchService.Client.delete_application(**kwargs) Deletes a specified OpenSearch application. See also: AWS API Documentation **Request Syntax** response = client.delete_application( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The unique identifier of the OpenSearch application to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ConflictException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / add_data_source add_data_source *************** OpenSearchService.Client.add_data_source(**kwargs) Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3. See also: AWS API Documentation **Request Syntax** response = client.add_data_source( DomainName='string', Name='string', DataSourceType={ 'S3GlueDataCatalog': { 'RoleArn': 'string' } }, Description='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain to add the data source to. * **Name** (*string*) -- **[REQUIRED]** A name for the data source. * **DataSourceType** (*dict*) -- **[REQUIRED]** The type of data source. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "S3GlueDataCatalog". * **S3GlueDataCatalog** *(dict) --* An Amazon S3 data source. * **RoleArn** *(string) --* >The Amazon Resource Name (ARN) for the S3 Glue Data Catalog. * **Description** (*string*) -- A description of the data source. Return type: dict Returns: **Response Syntax** { 'Message': 'string' } **Response Structure** * *(dict) --* The result of an "AddDataSource" operation. * **Message** *(string) --* A message associated with creation of the data source. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.DependencyFailureException" * "OpenSearchService.Client.exceptions.LimitExceededException" OpenSearchService / Client / create_application create_application ****************** OpenSearchService.Client.create_application(**kwargs) Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.create_application( clientToken='string', name='string', dataSources=[ { 'dataSourceArn': 'string', 'dataSourceDescription': 'string' }, ], iamIdentityCenterOptions={ 'enabled': True|False, 'iamIdentityCenterInstanceArn': 'string', 'iamRoleForIdentityCenterApplicationArn': 'string' }, appConfigs=[ { 'key': 'opensearchDashboards.dashboardAdmin.users'|'opensearchDashboards.dashboardAdmin.groups', 'value': 'string' }, ], tagList=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **clientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. This field is autopopulated if not provided. * **name** (*string*) -- **[REQUIRED]** The unique name of the OpenSearch application. Names must be unique within an Amazon Web Services Region for each account. * **dataSources** (*list*) -- The data sources to link to the OpenSearch application. * *(dict) --* Data sources that are associated with an OpenSearch application. * **dataSourceArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **dataSourceDescription** *(string) --* Detailed description of a data source. * **iamIdentityCenterOptions** (*dict*) -- Configuration settings for integrating Amazon Web Services IAM Identity Center with the OpenSearch application. * **enabled** *(boolean) --* Specifies whether IAM Identity Center is enabled or disabled. * **iamIdentityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **iamRoleForIdentityCenterApplicationArn** *(string) --* The ARN of the IAM role associated with the IAM Identity Center application. * **appConfigs** (*list*) -- Configuration settings for the OpenSearch application, including administrative options. * *(dict) --* Configuration settings for an OpenSearch application. For more information, see see Using the OpenSearch user interface in Amazon OpenSearch Service. * **key** *(string) --* The configuration item to set, such as the admin role for the OpenSearch application. * **value** *(string) --* The value assigned to the configuration key, such as an IAM user ARN. * **tagList** (*list*) -- A list of tags attached to a domain. * *(dict) --* A tag (key-value pair) for an Amazon OpenSearch Service resource. * **Key** *(string) --* **[REQUIRED]** The tag key. Tag keys must be unique for the domain to which they are attached. * **Value** *(string) --* **[REQUIRED]** The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" Return type: dict Returns: **Response Syntax** { 'id': 'string', 'name': 'string', 'arn': 'string', 'dataSources': [ { 'dataSourceArn': 'string', 'dataSourceDescription': 'string' }, ], 'iamIdentityCenterOptions': { 'enabled': True|False, 'iamIdentityCenterInstanceArn': 'string', 'iamRoleForIdentityCenterApplicationArn': 'string', 'iamIdentityCenterApplicationArn': 'string' }, 'appConfigs': [ { 'key': 'opensearchDashboards.dashboardAdmin.users'|'opensearchDashboards.dashboardAdmin.groups', 'value': 'string' }, ], 'tagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'createdAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **id** *(string) --* The unique identifier assigned to the OpenSearch application. * **name** *(string) --* The name of the OpenSearch application. * **arn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **dataSources** *(list) --* The data sources linked to the OpenSearch application. * *(dict) --* Data sources that are associated with an OpenSearch application. * **dataSourceArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **dataSourceDescription** *(string) --* Detailed description of a data source. * **iamIdentityCenterOptions** *(dict) --* The IAM Identity Center settings configured for the OpenSearch application. * **enabled** *(boolean) --* Indicates whether IAM Identity Center is enabled for the OpenSearch application. * **iamIdentityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **iamRoleForIdentityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch application. * **iamIdentityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **appConfigs** *(list) --* Configuration settings for the OpenSearch application, including administrative options. * *(dict) --* Configuration settings for an OpenSearch application. For more information, see see Using the OpenSearch user interface in Amazon OpenSearch Service. * **key** *(string) --* The configuration item to set, such as the admin role for the OpenSearch application. * **value** *(string) --* The value assigned to the configuration key, such as an IAM user ARN. * **tagList** *(list) --* A list of tags attached to a domain. * *(dict) --* A tag (key-value pair) for an Amazon OpenSearch Service resource. * **Key** *(string) --* The tag key. Tag keys must be unique for the domain to which they are attached. * **Value** *(string) --* The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" * **createdAt** *(datetime) --* The timestamp indicating when the OpenSearch application was created. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ConflictException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / delete_outbound_connection delete_outbound_connection ************************** OpenSearchService.Client.delete_outbound_connection(**kwargs) Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.delete_outbound_connection( ConnectionId='string' ) Parameters: **ConnectionId** (*string*) -- **[REQUIRED]** The ID of the outbound connection you want to permanently delete. Return type: dict Returns: **Response Syntax** { 'Connection': { 'LocalDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'RemoteDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'ConnectionId': 'string', 'ConnectionAlias': 'string', 'ConnectionStatus': { 'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED', 'Message': 'string' }, 'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT', 'ConnectionProperties': { 'Endpoint': 'string', 'CrossClusterSearch': { 'SkipUnavailable': 'ENABLED'|'DISABLED' } } } } **Response Structure** * *(dict) --* Details about the deleted outbound connection. * **Connection** *(dict) --* The deleted inbound connection. * **LocalDomainInfo** *(dict) --* Information about the source (local) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **RemoteDomainInfo** *(dict) --* Information about the destination (remote) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **ConnectionId** *(string) --* Unique identifier of the connection. * **ConnectionAlias** *(string) --* Name of the connection. * **ConnectionStatus** *(dict) --* Status of the connection. * **StatusCode** *(string) --* The status code for the outbound connection. Can be one of the following: * **VALIDATING** - The outbound connection request is being validated. * **VALIDATION_FAILED** - Validation failed for the connection request. * **PENDING_ACCEPTANCE**: Outbound connection request is validated and is not yet accepted by the remote domain owner. * **APPROVED** - Outbound connection has been approved by the remote domain owner for getting provisioned. * **PROVISIONING** - Outbound connection request is in process. * **ACTIVE** - Outbound connection is active and ready to use. * **REJECTING** - Outbound connection rejection by remote domain owner is in progress. * **REJECTED** - Outbound connection request is rejected by remote domain owner. * **DELETING** - Outbound connection deletion is in progress. * **DELETED** - Outbound connection is deleted and can no longer be used. * **Message** *(string) --* Verbose information for the outbound connection. * **ConnectionMode** *(string) --* The connection mode. * **ConnectionProperties** *(dict) --* Properties for the outbound connection. * **Endpoint** *(string) --* Warning: The Endpoint attribute cannot be modified. The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode. * **CrossClusterSearch** *(dict) --* The connection properties for cross cluster search. * **SkipUnavailable** *(string) --* The status of the "SkipUnavailable" setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / describe_domains describe_domains **************** OpenSearchService.Client.describe_domains(**kwargs) Returns domain configuration information about the specified Amazon OpenSearch Service domains. See also: AWS API Documentation **Request Syntax** response = client.describe_domains( DomainNames=[ 'string', ] ) Parameters: **DomainNames** (*list*) -- **[REQUIRED]** Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name. * *(string) --* The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region. Return type: dict Returns: **Response Syntax** { 'DomainStatusList': [ { 'DomainId': 'string', 'DomainName': 'string', 'ARN': 'string', 'Created': True|False, 'Deleted': True|False, 'Endpoint': 'string', 'EndpointV2': 'string', 'Endpoints': { 'string': 'string' }, 'DomainEndpointV2HostedZoneId': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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 }, 'MultiAZWithStandbyEnabled': True|False, 'NodeOptions': [ { 'NodeType': 'coordinator', 'NodeConfig': { 'Enabled': True|False, 'Type': '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'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.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', 'Count': 123 } }, ] }, 'EBSOptions': { 'EBSEnabled': True|False, 'VolumeType': 'standard'|'gp2'|'io1'|'gp3', 'VolumeSize': 123, 'Iops': 123, 'Throughput': 123 }, 'AccessPolicies': 'string', 'IPAddressType': 'ipv4'|'dualstack', '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'|'Policy-Min-TLS-1-2-PFS-2023-10', '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 }, 'JWTOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string', 'PublicKey': 'string' }, 'IAMFederationOptions': { 'Enabled': True|False, 'SubjectKey': 'string', 'RolesKey': 'string' }, 'AnonymousAuthDisableDate': datetime(2015, 1, 1), 'AnonymousAuthEnabled': True|False }, 'IdentityCenterOptions': { 'EnabledAPIAccess': True|False, 'IdentityCenterInstanceARN': 'string', 'SubjectKey': 'UserName'|'UserId'|'Email', 'RolesKey': 'GroupName'|'GroupId', 'IdentityCenterApplicationARN': 'string', 'IdentityStoreId': 'string' }, 'AutoTuneOptions': { 'State': 'ENABLED'|'DISABLED'|'ENABLE_IN_PROGRESS'|'DISABLE_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_SCHEDULED'|'DISABLED_AND_ROLLBACK_IN_PROGRESS'|'DISABLED_AND_ROLLBACK_COMPLETE'|'DISABLED_AND_ROLLBACK_ERROR'|'ERROR', 'ErrorMessage': 'string', 'UseOffPeakWindow': True|False }, 'ChangeProgressDetails': { 'ChangeId': 'string', 'Message': 'string', 'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled', 'InitiatedBy': 'CUSTOMER'|'SERVICE', 'StartTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) }, 'OffPeakWindowOptions': { 'Enabled': True|False, 'OffPeakWindow': { 'WindowStartTime': { 'Hours': 123, 'Minutes': 123 } } }, 'SoftwareUpdateOptions': { 'AutoSoftwareUpdateEnabled': True|False }, 'DomainProcessingStatus': 'Creating'|'Active'|'Modifying'|'UpgradingEngineVersion'|'UpdatingServiceSoftware'|'Isolated'|'Deleting', 'ModifyingProperties': [ { 'Name': 'string', 'ActiveValue': 'string', 'PendingValue': 'string', 'ValueType': 'PLAIN_TEXT'|'STRINGIFIED_JSON' }, ], 'AIMLOptions': { 'NaturalLanguageQueryGenerationOptions': { 'DesiredState': 'ENABLED'|'DISABLED', 'CurrentState': 'NOT_ENABLED'|'ENABLE_COMPLETE'|'ENABLE_IN_PROGRESS'|'ENABLE_FAILED'|'DISABLE_COMPLETE'|'DISABLE_IN_PROGRESS'|'DISABLE_FAILED' }, 'S3VectorsEngine': { 'Enabled': True|False } } }, ] } **Response Structure** * *(dict) --* Contains the status of the specified domains or all domains owned by the account. * **DomainStatusList** *(list) --* The status of the requested domains. * *(dict) --* The current status of an OpenSearch Service domain. * **DomainId** *(string) --* Unique identifier for the domain. * **DomainName** *(string) --* Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region. * **ARN** *(string) --* The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the *AWS Identity and Access Management User Guide*. * **Created** *(boolean) --* Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress. * **Deleted** *(boolean) --* Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned. * **Endpoint** *(string) --* Domain-specific endpoint used to submit index, search, and data upload requests to the domain. * **EndpointV2** *(string) --* If "IPAddressType" to set to "dualstack", a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. * **Endpoints** *(dict) --* The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example: * **IPv4 IP addresses** - "'vpc','vpc-endpoint- h2dsd34efgyghrtguk5gt6j2foh4.us- east-1.es.amazonaws.com'" * **Dual stack IP addresses** - "'vpcv2':'vpc-endpoint- h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'" * *(string) --* * *(string) --* The domain endpoint to which index and search requests are submitted. For example, "search-imdb- movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com" or "doc-imdb-movies-oopcnjfn6u.eu- west-1.es.amazonaws.com". * **DomainEndpointV2HostedZoneId** *(string) --* The dual stack hosted zone ID for the domain. * **Processing** *(boolean) --* The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active. * **UpgradeProcessing** *(boolean) --* The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active. * **EngineVersion** *(string) --* Version of OpenSearch or Elasticsearch that the domain is running, in the format "Elasticsearch_X.Y" or "OpenSearch_X.Y". * **ClusterConfig** *(dict) --* Container for the cluster configuration of the domain. * **InstanceType** *(string) --* Instance type of data nodes in the cluster. * **InstanceCount** *(integer) --* Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. * **DedicatedMasterEnabled** *(boolean) --* Indicates whether dedicated master nodes are enabled for the cluster. "True" if the cluster will use a dedicated master node. "False" if the cluster will not. * **ZoneAwarenessEnabled** *(boolean) --* Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **ZoneAwarenessConfig** *(dict) --* Container for zone awareness configuration options. Only required if "ZoneAwarenessEnabled" is "true". * **AvailabilityZoneCount** *(integer) --* If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are "2" and "3". If your domain is provisioned within a VPC, this value be equal to number of subnets. * **DedicatedMasterType** *(string) --* OpenSearch Service instance type of the dedicated master nodes in the cluster. * **DedicatedMasterCount** *(integer) --* Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. * **WarmEnabled** *(boolean) --* Whether to enable warm storage for the cluster. * **WarmType** *(string) --* The instance type for the cluster's warm nodes. * **WarmCount** *(integer) --* The number of warm nodes in the cluster. * **ColdStorageOptions** *(dict) --* Container for cold storage configuration options. * **Enabled** *(boolean) --* Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. * **MultiAZWithStandbyEnabled** *(boolean) --* A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. * **NodeOptions** *(list) --* List of node options for the domain. * *(dict) --* Configuration settings for defining the node type within a cluster. * **NodeType** *(string) --* Defines the type of node, such as coordinating nodes. * **NodeConfig** *(dict) --* Configuration options for defining the setup of any node type. * **Enabled** *(boolean) --* A boolean value indicating whether a specific node type is active or inactive. * **Type** *(string) --* The instance type of a particular node within the cluster. * **Count** *(integer) --* The number of nodes of a specific type within the cluster. * **EBSOptions** *(dict) --* Container for EBS-based storage settings for the domain. * **EBSEnabled** *(boolean) --* Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. * **VolumeType** *(string) --* Specifies the type of EBS volumes attached to data nodes. * **VolumeSize** *(integer) --* Specifies the size (in GiB) of EBS volumes attached to data nodes. * **Iops** *(integer) --* Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the "gp3" and provisioned IOPS EBS volume types. * **Throughput** *(integer) --* Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the "gp3" volume type. * **AccessPolicies** *(string) --* Identity and Access Management (IAM) policy document specifying the access policies for the domain. * **IPAddressType** *(string) --* The type of IP addresses supported by the endpoint for the domain. * **SnapshotOptions** *(dict) --* DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes. * **AutomatedSnapshotStartHour** *(integer) --* The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is "0" hours. * **VPCOptions** *(dict) --* The VPC configuration for the domain. * **VPCId** *(string) --* The ID for your VPC. Amazon VPC generates this value when you create a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. * *(string) --* * **AvailabilityZones** *(list) --* The list of Availability Zones associated with the VPC subnets. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. * *(string) --* * **CognitoOptions** *(dict) --* Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards. * **Enabled** *(boolean) --* Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. * **UserPoolId** *(string) --* The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **IdentityPoolId** *(string) --* The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. * **RoleArn** *(string) --* The "AmazonOpenSearchServiceCognitoAccess" role that allows OpenSearch Service to configure your user pool and identity pool. * **EncryptionAtRestOptions** *(dict) --* Encryption at rest settings for the domain. * **Enabled** *(boolean) --* True to enable encryption at rest. * **KmsKeyId** *(string) --* The KMS key ID. Takes the form "1a2a3a4-1a2a-3a4a- 5a6a-1a2a3a4a5a6a". * **NodeToNodeEncryptionOptions** *(dict) --* Whether node-to-node encryption is enabled or disabled. * **Enabled** *(boolean) --* True to enable node-to-node encryption. * **AdvancedOptions** *(dict) --* Key-value pairs that specify advanced configuration options. * *(string) --* * *(string) --* * **LogPublishingOptions** *(dict) --* Log publishing options for the domain. * *(string) --* The type of log file. Can be one of the following: * **INDEX_SLOW_LOGS** - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute. * **SEARCH_SLOW_LOGS** - Search slow logs contain search queries that took more time than the configured search query log threshold to execute. * **ES_APPLICATION_LOGS** - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting. * **AUDIT_LOGS** - Audit logs contain records of user requests for access to the domain. * *(dict) --* Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs. Note: After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API. * **CloudWatchLogsLogGroupArn** *(string) --* The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to. * **Enabled** *(boolean) --* Whether the log should be published. * **ServiceSoftwareOptions** *(dict) --* The current status of the domain's service software. * **CurrentVersion** *(string) --* The current service software version present on the domain. * **NewVersion** *(string) --* The new service software version, if one is available. * **UpdateAvailable** *(boolean) --* True if you're able to update your service software version. False if you can't update your service software version. * **Cancellable** *(boolean) --* True if you're able to cancel your service software version update. False if you can't cancel your service software update. * **UpdateStatus** *(string) --* The status of your service software update. * **Description** *(string) --* A description of the service software update status. * **AutomatedUpdateDate** *(datetime) --* The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. * **OptionalDeployment** *(boolean) --* True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date. * **DomainEndpointOptions** *(dict) --* Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. * **EnforceHTTPS** *(boolean) --* True to require that all traffic to the domain arrive over HTTPS. * **TLSSecurityPolicy** *(string) --* Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports TLS version 1.0 to TLS version 1.2 * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports only TLS version 1.2 * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites * **CustomEndpointEnabled** *(boolean) --* Whether to enable a custom endpoint for the domain. * **CustomEndpoint** *(string) --* The fully qualified URL for the custom endpoint. * **CustomEndpointCertificateArn** *(string) --* The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). * **AdvancedSecurityOptions** *(dict) --* Settings for fine-grained access control. * **Enabled** *(boolean) --* True if fine-grained access control is enabled. * **InternalUserDatabaseEnabled** *(boolean) --* True if the internal user database is enabled. * **SAMLOptions** *(dict) --* Container for information about the SAML configuration for OpenSearch Dashboards. * **Enabled** *(boolean) --* True if SAML is enabled. * **Idp** *(dict) --* Describes the SAML identity provider's information. * **MetadataContent** *(string) --* The metadata of the SAML application, in XML format. * **EntityId** *(string) --* The unique entity ID of the application in the SAML identity provider. * **SubjectKey** *(string) --* The key used for matching the SAML subject attribute. * **RolesKey** *(string) --* The key used for matching the SAML roles attribute. * **SessionTimeoutMinutes** *(integer) --* The duration, in minutes, after which a user session becomes inactive. * **JWTOptions** *(dict) --* Container for information about the JWT configuration of the Amazon OpenSearch Service. * **Enabled** *(boolean) --* True if JWT use is enabled. * **SubjectKey** *(string) --* The key used for matching the JWT subject attribute. * **RolesKey** *(string) --* The key used for matching the JWT roles attribute. * **PublicKey** *(string) --* The key used to verify the signature of incoming JWT requests. * **IAMFederationOptions** *(dict) --* Container for information about the IAM federation configuration for an OpenSearch UI application. * **Enabled** *(boolean) --* True if IAM federation is enabled. * **SubjectKey** *(string) --* The key used for matching the IAM federation subject attribute. * **RolesKey** *(string) --* The key used for matching the IAM federation roles attribute. * **AnonymousAuthDisableDate** *(datetime) --* Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain. * **AnonymousAuthEnabled** *(boolean) --* True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. * **IdentityCenterOptions** *(dict) --* Configuration options for controlling IAM Identity Center integration within a domain. * **EnabledAPIAccess** *(boolean) --* Indicates whether IAM Identity Center is enabled for the application. * **IdentityCenterInstanceARN** *(string) --* The Amazon Resource Name (ARN) of the IAM Identity Center instance. * **SubjectKey** *(string) --* Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center. * **RolesKey** *(string) --* Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center. * **IdentityCenterApplicationARN** *(string) --* The ARN of the IAM Identity Center application that integrates with Amazon OpenSearch Service. * **IdentityStoreId** *(string) --* The identifier of the IAM Identity Store. * **AutoTuneOptions** *(dict) --* Auto-Tune settings for the domain. * **State** *(string) --* The current state of Auto-Tune on the domain. * **ErrorMessage** *(string) --* Any errors that occurred while enabling or disabling Auto-Tune. * **UseOffPeakWindow** *(boolean) --* Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule. * **ChangeProgressDetails** *(dict) --* Information about a configuration change happening on the domain. * **ChangeId** *(string) --* The ID of the configuration change. * **Message** *(string) --* A message corresponding to the status of the configuration change. * **ConfigChangeStatus** *(string) --* The current status of the configuration change. * **InitiatedBy** *(string) --* The IAM principal who initiated the configuration change. * **StartTime** *(datetime) --* The time that the configuration change was initiated, in Universal Coordinated Time (UTC). * **LastUpdatedTime** *(datetime) --* The last time that the configuration change was updated. * **OffPeakWindowOptions** *(dict) --* Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain. * **Enabled** *(boolean) --* Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain. * **OffPeakWindow** *(dict) --* Off-peak window settings for the domain. * **WindowStartTime** *(dict) --* A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. * **Hours** *(integer) --* The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, "17" refers to 5:00 P.M. UTC. * **Minutes** *(integer) --* The start minute of the window, in UTC. * **SoftwareUpdateOptions** *(dict) --* Service software update options for the domain. * **AutoSoftwareUpdateEnabled** *(boolean) --* Whether automatic service software updates are enabled for the domain. * **DomainProcessingStatus** *(string) --* The status of any changes that are currently in progress for the domain. * **ModifyingProperties** *(list) --* Information about the domain properties that are currently being modified. * *(dict) --* Information about the domain properties that are currently being modified. * **Name** *(string) --* The name of the property that is currently being modified. * **ActiveValue** *(string) --* The current value of the domain property that is being modified. * **PendingValue** *(string) --* The value that the property that is currently being modified will eventually have. * **ValueType** *(string) --* The type of value that is currently being modified. Properties can have two types: * "PLAIN_TEXT": Contain direct values such as "1", "True", or "c5.large.search". * "STRINGIFIED_JSON": Contain content in JSON format, such as {"Enabled":"True"}". * **AIMLOptions** *(dict) --* Container for parameters required to enable all machine learning features. * **NaturalLanguageQueryGenerationOptions** *(dict) --* Container for parameters required for natural language query generation on the specified domain. * **DesiredState** *(string) --* The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED. * **CurrentState** *(string) --* The current state of the natural language query generation feature, indicating completion, in progress, or failure. * **S3VectorsEngine** *(dict) --* Container for parameters representing the state of S3 vectors engine features on the specified domain. * **Enabled** *(boolean) --* Enables S3 vectors engine features. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / describe_packages describe_packages ***************** OpenSearchService.Client.describe_packages(**kwargs) Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.describe_packages( Filters=[ { 'Name': 'PackageID'|'PackageName'|'PackageStatus'|'PackageType'|'EngineVersion'|'PackageOwner', 'Value': [ 'string', ] }, ], MaxResults=123, NextToken='string' ) Parameters: * **Filters** (*list*) -- Only returns packages that match the "DescribePackagesFilterList" values. * *(dict) --* A filter to apply to the "DescribePackage" response. * **Name** *(string) --* Any field from "PackageDetails". * **Value** *(list) --* A non-empty list of values for the specified filter field. * *(string) --* * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "DescribePackageFilters" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "DescribePackageFilters" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'PackageDetailsList': [ { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN'|'PACKAGE-LICENSE'|'PACKAGE-CONFIG', 'PackageDescription': 'string', 'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'AvailablePackageVersion': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'EngineVersion': 'string', 'AvailablePluginProperties': { 'Name': 'string', 'Description': 'string', 'Version': 'string', 'ClassName': 'string', 'UncompressedSizeInBytes': 123 }, 'AvailablePackageConfiguration': { 'LicenseRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'LicenseFilepath': 'string', 'ConfigurationRequirement': 'REQUIRED'|'OPTIONAL'|'NONE', 'RequiresRestartForConfigurationUpdate': True|False }, 'AllowListedUserList': [ 'string', ], 'PackageOwner': 'string', 'PackageVendingOptions': { 'VendingEnabled': True|False }, 'PackageEncryptionOptions': { 'KmsKeyIdentifier': 'string', 'EncryptionEnabled': True|False } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Container for the response returned by the "DescribePackages" operation. * **PackageDetailsList** *(list) --* Basic information about a package. * *(dict) --* Basic information about a package. * **PackageID** *(string) --* The unique identifier of the package. * **PackageName** *(string) --* The user-specified name of the package. * **PackageType** *(string) --* The type of package. * **PackageDescription** *(string) --* User-specified description of the package. * **PackageStatus** *(string) --* The current status of the package. The available options are "AVAILABLE", "COPYING", "COPY_FAILED", "VALIDATNG", "VALIDATION_FAILED", "DELETING", and "DELETE_FAILED". * **CreatedAt** *(datetime) --* The timestamp when the package was created. * **LastUpdatedAt** *(datetime) --* Date and time when the package was last updated. * **AvailablePackageVersion** *(string) --* The package version. * **ErrorDetails** *(dict) --* Additional information if the package is in an error state. Null otherwise. * **ErrorType** *(string) --* The type of error that occurred. * **ErrorMessage** *(string) --* A message describing the error. * **EngineVersion** *(string) --* Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch. * **AvailablePluginProperties** *(dict) --* If the package is a "ZIP-PLUGIN" package, additional information about plugin properties. * **Name** *(string) --* The name of the plugin. * **Description** *(string) --* The description of the plugin. * **Version** *(string) --* The version of the plugin. * **ClassName** *(string) --* The name of the class to load. * **UncompressedSizeInBytes** *(integer) --* The uncompressed size of the plugin. * **AvailablePackageConfiguration** *(dict) --* This represents the available configuration parameters for the package. * **LicenseRequirement** *(string) --* The license requirements for the package. * **LicenseFilepath** *(string) --* The relative file path for the license associated with the package. * **ConfigurationRequirement** *(string) --* The configuration requirements for the package. * **RequiresRestartForConfigurationUpdate** *(boolean) --* This indicates whether a B/G deployment is required for updating the configuration that the plugin is prerequisite for. * **AllowListedUserList** *(list) --* A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package. * *(string) --* * **PackageOwner** *(string) --* The owner of the package who is allowed to create and update a package and add users to the package scope. * **PackageVendingOptions** *(dict) --* Package Vending Options for a package. * **VendingEnabled** *(boolean) --* Indicates whether the package vending feature is enabled, allowing the package to be used by other users. * **PackageEncryptionOptions** *(dict) --* Encryption options for a package. * **KmsKeyIdentifier** *(string) --* KMS key ID for encrypting the package. * **EncryptionEnabled** *(boolean) --* Whether encryption is enabled for the package. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.ValidationException" OpenSearchService / Client / authorize_vpc_endpoint_access authorize_vpc_endpoint_access ***************************** OpenSearchService.Client.authorize_vpc_endpoint_access(**kwargs) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.authorize_vpc_endpoint_access( DomainName='string', Account='string', Service='application.opensearchservice.amazonaws.com' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the OpenSearch Service domain to provide access to. * **Account** (*string*) -- The Amazon Web Services account ID to grant access to. * **Service** (*string*) -- The Amazon Web Services service SP to grant access to. Return type: dict Returns: **Response Syntax** { 'AuthorizedPrincipal': { 'PrincipalType': 'AWS_ACCOUNT'|'AWS_SERVICE', 'Principal': 'string' } } **Response Structure** * *(dict) --* * **AuthorizedPrincipal** *(dict) --* Information about the Amazon Web Services account or service that was provided access to the domain. * **PrincipalType** *(string) --* The type of principal. * **Principal** *(string) --* The IAM principal that is allowed access to the domain. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.BaseException" OpenSearchService / Client / create_vpc_endpoint create_vpc_endpoint ******************* OpenSearchService.Client.create_vpc_endpoint(**kwargs) Creates an Amazon OpenSearch Service-managed VPC endpoint. See also: AWS API Documentation **Request Syntax** response = client.create_vpc_endpoint( DomainArn='string', VpcOptions={ 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, ClientToken='string' ) Parameters: * **DomainArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the domain to create the endpoint for. * **VpcOptions** (*dict*) -- **[REQUIRED]** Options to specify the subnets and security groups for the endpoint. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC. * *(string) --* * **ClientToken** (*string*) -- Unique, case-sensitive identifier to ensure idempotency of the request. Return type: dict Returns: **Response Syntax** { 'VpcEndpoint': { 'VpcEndpointId': 'string', 'VpcEndpointOwner': 'string', 'DomainArn': 'string', 'VpcOptions': { 'VPCId': 'string', 'SubnetIds': [ 'string', ], 'AvailabilityZones': [ 'string', ], 'SecurityGroupIds': [ 'string', ] }, 'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED', 'Endpoint': 'string' } } **Response Structure** * *(dict) --* * **VpcEndpoint** *(dict) --* Information about the newly created VPC endpoint. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcEndpointOwner** *(string) --* The creator of the endpoint. * **DomainArn** *(string) --* The Amazon Resource Name (ARN) of the domain associated with the endpoint. * **VpcOptions** *(dict) --* Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. * **VPCId** *(string) --* The ID for your VPC. Amazon VPC generates this value when you create a VPC. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoints for the domain. * *(string) --* * **AvailabilityZones** *(list) --* The list of Availability Zones associated with the VPC subnets. * *(string) --* * **SecurityGroupIds** *(list) --* The list of security group IDs associated with the VPC endpoints for the domain. * *(string) --* * **Status** *(string) --* The current status of the endpoint. * **Endpoint** *(string) --* The connection endpoint ID for connecting to the domain. **Exceptions** * "OpenSearchService.Client.exceptions.ConflictException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.BaseException" OpenSearchService / Client / upgrade_domain upgrade_domain ************** OpenSearchService.Client.upgrade_domain(**kwargs) Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch. See also: AWS API Documentation **Request Syntax** response = client.upgrade_domain( DomainName='string', TargetVersion='string', PerformCheckOnly=True|False, AdvancedOptions={ 'string': 'string' } ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** Name of the OpenSearch Service domain that you want to upgrade. * **TargetVersion** (*string*) -- **[REQUIRED]** OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y. * **PerformCheckOnly** (*boolean*) -- When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade. * **AdvancedOptions** (*dict*) -- Only supports the "override_main_response_version" parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'UpgradeId': 'string', 'DomainName': 'string', 'TargetVersion': 'string', 'PerformCheckOnly': True|False, 'AdvancedOptions': { 'string': 'string' }, 'ChangeProgressDetails': { 'ChangeId': 'string', 'Message': 'string', 'ConfigChangeStatus': 'Pending'|'Initializing'|'Validating'|'ValidationFailed'|'ApplyingChanges'|'Completed'|'PendingUserInput'|'Cancelled', 'InitiatedBy': 'CUSTOMER'|'SERVICE', 'StartTime': datetime(2015, 1, 1), 'LastUpdatedTime': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* Container for the response returned by "UpgradeDomain" operation. * **UpgradeId** *(string) --* The unique identifier of the domain upgrade. * **DomainName** *(string) --* The name of the domain that was upgraded. * **TargetVersion** *(string) --* OpenSearch or Elasticsearch version that the domain was upgraded to. * **PerformCheckOnly** *(boolean) --* When true, indicates that an upgrade eligibility check was performed. * **AdvancedOptions** *(dict) --* The advanced options configuration for the domain. * *(string) --* * *(string) --* * **ChangeProgressDetails** *(dict) --* Container for information about a configuration change happening on a domain. * **ChangeId** *(string) --* The ID of the configuration change. * **Message** *(string) --* A message corresponding to the status of the configuration change. * **ConfigChangeStatus** *(string) --* The current status of the configuration change. * **InitiatedBy** *(string) --* The IAM principal who initiated the configuration change. * **StartTime** *(datetime) --* The time that the configuration change was initiated, in Universal Coordinated Time (UTC). * **LastUpdatedTime** *(datetime) --* The last time that the configuration change was updated. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ResourceAlreadyExistsExcept ion" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.InternalException" OpenSearchService / Client / describe_domain_health describe_domain_health ********************** OpenSearchService.Client.describe_domain_health(**kwargs) Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node. See also: AWS API Documentation **Request Syntax** response = client.describe_domain_health( DomainName='string' ) Parameters: **DomainName** (*string*) -- **[REQUIRED]** The name of the domain. Return type: dict Returns: **Response Syntax** { 'DomainState': 'Active'|'Processing'|'NotAvailable', 'AvailabilityZoneCount': 'string', 'ActiveAvailabilityZoneCount': 'string', 'StandByAvailabilityZoneCount': 'string', 'DataNodeCount': 'string', 'DedicatedMaster': True|False, 'MasterEligibleNodeCount': 'string', 'WarmNodeCount': 'string', 'MasterNode': 'Available'|'UnAvailable', 'ClusterHealth': 'Red'|'Yellow'|'Green'|'NotAvailable', 'TotalShards': 'string', 'TotalUnAssignedShards': 'string', 'EnvironmentInformation': [ { 'AvailabilityZoneInformation': [ { 'AvailabilityZoneName': 'string', 'ZoneStatus': 'Active'|'StandBy'|'NotAvailable', 'ConfiguredDataNodeCount': 'string', 'AvailableDataNodeCount': 'string', 'TotalShards': 'string', 'TotalUnAssignedShards': 'string' }, ] }, ] } **Response Structure** * *(dict) --* The result of a "DescribeDomainHealth" request. Contains health information for the requested domain. * **DomainState** *(string) --* The current state of the domain. * "Processing" - The domain has updates in progress. * "Active" - Requested changes have been processed and deployed to the domain. * **AvailabilityZoneCount** *(string) --* The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return "NotAvailable". * **ActiveAvailabilityZoneCount** *(string) --* The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return "NotAvailable". * **StandByAvailabilityZoneCount** *(string) --* The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return "NotAvailable". * **DataNodeCount** *(string) --* The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return "NotAvailable". * **DedicatedMaster** *(boolean) --* A boolean that indicates if dedicated master nodes are activated for the domain. * **MasterEligibleNodeCount** *(string) --* The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return "NotAvailable". * **WarmNodeCount** *(string) --* The number of warm nodes configured for the domain. * **MasterNode** *(string) --* Indicates whether the domain has an elected master node. * **Available** - The domain has an elected master node. * **UnAvailable** - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached. * **ClusterHealth** *(string) --* The current health status of your cluster. * "Red" - At least one primary shard is not allocated to any node. * "Yellow" - All primary shards are allocated to nodes, but some replicas aren’t. * "Green" - All primary shards and their replicas are allocated to nodes. * "NotAvailable" - Unable to retrieve cluster health. * **TotalShards** *(string) --* The total number of primary and replica shards for the domain. * **TotalUnAssignedShards** *(string) --* The total number of primary and replica shards not allocated to any of the nodes for the cluster. * **EnvironmentInformation** *(list) --* A list of "EnvironmentInfo" for the domain. * *(dict) --* Information about the active domain environment. * **AvailabilityZoneInformation** *(list) --* A list of "AvailabilityZoneInfo" for the domain. * *(dict) --* Information about an Availability Zone on a domain. * **AvailabilityZoneName** *(string) --* The name of the Availability Zone. * **ZoneStatus** *(string) --* The current state of the Availability Zone. Current options are "Active" and "StandBy". * "Active" - Data nodes in the Availability Zone are in use. * "StandBy" - Data nodes in the Availability Zone are in a standby state. * "NotAvailable" - Unable to retrieve information. * **ConfiguredDataNodeCount** *(string) --* The total number of data nodes configured in the Availability Zone. * **AvailableDataNodeCount** *(string) --* The number of data nodes active in the Availability Zone. * **TotalShards** *(string) --* The total number of primary and replica shards in the Availability Zone. * **TotalUnAssignedShards** *(string) --* The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / accept_inbound_connection accept_inbound_connection ************************* OpenSearchService.Client.accept_inbound_connection(**kwargs) Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service. See also: AWS API Documentation **Request Syntax** response = client.accept_inbound_connection( ConnectionId='string' ) Parameters: **ConnectionId** (*string*) -- **[REQUIRED]** The ID of the inbound connection to accept. Return type: dict Returns: **Response Syntax** { 'Connection': { 'LocalDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'RemoteDomainInfo': { 'AWSDomainInformation': { 'OwnerId': 'string', 'DomainName': 'string', 'Region': 'string' } }, 'ConnectionId': 'string', 'ConnectionStatus': { 'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED', 'Message': 'string' }, 'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT' } } **Response Structure** * *(dict) --* Contains details about the accepted inbound connection. * **Connection** *(dict) --* Information about the accepted inbound connection. * **LocalDomainInfo** *(dict) --* Information about the source (local) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **RemoteDomainInfo** *(dict) --* Information about the destination (remote) domain. * **AWSDomainInformation** *(dict) --* Information about an Amazon OpenSearch Service domain. * **OwnerId** *(string) --* The Amazon Web Services account ID of the domain owner. * **DomainName** *(string) --* Name of the domain. * **Region** *(string) --* The Amazon Web Services Region in which the domain is located. * **ConnectionId** *(string) --* The unique identifier of the connection. * **ConnectionStatus** *(dict) --* The current status of the connection. * **StatusCode** *(string) --* The status code for the connection. Can be one of the following: * **PENDING_ACCEPTANCE** - Inbound connection is not yet accepted by the remote domain owner. * **APPROVED**: Inbound connection is pending acceptance by the remote domain owner. * **PROVISIONING**: Inbound connection is being provisioned. * **ACTIVE**: Inbound connection is active and ready to use. * **REJECTING**: Inbound connection rejection is in process. * **REJECTED**: Inbound connection is rejected. * **DELETING**: Inbound connection deletion is in progress. * **DELETED**: Inbound connection is deleted and can no longer be used. * **Message** *(string) --* Information about the connection. * **ConnectionMode** *(string) --* The connection mode. **Exceptions** * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.LimitExceededException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / get_application get_application *************** OpenSearchService.Client.get_application(**kwargs) Retrieves the configuration and status of an existing OpenSearch application. See also: AWS API Documentation **Request Syntax** response = client.get_application( id='string' ) Parameters: **id** (*string*) -- **[REQUIRED]** The unique identifier of the OpenSearch application to retrieve. Return type: dict Returns: **Response Syntax** { 'id': 'string', 'arn': 'string', 'name': 'string', 'endpoint': 'string', 'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED', 'iamIdentityCenterOptions': { 'enabled': True|False, 'iamIdentityCenterInstanceArn': 'string', 'iamRoleForIdentityCenterApplicationArn': 'string', 'iamIdentityCenterApplicationArn': 'string' }, 'dataSources': [ { 'dataSourceArn': 'string', 'dataSourceDescription': 'string' }, ], 'appConfigs': [ { 'key': 'opensearchDashboards.dashboardAdmin.users'|'opensearchDashboards.dashboardAdmin.groups', 'value': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **id** *(string) --* The unique identifier of the OpenSearch application. * **arn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **name** *(string) --* The name of the OpenSearch application. * **endpoint** *(string) --* The endpoint URL of the OpenSearch application. * **status** *(string) --* The current status of the OpenSearch application. Possible values: "CREATING", "UPDATING", "DELETING", "FAILED", "ACTIVE", and "DELETED". * **iamIdentityCenterOptions** *(dict) --* The IAM Identity Center settings configured for the OpenSearch application. * **enabled** *(boolean) --* Indicates whether IAM Identity Center is enabled for the OpenSearch application. * **iamIdentityCenterInstanceArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **iamRoleForIdentityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role assigned to the IAM Identity Center application for the OpenSearch application. * **iamIdentityCenterApplicationArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **dataSources** *(list) --* The data sources associated with the OpenSearch application. * *(dict) --* Data sources that are associated with an OpenSearch application. * **dataSourceArn** *(string) --* The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in *Using Amazon Web Services Identity and Access Management* for more information. * **dataSourceDescription** *(string) --* Detailed description of a data source. * **appConfigs** *(list) --* The configuration settings of the OpenSearch application. * *(dict) --* Configuration settings for an OpenSearch application. For more information, see see Using the OpenSearch user interface in Amazon OpenSearch Service. * **key** *(string) --* The configuration item to set, such as the admin role for the OpenSearch application. * **value** *(string) --* The value assigned to the configuration key, such as an IAM user ARN. * **createdAt** *(datetime) --* The timestamp when the OpenSearch application was created. * **lastUpdatedAt** *(datetime) --* The timestamp of the last update to the OpenSearch application. **Exceptions** * "OpenSearchService.Client.exceptions.BaseException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.ValidationException" * "OpenSearchService.Client.exceptions.AccessDeniedException" * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.DisabledOperationException" OpenSearchService / Client / list_vpc_endpoints_for_domain list_vpc_endpoints_for_domain ***************************** OpenSearchService.Client.list_vpc_endpoints_for_domain(**kwargs) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain. See also: AWS API Documentation **Request Syntax** response = client.list_vpc_endpoints_for_domain( DomainName='string', NextToken='string' ) Parameters: * **DomainName** (*string*) -- **[REQUIRED]** The name of the domain to list associated VPC endpoints for. * **NextToken** (*string*) -- If your initial "ListEndpointsForDomain" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListEndpointsForDomain" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'VpcEndpointSummaryList': [ { 'VpcEndpointId': 'string', 'VpcEndpointOwner': 'string', 'DomainArn': 'string', 'Status': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **VpcEndpointSummaryList** *(list) --* Information about each endpoint associated with the domain. * *(dict) --* Summary information for an Amazon OpenSearch Service- managed VPC endpoint. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcEndpointOwner** *(string) --* The creator of the endpoint. * **DomainArn** *(string) --* The Amazon Resource Name (ARN) of the domain associated with the endpoint. * **Status** *(string) --* The current status of the endpoint. * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page. **Exceptions** * "OpenSearchService.Client.exceptions.InternalException" * "OpenSearchService.Client.exceptions.DisabledOperationException" * "OpenSearchService.Client.exceptions.ResourceNotFoundException" * "OpenSearchService.Client.exceptions.BaseException"