Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains.
For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs.
The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
", "operations": { "AcceptInboundConnection": "Allows the remote domain owner to accept an inbound cross-cluster connection request.
", "AddTags": "Attaches tags to an existing domain. Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information.
", "AssociatePackage": "Associates a package with an Amazon OpenSearch Service domain.
", "CancelServiceSoftwareUpdate": "Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.
", "CreateOutboundConnection": "Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
", "CreatePackage": "Create a package for use with Amazon OpenSearch Service domains.
", "DeleteDomain": "Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.
", "DeleteInboundConnection": "Allows the remote domain owner to delete an existing inbound cross-cluster connection.
", "DeleteOutboundConnection": "Allows the local domain owner to delete an existing outbound cross-cluster connection.
", "DeletePackage": "Deletes the package.
", "DescribeDomain": "Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
", "DescribeDomainAutoTunes": "Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
", "DescribeDomainConfig": "Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
", "DescribeDomains": "Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
", "DescribeInboundConnections": "Lists all the inbound cross-cluster connections for a remote domain.
", "DescribeInstanceTypeLimits": " Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.
Lists all the outbound cross-cluster connections for a local domain.
", "DescribePackages": "Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.
", "DescribeReservedInstanceOfferings": "Lists available reserved OpenSearch instance offerings.
", "DescribeReservedInstances": "Returns information about reserved OpenSearch instances for this account.
", "DissociatePackage": "Dissociates a package from the Amazon OpenSearch Service domain.
", "GetCompatibleVersions": " Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain.
Returns a list of package versions, along with their creation time and commit message.
", "GetUpgradeHistory": "Retrieves the complete history of the last 10 upgrades performed on the domain.
", "GetUpgradeStatus": "Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
", "ListDomainNames": "Returns the names of all domains owned by the current user's account.
", "ListDomainsForPackage": "Lists all Amazon OpenSearch Service domains associated with the package.
", "ListInstanceTypeDetails": null, "ListPackagesForDomain": "Lists all packages associated with the Amazon OpenSearch Service domain.
", "ListTags": "Returns all tags for the given domain.
", "ListVersions": "List all supported versions of OpenSearch and Elasticsearch.
", "PurchaseReservedInstanceOffering": "Allows you to purchase reserved OpenSearch instances.
", "RejectInboundConnection": "Allows the remote domain owner to reject an inbound cross-cluster connection request.
", "RemoveTags": "Removes the specified set of tags from the given domain.
", "StartServiceSoftwareUpdate": "Schedules a service software update for an Amazon OpenSearch Service domain.
", "UpdateDomainConfig": "Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
", "UpdatePackage": "Updates a package for use with Amazon OpenSearch Service domains.
", "UpgradeDomain": "Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
" }, "shapes": { "ARN": { "base": "The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
", "refs": { "AddTagsRequest$ARN": "Specify the ARN of the domain you want to add tags to.
The ACM certificate ARN for your custom endpoint.
", "DomainStatus$ARN": "The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.
", "ListTagsRequest$ARN": "Specify the ARN of the domain that the tags you want to view are attached to.
ARN for the master user (if IAM is enabled).
", "RemoveTagsRequest$ARN": "The ARN of the domain from which you want to delete the specified tags.
Container for the parameters to the AcceptInboundConnection operation.
The result of an AcceptInboundConnection operation. Contains details about the accepted inbound connection.
An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
", "refs": { } }, "AccessPoliciesStatus": { "base": "The configured access rules for the domain's document and search endpoints, and the current status of those rules.
", "refs": { "DomainConfig$AccessPolicies": "IAM access policy as a JSON-formatted string.
" } }, "AddTagsRequest": { "base": "Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.
List of limits that are specific to a given InstanceType and for each of its InstanceRole .
List of additional limits that are specific to a given InstanceType and for each of its InstanceRole .
Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:
false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information. For more information, see Advanced cluster parameters.
", "refs": { "AdvancedOptionsStatus$Options": "The status of advanced options for the specified domain.
", "CreateDomainRequest$AdvancedOptions": "Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
The status of the AdvancedOptions.
Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced options for more information.
Status of the advanced options for the specified domain. Currently, the following advanced options are available:
false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information. For more information, see Advanced cluster parameters.
", "refs": { "DomainConfig$AdvancedOptions": "The AdvancedOptions for the domain. See Advanced options for more information.
The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.
", "refs": { "AdvancedSecurityOptionsStatus$Options": "Advanced security options for the specified domain.
", "DomainStatus$AdvancedSecurityOptions": "The current status of the domain's advanced security options.
" } }, "AdvancedSecurityOptionsInput": { "base": "The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).
", "refs": { "CreateDomainRequest$AdvancedSecurityOptions": "Specifies advanced security options.
", "UpdateDomainConfigRequest$AdvancedSecurityOptions": "Specifies advanced security options.
" } }, "AdvancedSecurityOptionsStatus": { "base": "The status of advanced security options for the specified domain.
", "refs": { "DomainConfig$AdvancedSecurityOptions": "Specifies AdvancedSecurityOptions for the domain.
Container for the request parameters to the AssociatePackage operation.
Container for the response returned by AssociatePackage operation.
Specifies the Auto-Tune type and Auto-Tune action details.
", "refs": { "AutoTuneList$member": null } }, "AutoTuneDate": { "base": "The timestamp of the Auto-Tune action scheduled for the domain.
", "refs": { "ScheduledAutoTuneDetails$Date": "The timestamp of the Auto-Tune action scheduled for the domain.
" } }, "AutoTuneDesiredState": { "base": "The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
", "refs": { "AutoTuneOptions$DesiredState": "The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
", "AutoTuneOptionsInput$DesiredState": "The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
" } }, "AutoTuneDetails": { "base": "Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
", "refs": { "AutoTune$AutoTuneDetails": "Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "AutoTuneList": { "base": null, "refs": { "DescribeDomainAutoTunesResponse$AutoTunes": "The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "AutoTuneMaintenanceSchedule": { "base": "Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
", "refs": { "AutoTuneMaintenanceScheduleList$member": null } }, "AutoTuneMaintenanceScheduleList": { "base": null, "refs": { "AutoTuneOptions$MaintenanceSchedules": "A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
", "AutoTuneOptionsInput$MaintenanceSchedules": "A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "AutoTuneOptions": { "base": "The Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.
", "refs": { "AutoTuneOptionsStatus$Options": "Specifies Auto-Tune options for the domain.
", "UpdateDomainConfigRequest$AutoTuneOptions": "Specifies Auto-Tune options.
" } }, "AutoTuneOptionsInput": { "base": "The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
", "refs": { "CreateDomainRequest$AutoTuneOptions": "Specifies Auto-Tune options.
" } }, "AutoTuneOptionsOutput": { "base": "The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
", "refs": { "DomainStatus$AutoTuneOptions": "The current status of the domain's Auto-Tune options.
" } }, "AutoTuneOptionsStatus": { "base": "The Auto-Tune status for the domain.
", "refs": { "DomainConfig$AutoTuneOptions": "Specifies AutoTuneOptions for the domain.
The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.
", "refs": { "AutoTuneOptionsOutput$State": "The AutoTuneState for the domain.
The AutoTuneState for the domain.
Provides the current Auto-Tune status for the domain.
", "refs": { "AutoTuneOptionsStatus$Status": "The status of the Auto-Tune options for the domain.
" } }, "AutoTuneType": { "base": "Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
", "refs": { "AutoTune$AutoTuneType": "Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
" } }, "BackendRole": { "base": null, "refs": { "SAMLOptionsInput$MasterBackendRole": "The backend role that the SAML master user is mapped to.
" } }, "BaseException": { "base": "An error occurred while processing the request.
", "refs": { } }, "Boolean": { "base": null, "refs": { "AdvancedSecurityOptions$Enabled": "True if advanced security is enabled.
", "AdvancedSecurityOptions$InternalUserDatabaseEnabled": "True if the internal user database is enabled.
", "AdvancedSecurityOptions$AnonymousAuthEnabled": "True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
", "AdvancedSecurityOptionsInput$Enabled": "True if advanced security is enabled.
", "AdvancedSecurityOptionsInput$InternalUserDatabaseEnabled": "True if the internal user database is enabled.
", "AdvancedSecurityOptionsInput$AnonymousAuthEnabled": "True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
", "AutoTuneStatus$PendingDeletion": "Indicates whether the domain is being deleted.
", "ClusterConfig$DedicatedMasterEnabled": "A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.
", "ClusterConfig$ZoneAwarenessEnabled": "A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
", "ClusterConfig$WarmEnabled": "True to enable UltraWarm storage.
", "CognitoOptions$Enabled": "The option to enable Cognito for OpenSearch Dashboards authentication.
", "ColdStorageOptions$Enabled": "Enable cold storage option. Accepted values true or false
", "DomainEndpointOptions$EnforceHTTPS": "Whether only HTTPS endpoint should be enabled for the domain.
", "DomainEndpointOptions$CustomEndpointEnabled": "Whether to enable a custom endpoint for the domain.
", "DomainStatus$Created": "The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.
The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
The status of the domain configuration. True if Amazon OpenSearch Service is processing configuration changes. False if the configuration is active.
The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.
Whether EBS-based storage is enabled.
", "EncryptionAtRestOptions$Enabled": "The option to enable encryption at rest.
", "InstanceTypeDetails$EncryptionEnabled": null, "InstanceTypeDetails$CognitoEnabled": null, "InstanceTypeDetails$AppLogsEnabled": null, "InstanceTypeDetails$AdvancedSecurityEnabled": null, "InstanceTypeDetails$WarmEnabled": null, "LogPublishingOption$Enabled": "Whether the given log publishing option is enabled or not.
", "NodeToNodeEncryptionOptions$Enabled": "True to enable node-to-node encryption.
", "OptionStatus$PendingDeletion": "Indicates whether the domain is being deleted.
", "SAMLOptionsInput$Enabled": "True if SAML is enabled.
", "SAMLOptionsOutput$Enabled": "True if SAML is enabled.
", "ServiceSoftwareOptions$UpdateAvailable": " True if you're able to update your service software version. False if you can't update your service software version.
True if you're able to cancel your service software version update. False if you can't cancel your service software update.
True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
", "UpgradeDomainResponse$PerformCheckOnly": "When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
" } }, "CancelServiceSoftwareUpdateRequest": { "base": "Container for the parameters to the CancelServiceSoftwareUpdate operation. Specifies the name of the domain that you wish to cancel a service software update on.
The result of a CancelServiceSoftwareUpdate operation. Contains the status of the update.
ARN of the Cloudwatch log group to publish logs to.
", "refs": { "LogPublishingOption$CloudWatchLogsLogGroupArn": null } }, "ClusterConfig": { "base": "The configuration for the domain cluster, such as the type and number of instances.
", "refs": { "ClusterConfigStatus$Options": "The cluster configuration for the specified domain.
", "CreateDomainRequest$ClusterConfig": "Configuration options for a domain. Specifies the instance type and number of instances in the domain.
", "DomainStatus$ClusterConfig": "The type and number of instances in the domain.
", "UpdateDomainConfigRequest$ClusterConfig": "The type and number of instances to instantiate for the domain cluster.
" } }, "ClusterConfigStatus": { "base": "The configuration status for the specified domain.
", "refs": { "DomainConfig$ClusterConfig": "The ClusterConfig for the domain.
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
", "refs": { "CognitoOptionsStatus$Options": "Cognito options for the specified domain.
", "CreateDomainRequest$CognitoOptions": "Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
", "DomainStatus$CognitoOptions": "The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
" } }, "CognitoOptionsStatus": { "base": "The status of the Cognito options for the specified domain.
", "refs": { "DomainConfig$CognitoOptions": "The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
Specifies the configuration for cold storage options such as enabled
", "refs": { "ClusterConfig$ColdStorageOptions": "Specifies the ColdStorageOptions config for a Domain
A message associated with the package version.
", "UpdatePackageRequest$CommitMessage": "A commit message for the new version which is shown as part of GetPackageVersionHistoryResponse.
A map of compatible OpenSearch versions returned as part of the GetCompatibleVersions operation.
A map from an EngineVersion to a list of compatible EngineVersion s to which the domain can be upgraded.
An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
", "refs": { } }, "ConnectionAlias": { "base": null, "refs": { "CreateOutboundConnectionRequest$ConnectionAlias": "The connection alias used used by the customer for this cross-cluster connection.
", "CreateOutboundConnectionResponse$ConnectionAlias": "The connection alias provided during the create connection request.
", "OutboundConnection$ConnectionAlias": "The connection alias for the outbound cross-cluster connection.
" } }, "ConnectionId": { "base": null, "refs": { "AcceptInboundConnectionRequest$ConnectionId": "The ID of the inbound connection you want to accept.
", "CreateOutboundConnectionResponse$ConnectionId": "The unique ID for the created outbound connection, which is used for subsequent operations on the connection.
", "DeleteInboundConnectionRequest$ConnectionId": "The ID of the inbound connection to permanently delete.
", "DeleteOutboundConnectionRequest$ConnectionId": "The ID of the outbound connection you want to permanently delete.
", "InboundConnection$ConnectionId": "The connection ID for the inbound cross-cluster connection.
", "OutboundConnection$ConnectionId": "The connection ID for the outbound cross-cluster connection.
", "RejectInboundConnectionRequest$ConnectionId": "The ID of the inbound connection to reject.
" } }, "ConnectionStatusMessage": { "base": null, "refs": { "InboundConnectionStatus$Message": "Verbose information for the inbound connection status.
", "OutboundConnectionStatus$Message": "Verbose information for the outbound connection status.
" } }, "CreateDomainRequest": { "base": null, "refs": { } }, "CreateDomainResponse": { "base": "The result of a CreateDomain operation. Contains the status of the newly created Amazon OpenSearch Service domain.
Container for the parameters to the CreateOutboundConnection operation.
The result of a CreateOutboundConnection request. Contains the details about the newly created cross-cluster connection.
Container for request parameters to the CreatePackage operation.
Container for the response returned by the CreatePackage operation.
The timestamp of when the package was created.
", "PackageVersionHistory$CreatedAt": "The timestamp of when the package was created.
" } }, "DeleteDomainRequest": { "base": "Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.
The result of a DeleteDomain request. Contains the status of the pending deletion, or a \"domain not found\" error if the domain and all of its resources have been deleted.
Container for the parameters to the DeleteInboundConnection operation.
The result of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.
Container for the parameters to the DeleteOutboundConnection operation.
The result of a DeleteOutboundConnection operation. Contains details about the deleted outbound connection.
Container for the request parameters to the DeletePackage operation.
Container for the response parameters to the DeletePackage operation.
The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
" } }, "DeploymentStatus": { "base": null, "refs": { "ServiceSoftwareOptions$UpdateStatus": "The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.
Specifies the way in which Amazon OpenSearch Service applies the update. Possible responses are Blue/Green (the update requires a blue/green deployment), DynamicUpdate (no blue/green required), Undetermined (the domain is undergoing an update and can't predict the deployment type; try again after the update is complete), and None (the request doesn't include any configuration changes).
Container for the parameters to the DescribeDomainAutoTunes operation.
The result of a DescribeDomainAutoTunes request. See Auto-Tune for Amazon OpenSearch Service for more information.
Container for the parameters to the DescribeDomainConfig operation. Specifies the domain name for which you want configuration information.
The result of a DescribeDomainConfig request. Contains the configuration information of the requested domain.
Container for the parameters to the DescribeDomain operation.
The result of a DescribeDomain request. Contains the status of the domain specified in the request.
Container for the parameters to the DescribeDomains operation. By default, the API returns the status of all domains.
The result of a DescribeDomains request. Contains the status of the specified domains or all domains owned by the account.
Container for the parameters to the DescribeInboundConnections operation.
The result of a DescribeInboundConnections request. Contains a list of connections matching the filter criteria.
Container for the parameters to the DescribeInstanceTypeLimits operation.
Container for the parameters received from the DescribeInstanceTypeLimits operation.
Container for the parameters to the DescribeOutboundConnections operation.
The result of a DescribeOutboundConnections request. Contains the list of connections matching the filter criteria.
A filter to apply to the DescribePackage response.
A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.
Only returns packages that match the DescribePackagesFilterList values.
Any field from PackageDetails.
A list of values for the specified field.
" } }, "DescribePackagesRequest": { "base": " Container for the request parameters to the DescribePackage operation.
Container for the response returned by the DescribePackages operation.
Container for parameters to DescribeReservedInstanceOfferings
Container for results from DescribeReservedInstanceOfferings
Container for parameters to DescribeReservedInstances
Container for results from DescribeReservedInstances
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
" } }, "DisabledOperationException": { "base": "An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
", "refs": { } }, "DissociatePackageRequest": { "base": " Container for the request parameters to the DissociatePackage operation.
Container for the response returned by DissociatePackage operation.
The configuration of a domain.
", "refs": { "DescribeDomainConfigResponse$DomainConfig": "The configuration information of the domain requested in the DescribeDomainConfig request.
The status of the updated domain.
" } }, "DomainEndpointOptions": { "base": "Options to configure the endpoint for the domain.
", "refs": { "CreateDomainRequest$DomainEndpointOptions": "Options to specify configurations that will be applied to the domain endpoint.
", "DomainEndpointOptionsStatus$Options": "Options to configure the endpoint for the domain.
", "DomainStatus$DomainEndpointOptions": "The current status of the domain's endpoint options.
", "UpdateDomainConfigRequest$DomainEndpointOptions": "Options to specify configuration that will be applied to the domain endpoint.
" } }, "DomainEndpointOptionsStatus": { "base": "The configured endpoint options for the domain and their current status.
", "refs": { "DomainConfig$DomainEndpointOptions": "The DomainEndpointOptions for the domain.
Unique identifier for the domain.
", "refs": { "DomainStatus$DomainId": "The unique identifier for the specified domain.
" } }, "DomainInfo": { "base": null, "refs": { "DomainInfoList$member": null } }, "DomainInfoList": { "base": "Contains the list of domain information.
", "refs": { "ListDomainNamesResponse$DomainNames": "List of domain names and respective engine types.
" } }, "DomainInformationContainer": { "base": null, "refs": { "CreateOutboundConnectionRequest$LocalDomainInfo": "The AWSDomainInformation for the local OpenSearch domain.
The AWSDomainInformation for the remote OpenSearch domain.
The AWSDomainInformation for the local OpenSearch domain.
The AWSDomainInformation for the remote OpenSearch domain.
The AWSDomainInformation for the local OpenSearch domain.
The AWSDomainInformation for the remote OpenSearch domain.
The DomainInformation for the local OpenSearch domain.
The DomainInformation for the remote OpenSearch domain.
The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
", "refs": { "AWSDomainInformation$DomainName": null, "AssociatePackageRequest$DomainName": "The name of the domain to associate the package with.
", "CancelServiceSoftwareUpdateRequest$DomainName": "The name of the domain that you want to stop the latest service software update on.
", "CreateDomainRequest$DomainName": "The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
", "DeleteDomainRequest$DomainName": "The name of the domain you want to permanently delete.
", "DescribeDomainAutoTunesRequest$DomainName": "The domain name for which you want Auto-Tune action details.
", "DescribeDomainConfigRequest$DomainName": "The domain you want to get information about.
", "DescribeDomainRequest$DomainName": "The name of the domain for which you want information.
", "DescribeInstanceTypeLimitsRequest$DomainName": " The name of the domain you want to modify. Only include this value if you're querying OpenSearch Limits for an existing domain.
The name of the domain to associate the package with.
", "DomainInfo$DomainName": "The DomainName.
The name of the domain you've associated a package with.
", "DomainStatus$DomainName": "The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
", "GetCompatibleVersionsRequest$DomainName": null, "GetUpgradeHistoryRequest$DomainName": null, "GetUpgradeStatusRequest$DomainName": null, "ListInstanceTypeDetailsRequest$DomainName": null, "ListPackagesForDomainRequest$DomainName": "The name of the domain for which you want to list associated packages.
", "StartServiceSoftwareUpdateRequest$DomainName": "The name of the domain that you want to update to the latest service software.
", "UpdateDomainConfigRequest$DomainName": "The name of the domain you're updating.
", "UpgradeDomainRequest$DomainName": null, "UpgradeDomainResponse$DomainName": null } }, "DomainNameFqdn": { "base": null, "refs": { "DomainEndpointOptions$CustomEndpoint": "The fully qualified domain for your custom endpoint.
" } }, "DomainNameList": { "base": "A list of domain names.
", "refs": { "DescribeDomainsRequest$DomainNames": "The domains for which you want information.
" } }, "DomainPackageDetails": { "base": "Information on a package associated with a domain.
", "refs": { "AssociatePackageResponse$DomainPackageDetails": " DomainPackageDetails
DomainPackageDetails
List of DomainPackageDetails objects.
List of DomainPackageDetails objects.
State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.
" } }, "DomainStatus": { "base": "The current status of a domain.
", "refs": { "CreateDomainResponse$DomainStatus": "The status of the newly created domain.
", "DeleteDomainResponse$DomainStatus": "The status of the domain being deleted.
", "DescribeDomainResponse$DomainStatus": "The current status of the domain.
", "DomainStatusList$member": null } }, "DomainStatusList": { "base": "A list that contains the status of each requested domain.
", "refs": { "DescribeDomainsResponse$DomainStatusList": "The status of the domains requested in the DescribeDomains request.
The monetary amount of the recurring charge.
", "ReservedInstance$FixedPrice": "The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.
", "ReservedInstance$UsagePrice": "The rate you are charged for each hour for the domain that is using this reserved instance.
", "ReservedInstanceOffering$FixedPrice": "The upfront fixed charge you will pay to purchase the specific reserved OpenSearch instance offering.
", "ReservedInstanceOffering$UsagePrice": "The rate you are charged for each hour the domain that is using the offering is running.
", "UpgradeStepItem$ProgressPercent": "The floating point value representing the progress percentage of a particular step.
" } }, "DryRun": { "base": null, "refs": { "UpdateDomainConfigRequest$DryRun": "This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) without actually applying the change.
Contains result of DryRun.
" } }, "Duration": { "base": "The maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
", "refs": { "AutoTuneMaintenanceSchedule$Duration": "Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "DurationValue": { "base": "Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
", "refs": { "Duration$Value": "Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "EBSOptions": { "base": "Options to enable, disable, and specify the properties of EBS storage volumes.
", "refs": { "CreateDomainRequest$EBSOptions": "Options to enable, disable, and specify the type and size of EBS storage volumes.
", "DomainStatus$EBSOptions": "The EBSOptions for the specified domain.
The EBS options for the specified domain.
", "UpdateDomainConfigRequest$EBSOptions": "Specify the type and size of the EBS volume to use.
" } }, "EBSOptionsStatus": { "base": "Status of the EBS options for the specified domain.
", "refs": { "DomainConfig$EBSOptions": "The EBSOptions for the domain.
Specifies encryption at rest options.
", "refs": { "CreateDomainRequest$EncryptionAtRestOptions": "Options for encryption of data at rest.
", "DomainStatus$EncryptionAtRestOptions": "The status of the EncryptionAtRestOptions.
The Encryption At Rest options for the specified domain.
", "UpdateDomainConfigRequest$EncryptionAtRestOptions": "Specifies encryption of data at rest options.
" } }, "EncryptionAtRestOptionsStatus": { "base": "Status of the encryption At Rest options for the specified domain.
", "refs": { "DomainConfig$EncryptionAtRestOptions": "The EncryptionAtRestOptions for the domain.
Map containing the domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
Specifies the EngineType of the domain.
Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.
" } }, "ErrorDetails": { "base": null, "refs": { "DomainPackageDetails$ErrorDetails": "Additional information if the package is in an error state. Null otherwise.
", "PackageDetails$ErrorDetails": "Additional information if the package is in an error state. Null otherwise.
" } }, "ErrorMessage": { "base": null, "refs": { "BaseException$message": "A description of the error.
", "ErrorDetails$ErrorMessage": null } }, "ErrorType": { "base": null, "refs": { "ErrorDetails$ErrorType": null } }, "Filter": { "base": "A filter used to limit results when describing inbound or outbound cross-cluster connections. Multiple values can be specified per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
", "refs": { "FilterList$member": null } }, "FilterList": { "base": null, "refs": { "DescribeInboundConnectionsRequest$Filters": " A list of filters used to match properties for inbound cross-cluster connections. Available Filter values are:
A list of filters used to match properties for outbound cross-cluster connections. Available Filter names for this operation are:
The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
", "DescribeReservedInstancesRequest$ReservedInstanceId": "The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
", "PurchaseReservedInstanceOfferingRequest$ReservedInstanceOfferingId": "The ID of the reserved OpenSearch instance offering to purchase.
", "PurchaseReservedInstanceOfferingResponse$ReservedInstanceId": "Details of the reserved OpenSearch instance which was purchased.
", "ReservedInstance$ReservedInstanceId": "The unique identifier for the reservation.
", "ReservedInstanceOffering$ReservedInstanceOfferingId": "The OpenSearch reserved instance offering identifier.
" } }, "GetCompatibleVersionsRequest": { "base": " Container for the request parameters to GetCompatibleVersions operation.
Container for the response returned by the GetCompatibleVersions operation.
Container for the request parameters to the GetPackageVersionHistory operation.
Container for response returned by GetPackageVersionHistory operation.
Container for the request parameters to the GetUpgradeHistory operation.
Container for the response returned by the GetUpgradeHistory operation.
Container for the request parameters to the GetUpgradeStatus operation.
Container for the response returned by the GetUpgradeStatus operation.
The Cognito identity pool ID for OpenSearch Dashboards authentication.
" } }, "InboundConnection": { "base": "Details of an inbound connection.
", "refs": { "AcceptInboundConnectionResponse$Connection": "The InboundConnection of the accepted inbound connection.
The InboundConnection of the deleted inbound connection.
The InboundConnection of the rejected inbound connection.
The connection status of an inbound cross-cluster connection.
", "refs": { "InboundConnection$ConnectionStatus": "The InboundConnectionStatus for the outbound connection.
The state code for the inbound connection. Can be one of the following:
A list of InboundConnection matching the specified filter criteria.
The number of EC2 instances in the domain.
", "refs": { "PurchaseReservedInstanceOfferingRequest$InstanceCount": "The number of OpenSearch instances to reserve.
" } }, "InstanceCountLimits": { "base": "InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType.
", "refs": { "InstanceLimits$InstanceCountLimits": null } }, "InstanceLimits": { "base": "InstanceLimits represents the list of instance-related attributes that are available for a given InstanceType.
", "refs": { "Limits$InstanceLimits": null } }, "InstanceRole": { "base": null, "refs": { "InstanceRoleList$member": null, "LimitsByRole$key": null } }, "InstanceRoleList": { "base": null, "refs": { "InstanceTypeDetails$InstanceRole": null } }, "InstanceTypeDetails": { "base": null, "refs": { "InstanceTypeDetailsList$member": null } }, "InstanceTypeDetailsList": { "base": null, "refs": { "ListInstanceTypeDetailsResponse$InstanceTypeDetails": null } }, "Integer": { "base": null, "refs": { "ReservedInstance$Duration": "The duration, in seconds, for which the OpenSearch instance is reserved.
", "ReservedInstance$InstanceCount": "The number of OpenSearch instances that have been reserved.
", "ReservedInstanceOffering$Duration": "The duration, in seconds, for which the offering will reserve the OpenSearch instance.
" } }, "IntegerClass": { "base": null, "refs": { "ClusterConfig$InstanceCount": "The number of instances in the specified domain cluster.
", "ClusterConfig$DedicatedMasterCount": "Total number of dedicated master nodes, active and on standby, for the cluster.
", "ClusterConfig$WarmCount": "The number of UltraWarm nodes in the cluster.
", "EBSOptions$VolumeSize": "Integer to specify the size of an EBS volume.
", "EBSOptions$Iops": "The IOPD for a Provisioned IOPS EBS volume (SSD).
", "SAMLOptionsInput$SessionTimeoutMinutes": "The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
", "SAMLOptionsOutput$SessionTimeoutMinutes": "The duration, in minutes, after which a user session becomes inactive.
", "SnapshotOptions$AutomatedSnapshotStartHour": "The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.
" } }, "InternalException": { "base": "The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
", "refs": { } }, "InvalidPaginationTokenException": { "base": "The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
", "refs": { } }, "InvalidTypeException": { "base": "An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
", "refs": { } }, "Issue": { "base": null, "refs": { "Issues$member": null } }, "Issues": { "base": null, "refs": { "UpgradeStepItem$Issues": "A list of strings containing detailed information about the errors encountered in a particular step.
" } }, "KmsKeyId": { "base": null, "refs": { "EncryptionAtRestOptions$KmsKeyId": "The KMS key ID for encryption at rest options.
" } }, "LastUpdated": { "base": null, "refs": { "DomainPackageDetails$LastUpdated": "The timestamp of the most recent update to the package association status.
", "PackageDetails$LastUpdatedAt": null } }, "LimitExceededException": { "base": "An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
", "refs": { } }, "LimitName": { "base": null, "refs": { "AdditionalLimit$LimitName": " Additional limit is specific to a given InstanceType and for each of its InstanceRole etc.
Attributes and their details:
ESPartitionInstanceType can support as master node. ESPartitionInstanceType up to which you don't need any master nodes to govern them. Name of storage limits that are applicable for the given storage type. If StorageType is \"ebs\", the following storage options are applicable:
Value for a given AdditionalLimit$LimitName .
Values for the StorageTypeLimit$LimitName .
Limits for a given InstanceType and for each of its roles.
Limits contains the following: StorageTypes , InstanceLimits , and AdditionalLimits
The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:
Container for the parameters to the ListDomainNames operation.
The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.
Container for the request parameters to the ListDomainsForPackage operation.
Container for the response parameters to the ListDomainsForPackage operation.
Container for the request parameters to the ListPackagesForDomain operation.
Container for the response parameters to the ListPackagesForDomain operation.
Container for the parameters to the ListTags operation. Specify the ARN of the domain that the tags you want to view are attached to.
The result of a ListTags operation. Contains tags for all requested domains.
Container for the parameters to the ListVersions operation.
Use MaxResults to control the maximum number of results to retrieve in a single call.
Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, there are no more results to retrieve.
Container for the parameters for response received from the ListVersions operation.
Log Publishing option that is set for a given domain.
Attributes and their details:
Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
Log publishing options for the given domain.
", "LogPublishingOptionsStatus$Options": "The log publishing options configured for the domain.
", "UpdateDomainConfigRequest$LogPublishingOptions": "Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.
The configured log publishing options for the domain and their current status.
", "refs": { "DomainConfig$LogPublishingOptions": "Log publishing options for the given domain.
" } }, "LogType": { "base": "Type of log file. Can be one of the following:
Credentials for the master user: username and password, ARN, or both.
", "refs": { "AdvancedSecurityOptionsInput$MasterUserOptions": "Credentials for the master user: username and password, ARN, or both.
" } }, "MaxResults": { "base": "Set this value to limit the number of results returned.
", "refs": { "DescribeDomainAutoTunesRequest$MaxResults": "Set this value to limit the number of results returned. If not specified, defaults to 100.
", "DescribeInboundConnectionsRequest$MaxResults": "Set this value to limit the number of results returned. If not specified, defaults to 100.
", "DescribeOutboundConnectionsRequest$MaxResults": "Set this value to limit the number of results returned. If not specified, defaults to 100.
", "DescribePackagesRequest$MaxResults": "Limits results to a maximum number of packages.
", "DescribeReservedInstanceOfferingsRequest$MaxResults": "Set this value to limit the number of results returned. If not specified, defaults to 100.
", "DescribeReservedInstancesRequest$MaxResults": "Set this value to limit the number of results returned. If not specified, defaults to 100.
", "GetPackageVersionHistoryRequest$MaxResults": "Limits results to a maximum number of package versions.
", "GetUpgradeHistoryRequest$MaxResults": null, "ListDomainsForPackageRequest$MaxResults": "Limits the results to a maximum number of domains.
", "ListInstanceTypeDetailsRequest$MaxResults": null, "ListPackagesForDomainRequest$MaxResults": "Limits results to a maximum number of packages.
", "ListVersionsRequest$MaxResults": "Set this value to limit the number of results returned. Value must be greater than 10 or it won't be honored.
" } }, "MaximumInstanceCount": { "base": "Maximum number of instances that can be instantiated for a given InstanceType.
", "refs": { "InstanceCountLimits$MaximumInstanceCount": null } }, "Message": { "base": null, "refs": { "DryRunResults$Message": "Contains an optional message associated with the DryRunResults.
" } }, "MinimumInstanceCount": { "base": "Minimum number of instances that can be instantiated for a given InstanceType.
", "refs": { "InstanceCountLimits$MinimumInstanceCount": null } }, "NextToken": { "base": "Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.
", "refs": { "DescribeDomainAutoTunesRequest$NextToken": "NextToken is sent in case the earlier API call results contain the NextToken. Used for pagination.
", "DescribeDomainAutoTunesResponse$NextToken": "An identifier to allow retrieval of paginated results.
", "DescribeInboundConnectionsRequest$NextToken": "If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
", "DescribeInboundConnectionsResponse$NextToken": "If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
", "DescribeOutboundConnectionsRequest$NextToken": "NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.
", "DescribeOutboundConnectionsResponse$NextToken": "If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
", "DescribePackagesRequest$NextToken": "Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
", "DescribeReservedInstanceOfferingsRequest$NextToken": "Provides an identifier to allow retrieval of paginated results.
", "DescribeReservedInstanceOfferingsResponse$NextToken": "Provides an identifier to allow retrieval of paginated results.
", "DescribeReservedInstancesRequest$NextToken": "Provides an identifier to allow retrieval of paginated results.
", "GetPackageVersionHistoryRequest$NextToken": "Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
", "GetUpgradeHistoryRequest$NextToken": null, "ListDomainsForPackageRequest$NextToken": "Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
", "ListInstanceTypeDetailsRequest$NextToken": null, "ListInstanceTypeDetailsResponse$NextToken": null, "ListPackagesForDomainRequest$NextToken": "Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
", "ListVersionsRequest$NextToken": null, "ListVersionsResponse$NextToken": null } }, "NodeToNodeEncryptionOptions": { "base": "The node-to-node encryption options.
", "refs": { "CreateDomainRequest$NodeToNodeEncryptionOptions": "Node-to-node encryption options.
", "DomainStatus$NodeToNodeEncryptionOptions": "The status of the NodeToNodeEncryptionOptions.
The node-to-node encryption options for the specified domain.
", "UpdateDomainConfigRequest$NodeToNodeEncryptionOptions": "Specifies node-to-node encryption options.
" } }, "NodeToNodeEncryptionOptionsStatus": { "base": "Status of the node-to-node encryption options for the specified domain.
", "refs": { "DomainConfig$NodeToNodeEncryptionOptions": "The NodeToNodeEncryptionOptions for the domain.
The name of the filter.
", "ValueStringList$member": null } }, "OpenSearchPartitionInstanceType": { "base": null, "refs": { "ClusterConfig$InstanceType": "The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.
", "ClusterConfig$DedicatedMasterType": "The instance type for a dedicated master node.
", "DescribeInstanceTypeLimitsRequest$InstanceType": " The instance type for an OpenSearch cluster for which OpenSearch Limits are needed.
The OpenSearch instance type offered by the reserved instance offering.
", "ReservedInstanceOffering$InstanceType": "The OpenSearch instance type offered by the reserved instance offering.
" } }, "OpenSearchWarmPartitionInstanceType": { "base": null, "refs": { "ClusterConfig$WarmType": "The instance type for the OpenSearch cluster's warm nodes.
" } }, "OptionState": { "base": "The state of a requested change. One of the following:
Provides the OptionState for the domain.
Provides the current status of the entity.
", "refs": { "AccessPoliciesStatus$Status": "The status of the access policy for the domain. See OptionStatus for the status information that's included.
The OptionStatus for advanced options for the specified domain.
Status of the advanced security options for the specified domain.
", "ClusterConfigStatus$Status": "The cluster configuration status for the specified domain.
", "CognitoOptionsStatus$Status": "The status of the Cognito options for the specified domain.
", "DomainEndpointOptionsStatus$Status": "The status of the endpoint options for the domain. See OptionStatus for the status information that's included.
The status of the EBS options for the specified domain.
", "EncryptionAtRestOptionsStatus$Status": "The status of the Encryption At Rest options for the specified domain.
", "LogPublishingOptionsStatus$Status": "The status of the log publishing options for the domain. See OptionStatus for the status information that's included.
The status of the node-to-node encryption options for the specified domain.
", "SnapshotOptionsStatus$Status": "The status of a daily automated snapshot.
", "VPCDerivedInfoStatus$Status": "The status of the VPC options for the specified domain.
", "VersionStatus$Status": "The status of the OpenSearch version options for the specified OpenSearch domain.
" } }, "OutboundConnection": { "base": "Specifies details about an outbound connection.
", "refs": { "DeleteOutboundConnectionResponse$Connection": "The OutboundConnection of the deleted outbound connection.
The connection status of an outbound cross-cluster connection.
", "refs": { "CreateOutboundConnectionResponse$ConnectionStatus": "The OutboundConnectionStatus for the newly created connection.
The OutboundConnectionStatus for the outbound connection.
The state code for the outbound connection. Can be one of the following:
A list of OutboundConnection matching the specified filter criteria.
Description of the package.
", "PackageDetails$PackageDescription": "User-specified description of the package.
", "UpdatePackageRequest$PackageDescription": "A new description of the package.
" } }, "PackageDetails": { "base": "Basic information about a package.
", "refs": { "CreatePackageResponse$PackageDetails": "Information about the package.
", "DeletePackageResponse$PackageDetails": " PackageDetails
Information about the package.
" } }, "PackageDetailsList": { "base": null, "refs": { "DescribePackagesResponse$PackageDetailsList": "List of PackageDetails objects.
Internal ID of the package to associate with a domain. Use DescribePackages to find this value.
The internal ID of the package you want to delete. Use DescribePackages to find this value.
The internal ID of the package to associate with a domain. Use DescribePackages to find this value.
The internal ID of the package.
", "GetPackageVersionHistoryRequest$PackageID": "Returns an audit history of package versions.
", "GetPackageVersionHistoryResponse$PackageID": null, "ListDomainsForPackageRequest$PackageID": "The package for which to list associated domains.
", "PackageDetails$PackageID": "Internal ID of the package.
", "UpdatePackageRequest$PackageID": "The unique identifier for the package.
" } }, "PackageName": { "base": null, "refs": { "CreatePackageRequest$PackageName": "Unique identifier for the package.
", "DomainPackageDetails$PackageName": "User-specified name of the package.
", "PackageDetails$PackageName": "User-specified name of the package.
" } }, "PackageSource": { "base": "The Amazon S3 location for importing the package specified as S3BucketName and S3Key
The Amazon S3 location from which to import the package.
", "UpdatePackageRequest$PackageSource": null } }, "PackageStatus": { "base": null, "refs": { "PackageDetails$PackageStatus": "Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
" } }, "PackageType": { "base": null, "refs": { "CreatePackageRequest$PackageType": "Type of package. Currently supports only TXT-DICTIONARY.
", "DomainPackageDetails$PackageType": "Currently supports only TXT-DICTIONARY.
", "PackageDetails$PackageType": "Currently supports only TXT-DICTIONARY.
" } }, "PackageVersion": { "base": null, "refs": { "DomainPackageDetails$PackageVersion": null, "PackageDetails$AvailablePackageVersion": null, "PackageVersionHistory$PackageVersion": "The package version.
" } }, "PackageVersionHistory": { "base": "Details of a package version.
", "refs": { "PackageVersionHistoryList$member": null } }, "PackageVersionHistoryList": { "base": null, "refs": { "GetPackageVersionHistoryResponse$PackageVersionHistoryList": "List of PackageVersionHistory objects.
The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.
" } }, "PolicyDocument": { "base": "Access policy rules for a domain service endpoints. For more information, see Configuring access policies . The maximum size of a policy document is 100 KB.
", "refs": { "AccessPoliciesStatus$Options": "The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See Configuring access policiesfor more information.
", "CreateDomainRequest$AccessPolicies": "IAM access policy as a JSON-formatted string.
", "DomainStatus$AccessPolicies": "IAM access policy as a JSON-formatted string.
", "UpdateDomainConfigRequest$AccessPolicies": "IAM access policy as a JSON-formatted string.
" } }, "PurchaseReservedInstanceOfferingRequest": { "base": "Container for parameters to PurchaseReservedInstanceOffering
Represents the output of a PurchaseReservedInstanceOffering operation.
Contains the specific price and frequency of a recurring charges for a reserved OpenSearch instance, or for a reserved OpenSearch instance offering.
", "refs": { "RecurringChargeList$member": null } }, "RecurringChargeList": { "base": null, "refs": { "ReservedInstance$RecurringCharges": "The charge to your account regardless of whether you are creating any domains using the instance offering.
", "ReservedInstanceOffering$RecurringCharges": "The charge to your account regardless of whether you are creating any domains using the instance offering.
" } }, "ReferencePath": { "base": null, "refs": { "DomainPackageDetails$ReferencePath": "The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.
" } }, "Region": { "base": null, "refs": { "AWSDomainInformation$Region": null } }, "RejectInboundConnectionRequest": { "base": "Container for the parameters to the RejectInboundConnection operation.
The result of a RejectInboundConnection operation. Contains details about the rejected inbound connection.
Container for the parameters to the RemoveTags operation. Specify the ARN for the domain from which you want to remove the specified TagKey.
A customer-specified identifier to track this reservation.
", "PurchaseReservedInstanceOfferingResponse$ReservationName": "The customer-specified identifier used to track this reservation.
", "ReservedInstance$ReservationName": "The customer-specified identifier to track this reservation.
" } }, "ReservedInstance": { "base": "Details of a reserved OpenSearch instance.
", "refs": { "ReservedInstanceList$member": null } }, "ReservedInstanceList": { "base": null, "refs": { "DescribeReservedInstancesResponse$ReservedInstances": "List of reserved OpenSearch instances.
" } }, "ReservedInstanceOffering": { "base": "Details of a reserved OpenSearch instance offering.
", "refs": { "ReservedInstanceOfferingList$member": null } }, "ReservedInstanceOfferingList": { "base": null, "refs": { "DescribeReservedInstanceOfferingsResponse$ReservedInstanceOfferings": "List of reserved OpenSearch instance offerings
" } }, "ReservedInstancePaymentOption": { "base": null, "refs": { "ReservedInstance$PaymentOption": "The payment option as defined in the reserved OpenSearch instance offering.
", "ReservedInstanceOffering$PaymentOption": "Payment option for the reserved OpenSearch instance offering
" } }, "ResourceAlreadyExistsException": { "base": "An exception for creating a resource that already exists. Gives http status code of 400.
", "refs": { } }, "ResourceNotFoundException": { "base": "An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
", "refs": { } }, "RoleArn": { "base": null, "refs": { "CognitoOptions$RoleArn": "The role ARN that provides OpenSearch permissions for accessing Cognito resources.
" } }, "RollbackOnDisable": { "base": "The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
", "refs": { "AutoTuneOptions$RollbackOnDisable": "The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
" } }, "S3BucketName": { "base": null, "refs": { "PackageSource$S3BucketName": "The name of the Amazon S3 bucket containing the package.
" } }, "S3Key": { "base": null, "refs": { "PackageSource$S3Key": "Key (file name) of the package.
" } }, "SAMLEntityId": { "base": null, "refs": { "SAMLIdp$EntityId": "The unique entity ID of the application in SAML identity provider.
" } }, "SAMLIdp": { "base": "The SAML identity povider's information.
", "refs": { "SAMLOptionsInput$Idp": "The SAML Identity Provider's information.
", "SAMLOptionsOutput$Idp": "Describes the SAML identity provider's information.
" } }, "SAMLMetadata": { "base": null, "refs": { "SAMLIdp$MetadataContent": "The metadata of the SAML application in XML format.
" } }, "SAMLOptionsInput": { "base": "The SAML application configuration for the domain.
", "refs": { "AdvancedSecurityOptionsInput$SAMLOptions": "The SAML application configuration for the domain.
" } }, "SAMLOptionsOutput": { "base": "Describes the SAML application configured for the domain.
", "refs": { "AdvancedSecurityOptions$SAMLOptions": "Describes the SAML application configured for a domain.
" } }, "ScheduledAutoTuneActionType": { "base": "The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING, and JVM_YOUNG_GEN_TUNING.
", "refs": { "ScheduledAutoTuneDetails$ActionType": "The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
" } }, "ScheduledAutoTuneDescription": { "base": "The Auto-Tune action description.
", "refs": { "ScheduledAutoTuneDetails$Action": "The Auto-Tune action description.
" } }, "ScheduledAutoTuneDetails": { "base": "Specifies details about the scheduled Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
", "refs": { "AutoTuneDetails$ScheduledAutoTuneDetails": null } }, "ScheduledAutoTuneSeverityType": { "base": "The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
", "refs": { "ScheduledAutoTuneDetails$Severity": "The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
" } }, "ServiceSoftwareOptions": { "base": "The current options of an domain service software options.
", "refs": { "CancelServiceSoftwareUpdateResponse$ServiceSoftwareOptions": "The current status of the OpenSearch service software update.
", "DomainStatus$ServiceSoftwareOptions": "The current status of the domain's service software.
", "StartServiceSoftwareUpdateResponse$ServiceSoftwareOptions": "The current status of the OpenSearch service software update.
" } }, "ServiceUrl": { "base": "The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com.
The domain endpoint that you use to submit index and search requests.
", "EndpointsMap$value": null } }, "SnapshotOptions": { "base": "The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is 0 hours.
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
", "DomainStatus$SnapshotOptions": "The status of the SnapshotOptions.
The daily snapshot options specified for the domain.
", "UpdateDomainConfigRequest$SnapshotOptions": "Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
Status of a daily automated snapshot.
", "refs": { "DomainConfig$SnapshotOptions": "The SnapshotOptions for the domain.
The timestamp at which the Auto-Tune maintenance schedule starts.
" } }, "StartServiceSoftwareUpdateRequest": { "base": "Container for the parameters to the StartServiceSoftwareUpdate operation. Specifies the name of the domain to schedule a service software update for.
The result of a StartServiceSoftwareUpdate operation. Contains the status of the update.
UTC timestamp at which the upgrade API call was made in \"yyyy-MM-ddTHH:mm:ssZ\" format.
" } }, "StorageSubTypeName": { "base": "Sub-type of the given storage type. List of available sub-storage options: \"instance\" storageType has no storageSubType. \"ebs\" storageType has the following valid storageSubTypes:
VolumeType for more information regarding each EBS storage option. ",
"refs": {
"StorageType$StorageSubTypeName": null
}
},
"StorageType": {
"base": "StorageTypes represents the list of storage-related types and their attributes that are available for a given InstanceType.
", "refs": { "StorageTypeList$member": null } }, "StorageTypeLimit": { "base": "Limits that are applicable for the given storage type.
", "refs": { "StorageTypeLimitList$member": null } }, "StorageTypeLimitList": { "base": null, "refs": { "StorageType$StorageTypeLimits": "Limits that are applicable for the given storage type.
" } }, "StorageTypeList": { "base": null, "refs": { "Limits$StorageTypes": "Storage-related types and attributes that are available for a given InstanceType.
" } }, "StorageTypeName": { "base": "Type of storage. List of available storage options:
A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
", "AutoTuneOptionsOutput$ErrorMessage": "The error message while enabling or disabling Auto-Tune.
", "AutoTuneStatus$ErrorMessage": "The error message while enabling or disabling Auto-Tune.
", "DescribePackagesResponse$NextToken": null, "DescribeReservedInstancesResponse$NextToken": "Provides an identifier to allow retrieval of paginated results.
", "EndpointsMap$key": null, "GetPackageVersionHistoryResponse$NextToken": null, "GetUpgradeHistoryResponse$NextToken": "Pagination token that needs to be supplied to the next call to get the next page of results.
", "ListDomainsForPackageResponse$NextToken": null, "ListPackagesForDomainResponse$NextToken": "Pagination token to supply to the next call to get the next page of results.
", "RecurringCharge$RecurringChargeFrequency": "The frequency of the recurring charge.
", "ReservedInstance$ReservedInstanceOfferingId": "The offering identifier.
", "ReservedInstance$CurrencyCode": "The currency code for the reserved OpenSearch instance offering.
", "ReservedInstance$State": "The state of the reserved OpenSearch instance.
", "ReservedInstanceOffering$CurrencyCode": "The currency code for the reserved OpenSearch instance offering.
", "SAMLOptionsInput$SubjectKey": "Element of the SAML assertion to use for username. Default is NameID.
", "SAMLOptionsInput$RolesKey": "Element of the SAML assertion to use for backend roles. Default is roles.
", "SAMLOptionsOutput$SubjectKey": "The key used for matching the SAML subject attribute.
", "SAMLOptionsOutput$RolesKey": "The key used for matching the SAML roles attribute.
", "ServiceSoftwareOptions$CurrentVersion": "The current service software version present on the domain.
", "ServiceSoftwareOptions$NewVersion": "The new service software version if one is available.
", "ServiceSoftwareOptions$Description": "The description of the UpdateStatus.
The VPC ID for the domain. Exists only if the domain was created with VPCOptions.
The TagKey list you want to remove from the domain.
The subnets for the VPC endpoint.
", "VPCDerivedInfo$AvailabilityZones": "The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.
The security groups for the VPC endpoint.
", "VPCOptions$SubnetIds": "The subnets for the VPC endpoint.
", "VPCOptions$SecurityGroupIds": "The security groups for the VPC endpoint.
" } }, "TLSSecurityPolicy": { "base": null, "refs": { "DomainEndpointOptions$TLSSecurityPolicy": "Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
A key value pair for a resource tag.
", "refs": { "TagList$member": null } }, "TagKey": { "base": "A string of length from 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they're attached.
", "refs": { "Tag$Key": "The TagKey, the name of the tag. Tag keys must be unique for the domain to which they are attached.
A list of Tag.
List of Tag to add to the domain.
A list of Tag added during domain creation.
List of Tag for the requested domain.
A string of length from 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.
", "refs": { "Tag$Value": "The TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
The unit of a maintenance schedule duration. Valid value is HOUR. See Auto-Tune for Amazon OpenSearch Service for more information.
", "refs": { "Duration$Unit": "The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.
" } }, "UIntValue": { "base": null, "refs": { "AutoTuneStatus$UpdateVersion": "The latest version of the Auto-Tune options.
", "OptionStatus$UpdateVersion": "The latest version of the entity.
" } }, "UpdateDomainConfigRequest": { "base": "Container for the parameters to the UpdateDomain operation. Specifies the type and number of instances in the domain cluster.
The result of an UpdateDomain request. Contains the status of the domain being updated.
Container for request parameters to the UpdatePackage operation.
Container for the response returned by the UpdatePackage operation.
The timestamp of the Auto-Tune options creation date.
", "AutoTuneStatus$UpdateDate": "The timestamp of when the Auto-Tune options were last updated.
", "OptionStatus$CreationDate": "The timestamp of when the entity was created.
", "OptionStatus$UpdateDate": "The timestamp of the last time the entity was updated.
", "ReservedInstance$StartTime": "The time the reservation started.
" } }, "UpgradeDomainRequest": { "base": " Container for the request parameters to UpgradeDomain operation.
Container for response returned by UpgradeDomain operation.
History of the last 10 upgrades and upgrade eligibility checks.
", "refs": { "UpgradeHistoryList$member": null } }, "UpgradeHistoryList": { "base": null, "refs": { "GetUpgradeHistoryResponse$UpgradeHistories": " A list of UpgradeHistory objects corresponding to each upgrade or upgrade eligibility check performed on a domain returned as part of the GetUpgradeHistoryResponse object.
A string that briefly describes the update.
", "UpgradeHistory$UpgradeName": "A string that briefly describes the upgrade.
" } }, "UpgradeStatus": { "base": null, "refs": { "GetUpgradeStatusResponse$StepStatus": " One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:
The current status of the upgrade. The status can take one of the following values:
The current status of the upgrade. The status can take one of the following values:
One of three steps an upgrade or upgrade eligibility check goes through:
One of three steps an upgrade or upgrade eligibility check goes through:
Represents a single step of the upgrade or upgrade eligibility check workflow.
", "refs": { "UpgradeStepsList$member": null } }, "UpgradeStepsList": { "base": null, "refs": { "UpgradeHistory$StepsList": " A list of UpgradeStepItem s representing information about each step performed as part of a specific upgrade or upgrade eligibility check.
The Cognito user pool ID for OpenSearch Dashboards authentication.
" } }, "Username": { "base": null, "refs": { "MasterUserOptions$MasterUserName": "The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.
", "SAMLOptionsInput$MasterUserName": "The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.
" } }, "VPCDerivedInfo": { "base": "Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
", "refs": { "DomainStatus$VPCOptions": "The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
The VPC options for the specified domain.
" } }, "VPCDerivedInfoStatus": { "base": "Status of the VPC options for the specified domain.
", "refs": { "DomainConfig$VPCOptions": "The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
", "refs": { "CreateDomainRequest$VPCOptions": "Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
", "UpdateDomainConfigRequest$VPCOptions": "Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
" } }, "ValidationException": { "base": "An exception for missing / invalid input fields. Gives http status code of 400.
", "refs": { } }, "ValueStringList": { "base": null, "refs": { "Filter$Values": "Contains one or more values for the filter.
" } }, "VersionList": { "base": "List of supported OpenSearch versions.
", "refs": { "CompatibleVersionsMap$TargetVersions": null, "ListVersionsResponse$Versions": null } }, "VersionStatus": { "base": "The status of the OpenSearch version options for the specified OpenSearch domain.
", "refs": { "DomainConfig$EngineVersion": "String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
" } }, "VersionString": { "base": null, "refs": { "CompatibleVersionsMap$SourceVersion": "The current version of OpenSearch a domain is on.
", "CreateDomainRequest$EngineVersion": "String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, \"OpenSearch_1.0\" or \"Elasticsearch_7.9\". For more information, see Creating and managing Amazon OpenSearch Service domains .
", "DescribeInstanceTypeLimitsRequest$EngineVersion": " Version of OpenSearch for which Limits are needed.
The version of OpenSearch you intend to upgrade the domain to.
", "UpgradeDomainResponse$TargetVersion": "The version of OpenSearch that you intend to upgrade the domain to.
", "VersionList$member": null, "VersionStatus$Options": "The OpenSearch version for the specified OpenSearch domain.
" } }, "VolumeType": { "base": "The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storage for more information.
", "refs": { "EBSOptions$VolumeType": "The volume type for EBS-based storage.
" } }, "ZoneAwarenessConfig": { "base": "The zone awareness configuration for the domain cluster, such as the number of availability zones.
", "refs": { "ClusterConfig$ZoneAwarenessConfig": "The zone awareness configuration for a domain when zone awareness is enabled.
" } } } }