1{ 2 "version": "2.0", 3 "service": "<fullname>Amazon Elasticsearch Configuration Service</fullname> <p>Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.</p> <p>For sample code that uses the Configuration API, see the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-samples.html\">Amazon Elasticsearch Service Developer Guide</a>. The guide also contains <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html\">sample code for sending signed HTTP requests to the Elasticsearch APIs</a>.</p> <p>The endpoint for configuration service requests is region-specific: es.<i>region</i>.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions\" target=\"_blank\">Regions and Endpoints</a>.</p>", 4 "operations": { 5 "AddTags": "<p>Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging\" target=\"_blank\"> Tagging Amazon Elasticsearch Service Domains for more information.</a></p>", 6 "CancelElasticsearchServiceSoftwareUpdate": "<p>Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the <code>AutomatedUpdateDate</code> and when the <code>UpdateStatus</code> is in the <code>PENDING_UPDATE</code> state.</p>", 7 "CreateElasticsearchDomain": "<p>Creates a new Elasticsearch domain. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains\" target=\"_blank\">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>.</p>", 8 "DeleteElasticsearchDomain": "<p>Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.</p>", 9 "DeleteElasticsearchServiceRole": "<p>Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-enabling-slr\" target=\"_blank\">Deleting Elasticsearch Service Role</a> in <i>VPC Endpoints for Amazon Elasticsearch Service Domains</i>.</p>", 10 "DescribeElasticsearchDomain": "<p>Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.</p>", 11 "DescribeElasticsearchDomainConfig": "<p>Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.</p>", 12 "DescribeElasticsearchDomains": "<p>Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.</p>", 13 "DescribeElasticsearchInstanceTypeLimits": "<p> Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the <code> <a>DomainName</a> </code> to know what Limits are supported for modifying. </p>", 14 "DescribeReservedElasticsearchInstanceOfferings": "<p>Lists available reserved Elasticsearch instance offerings.</p>", 15 "DescribeReservedElasticsearchInstances": "<p>Returns information about reserved Elasticsearch instances for this account.</p>", 16 "GetCompatibleElasticsearchVersions": "<p> Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a <code> <a>DomainName</a> </code> to get all upgrade compatible Elasticsearch versions for that specific domain. </p>", 17 "GetUpgradeHistory": "<p>Retrieves the complete history of the last 10 upgrades that were performed on the domain.</p>", 18 "GetUpgradeStatus": "<p>Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.</p>", 19 "ListDomainNames": "<p>Returns the name of all Elasticsearch domains owned by the current user's account. </p>", 20 "ListElasticsearchInstanceTypes": "<p>List all Elasticsearch instance types that are supported for given ElasticsearchVersion</p>", 21 "ListElasticsearchVersions": "<p>List all supported Elasticsearch versions</p>", 22 "ListTags": "<p>Returns all tags for the given Elasticsearch domain.</p>", 23 "PurchaseReservedElasticsearchInstanceOffering": "<p>Allows you to purchase reserved Elasticsearch instances.</p>", 24 "RemoveTags": "<p>Removes the specified set of tags from the specified Elasticsearch domain.</p>", 25 "StartElasticsearchServiceSoftwareUpdate": "<p>Schedules a service software update for an Amazon ES domain.</p>", 26 "UpdateElasticsearchDomainConfig": "<p>Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances. </p>", 27 "UpgradeElasticsearchDomain": "<p>Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.</p>" 28 }, 29 "shapes": { 30 "ARN": { 31 "base": "<p>The Amazon Resource Name (ARN) of the Elasticsearch domain. See <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>", 32 "refs": { 33 "AddTagsRequest$ARN": "<p> Specify the <code>ARN</code> for which you want to add the tags.</p>", 34 "ElasticsearchDomainStatus$ARN": "<p>The Amazon resource name (ARN) of an Elasticsearch domain. See <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>", 35 "ListTagsRequest$ARN": "<p> Specify the <code>ARN</code> for the Elasticsearch domain to which the tags are attached that you want to view.</p>", 36 "RemoveTagsRequest$ARN": "<p>Specifies the <code>ARN</code> for the Elasticsearch domain from which you want to delete the specified tags.</p>" 37 } 38 }, 39 "AccessPoliciesStatus": { 40 "base": "<p>The configured access rules for the domain's document and search endpoints, and the current status of those rules.</p>", 41 "refs": { 42 "ElasticsearchDomainConfig$AccessPolicies": "<p>IAM access policy as a JSON-formatted string.</p>" 43 } 44 }, 45 "AddTagsRequest": { 46 "base": "<p>Container for the parameters to the <code><a>AddTags</a></code> operation. Specify the tags that you want to attach to the Elasticsearch domain.</p>", 47 "refs": { 48 } 49 }, 50 "AdditionalLimit": { 51 "base": "<p> List of limits that are specific to a given InstanceType and for each of it's <code> <a>InstanceRole</a> </code> . </p>", 52 "refs": { 53 "AdditionalLimitList$member": null 54 } 55 }, 56 "AdditionalLimitList": { 57 "base": null, 58 "refs": { 59 "Limits$AdditionalLimits": "<p> List of additional limits that are specific to a given InstanceType and for each of it's <code> <a>InstanceRole</a> </code> . </p>" 60 } 61 }, 62 "AdvancedOptions": { 63 "base": "<p> Exposes select native Elasticsearch configuration values from <code>elasticsearch.yml</code>. Currently, the following advanced options are available:</p> <ul> <li>Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuration Advanced Options</a> for more information.</li> <li>Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.</li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\">Configuring Advanced Options</a>.</p>", 64 "refs": { 65 "AdvancedOptionsStatus$Options": "<p> Specifies the status of advanced options for the specified Elasticsearch domain.</p>", 66 "CreateElasticsearchDomainRequest$AdvancedOptions": "<p> Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuration Advanced Options</a> for more information.</p>", 67 "ElasticsearchDomainStatus$AdvancedOptions": "<p>Specifies the status of the <code>AdvancedOptions</code></p>", 68 "UpdateElasticsearchDomainConfigRequest$AdvancedOptions": "<p>Modifies the advanced option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuration Advanced Options</a> for more information.</p>" 69 } 70 }, 71 "AdvancedOptionsStatus": { 72 "base": "<p> Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:</p> <ul> <li>Option to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuration Advanced Options</a> for more information.</li> <li>Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.</li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\">Configuring Advanced Options</a>.</p>", 73 "refs": { 74 "ElasticsearchDomainConfig$AdvancedOptions": "<p>Specifies the <code>AdvancedOptions</code> for the domain. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options\" target=\"_blank\">Configuring Advanced Options</a> for more information.</p>" 75 } 76 }, 77 "BaseException": { 78 "base": "<p>An error occurred while processing the request.</p>", 79 "refs": { 80 } 81 }, 82 "Boolean": { 83 "base": null, 84 "refs": { 85 "CognitoOptions$Enabled": "<p>Specifies the option to enable Cognito for Kibana authentication.</p>", 86 "DomainEndpointOptions$EnforceHTTPS": "<p>Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.</p>", 87 "EBSOptions$EBSEnabled": "<p>Specifies whether EBS-based storage is enabled.</p>", 88 "ElasticsearchClusterConfig$DedicatedMasterEnabled": "<p>A boolean value to indicate whether a dedicated master node is enabled. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes\" target=\"_blank\">About Dedicated Master Nodes</a> for more information.</p>", 89 "ElasticsearchClusterConfig$ZoneAwarenessEnabled": "<p>A boolean value to indicate whether zone awareness is enabled. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness\" target=\"_blank\">About Zone Awareness</a> for more information.</p>", 90 "ElasticsearchClusterConfig$WarmEnabled": "<p>True to enable warm storage.</p>", 91 "ElasticsearchDomainStatus$Created": "<p>The domain creation status. <code>True</code> if the creation of an Elasticsearch domain is complete. <code>False</code> if domain creation is still in progress.</p>", 92 "ElasticsearchDomainStatus$Deleted": "<p>The domain deletion status. <code>True</code> if a delete request has been received for the domain but resource cleanup is still in progress. <code>False</code> if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.</p>", 93 "ElasticsearchDomainStatus$Processing": "<p>The status of the Elasticsearch domain configuration. <code>True</code> if Amazon Elasticsearch Service is processing configuration changes. <code>False</code> if the configuration is active.</p>", 94 "ElasticsearchDomainStatus$UpgradeProcessing": "<p>The status of an Elasticsearch domain version upgrade. <code>True</code> if Amazon Elasticsearch Service is undergoing a version upgrade. <code>False</code> if the configuration is active.</p>", 95 "EncryptionAtRestOptions$Enabled": "<p>Specifies the option to enable Encryption At Rest.</p>", 96 "LogPublishingOption$Enabled": "<p> Specifies whether given log publishing option is enabled or not.</p>", 97 "NodeToNodeEncryptionOptions$Enabled": "<p>Specify true to enable node-to-node encryption.</p>", 98 "OptionStatus$PendingDeletion": "<p>Indicates whether the Elasticsearch domain is being deleted.</p>", 99 "ServiceSoftwareOptions$UpdateAvailable": "<p><code>True</code> if you are able to update you service software version. <code>False</code> if you are not able to update your service software version. </p>", 100 "ServiceSoftwareOptions$Cancellable": "<p><code>True</code> if you are able to cancel your service software version update. <code>False</code> if you are not able to cancel your service software version. </p>", 101 "UpgradeElasticsearchDomainRequest$PerformCheckOnly": "<p> This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade. </p>", 102 "UpgradeElasticsearchDomainResponse$PerformCheckOnly": "<p> This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade. </p>" 103 } 104 }, 105 "CancelElasticsearchServiceSoftwareUpdateRequest": { 106 "base": "<p>Container for the parameters to the <code><a>CancelElasticsearchServiceSoftwareUpdate</a></code> operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.</p>", 107 "refs": { 108 } 109 }, 110 "CancelElasticsearchServiceSoftwareUpdateResponse": { 111 "base": "<p>The result of a <code>CancelElasticsearchServiceSoftwareUpdate</code> operation. Contains the status of the update.</p>", 112 "refs": { 113 } 114 }, 115 "CloudWatchLogsLogGroupArn": { 116 "base": "<p>ARN of the Cloudwatch log group to which log needs to be published.</p>", 117 "refs": { 118 "LogPublishingOption$CloudWatchLogsLogGroupArn": null 119 } 120 }, 121 "CognitoOptions": { 122 "base": "<p>Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.</p>", 123 "refs": { 124 "CognitoOptionsStatus$Options": "<p>Specifies the Cognito options for the specified Elasticsearch domain.</p>", 125 "CreateElasticsearchDomainRequest$CognitoOptions": "<p>Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.</p>", 126 "ElasticsearchDomainStatus$CognitoOptions": "<p>The <code>CognitoOptions</code> for the specified domain. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.</p>", 127 "UpdateElasticsearchDomainConfigRequest$CognitoOptions": "<p>Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.</p>" 128 } 129 }, 130 "CognitoOptionsStatus": { 131 "base": "<p>Status of the Cognito options for the specified Elasticsearch domain.</p>", 132 "refs": { 133 "ElasticsearchDomainConfig$CognitoOptions": "<p>The <code>CognitoOptions</code> for the specified domain. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.</p>" 134 } 135 }, 136 "CompatibleElasticsearchVersionsList": { 137 "base": null, 138 "refs": { 139 "GetCompatibleElasticsearchVersionsResponse$CompatibleElasticsearchVersions": "<p> A map of compatible Elasticsearch versions returned as part of the <code> <a>GetCompatibleElasticsearchVersions</a> </code> operation. </p>" 140 } 141 }, 142 "CompatibleVersionsMap": { 143 "base": "<p> A map from an <code> <a>ElasticsearchVersion</a> </code> to a list of compatible <code> <a>ElasticsearchVersion</a> </code> s to which the domain can be upgraded. </p>", 144 "refs": { 145 "CompatibleElasticsearchVersionsList$member": null 146 } 147 }, 148 "CreateElasticsearchDomainRequest": { 149 "base": null, 150 "refs": { 151 } 152 }, 153 "CreateElasticsearchDomainResponse": { 154 "base": "<p>The result of a <code>CreateElasticsearchDomain</code> operation. Contains the status of the newly created Elasticsearch domain.</p>", 155 "refs": { 156 } 157 }, 158 "DeleteElasticsearchDomainRequest": { 159 "base": "<p>Container for the parameters to the <code><a>DeleteElasticsearchDomain</a></code> operation. Specifies the name of the Elasticsearch domain that you want to delete.</p>", 160 "refs": { 161 } 162 }, 163 "DeleteElasticsearchDomainResponse": { 164 "base": "<p>The result of a <code>DeleteElasticsearchDomain</code> request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.</p>", 165 "refs": { 166 } 167 }, 168 "DeploymentCloseDateTimeStamp": { 169 "base": null, 170 "refs": { 171 "ServiceSoftwareOptions$AutomatedUpdateDate": "<p>Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.</p>" 172 } 173 }, 174 "DeploymentStatus": { 175 "base": null, 176 "refs": { 177 "ServiceSoftwareOptions$UpdateStatus": "<p>The status of your service software update. This field can take the following values: <code>ELIGIBLE</code>, <code>PENDING_UPDATE</code>, <code>IN_PROGRESS</code>, <code>COMPLETED</code>, and <code>NOT_ELIGIBLE</code>.</p>" 178 } 179 }, 180 "DescribeElasticsearchDomainConfigRequest": { 181 "base": "<p> Container for the parameters to the <code>DescribeElasticsearchDomainConfig</code> operation. Specifies the domain name for which you want configuration information.</p>", 182 "refs": { 183 } 184 }, 185 "DescribeElasticsearchDomainConfigResponse": { 186 "base": "<p>The result of a <code>DescribeElasticsearchDomainConfig</code> request. Contains the configuration information of the requested domain.</p>", 187 "refs": { 188 } 189 }, 190 "DescribeElasticsearchDomainRequest": { 191 "base": "<p>Container for the parameters to the <code><a>DescribeElasticsearchDomain</a></code> operation.</p>", 192 "refs": { 193 } 194 }, 195 "DescribeElasticsearchDomainResponse": { 196 "base": "<p>The result of a <code>DescribeElasticsearchDomain</code> request. Contains the status of the domain specified in the request.</p>", 197 "refs": { 198 } 199 }, 200 "DescribeElasticsearchDomainsRequest": { 201 "base": "<p>Container for the parameters to the <code><a>DescribeElasticsearchDomains</a></code> operation. By default, the API returns the status of all Elasticsearch domains.</p>", 202 "refs": { 203 } 204 }, 205 "DescribeElasticsearchDomainsResponse": { 206 "base": "<p>The result of a <code>DescribeElasticsearchDomains</code> request. Contains the status of the specified domains or all domains owned by the account.</p>", 207 "refs": { 208 } 209 }, 210 "DescribeElasticsearchInstanceTypeLimitsRequest": { 211 "base": "<p> Container for the parameters to <code> <a>DescribeElasticsearchInstanceTypeLimits</a> </code> operation. </p>", 212 "refs": { 213 } 214 }, 215 "DescribeElasticsearchInstanceTypeLimitsResponse": { 216 "base": "<p> Container for the parameters received from <code> <a>DescribeElasticsearchInstanceTypeLimits</a> </code> operation. </p>", 217 "refs": { 218 } 219 }, 220 "DescribeReservedElasticsearchInstanceOfferingsRequest": { 221 "base": "<p>Container for parameters to <code>DescribeReservedElasticsearchInstanceOfferings</code></p>", 222 "refs": { 223 } 224 }, 225 "DescribeReservedElasticsearchInstanceOfferingsResponse": { 226 "base": "<p>Container for results from <code>DescribeReservedElasticsearchInstanceOfferings</code></p>", 227 "refs": { 228 } 229 }, 230 "DescribeReservedElasticsearchInstancesRequest": { 231 "base": "<p>Container for parameters to <code>DescribeReservedElasticsearchInstances</code></p>", 232 "refs": { 233 } 234 }, 235 "DescribeReservedElasticsearchInstancesResponse": { 236 "base": "<p>Container for results from <code>DescribeReservedElasticsearchInstances</code></p>", 237 "refs": { 238 } 239 }, 240 "DisabledOperationException": { 241 "base": "<p>An error occured because the client wanted to access a not supported operation. Gives http status code of 409.</p>", 242 "refs": { 243 } 244 }, 245 "DomainEndpointOptions": { 246 "base": "<p>Options to configure endpoint for the Elasticsearch domain.</p>", 247 "refs": { 248 "CreateElasticsearchDomainRequest$DomainEndpointOptions": "<p>Options to specify configuration that will be applied to the domain endpoint.</p>", 249 "DomainEndpointOptionsStatus$Options": "<p>Options to configure endpoint for the Elasticsearch domain.</p>", 250 "ElasticsearchDomainStatus$DomainEndpointOptions": "<p>The current status of the Elasticsearch domain's endpoint options.</p>", 251 "UpdateElasticsearchDomainConfigRequest$DomainEndpointOptions": "<p>Options to specify configuration that will be applied to the domain endpoint.</p>" 252 } 253 }, 254 "DomainEndpointOptionsStatus": { 255 "base": "<p>The configured endpoint options for the domain and their current status.</p>", 256 "refs": { 257 "ElasticsearchDomainConfig$DomainEndpointOptions": "<p>Specifies the <code>DomainEndpointOptions</code> for the Elasticsearch domain.</p>" 258 } 259 }, 260 "DomainId": { 261 "base": "<p>Unique identifier for an Elasticsearch domain.</p>", 262 "refs": { 263 "ElasticsearchDomainStatus$DomainId": "<p>The unique identifier for the specified Elasticsearch domain.</p>" 264 } 265 }, 266 "DomainInfo": { 267 "base": null, 268 "refs": { 269 "DomainInfoList$member": null 270 } 271 }, 272 "DomainInfoList": { 273 "base": "<p> Contains the list of Elasticsearch domain information.</p>", 274 "refs": { 275 "ListDomainNamesResponse$DomainNames": "<p>List of Elasticsearch domain names.</p>" 276 } 277 }, 278 "DomainName": { 279 "base": "<p>The name of an Elasticsearch 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).</p>", 280 "refs": { 281 "CancelElasticsearchServiceSoftwareUpdateRequest$DomainName": "<p>The name of the domain that you want to stop the latest service software update on.</p>", 282 "CreateElasticsearchDomainRequest$DomainName": "<p>The name of the Elasticsearch domain that you are 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).</p>", 283 "DeleteElasticsearchDomainRequest$DomainName": "<p>The name of the Elasticsearch domain that you want to permanently delete.</p>", 284 "DescribeElasticsearchDomainConfigRequest$DomainName": "<p>The Elasticsearch domain that you want to get information about.</p>", 285 "DescribeElasticsearchDomainRequest$DomainName": "<p>The name of the Elasticsearch domain for which you want information.</p>", 286 "DescribeElasticsearchInstanceTypeLimitsRequest$DomainName": "<p> DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch <code> <a>Limits</a> </code> for existing domain. </p>", 287 "DomainInfo$DomainName": "<p> Specifies the <code>DomainName</code>.</p>", 288 "DomainNameList$member": null, 289 "ElasticsearchDomainStatus$DomainName": "<p>The name of an Elasticsearch 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).</p>", 290 "GetCompatibleElasticsearchVersionsRequest$DomainName": null, 291 "GetUpgradeHistoryRequest$DomainName": null, 292 "GetUpgradeStatusRequest$DomainName": null, 293 "ListElasticsearchInstanceTypesRequest$DomainName": "<p>DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain. </p>", 294 "StartElasticsearchServiceSoftwareUpdateRequest$DomainName": "<p>The name of the domain that you want to update to the latest service software.</p>", 295 "UpdateElasticsearchDomainConfigRequest$DomainName": "<p>The name of the Elasticsearch domain that you are updating. </p>", 296 "UpgradeElasticsearchDomainRequest$DomainName": null, 297 "UpgradeElasticsearchDomainResponse$DomainName": null 298 } 299 }, 300 "DomainNameList": { 301 "base": "<p>A list of Elasticsearch domain names.</p>", 302 "refs": { 303 "DescribeElasticsearchDomainsRequest$DomainNames": "<p>The Elasticsearch domains for which you want information.</p>" 304 } 305 }, 306 "Double": { 307 "base": null, 308 "refs": { 309 "RecurringCharge$RecurringChargeAmount": "<p>The monetary amount of the recurring charge.</p>", 310 "ReservedElasticsearchInstance$FixedPrice": "<p>The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering. </p>", 311 "ReservedElasticsearchInstance$UsagePrice": "<p>The rate you are charged for each hour for the domain that is using this reserved instance.</p>", 312 "ReservedElasticsearchInstanceOffering$FixedPrice": "<p>The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering. </p>", 313 "ReservedElasticsearchInstanceOffering$UsagePrice": "<p>The rate you are charged for each hour the domain that is using the offering is running.</p>", 314 "UpgradeStepItem$ProgressPercent": "<p>The Floating point value representing progress percentage of a particular step.</p>" 315 } 316 }, 317 "EBSOptions": { 318 "base": "<p>Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs\" target=\"_blank\"> Configuring EBS-based Storage</a>.</p>", 319 "refs": { 320 "CreateElasticsearchDomainRequest$EBSOptions": "<p>Options to enable, disable and specify the type and size of EBS storage volumes. </p>", 321 "EBSOptionsStatus$Options": "<p> Specifies the EBS options for the specified Elasticsearch domain.</p>", 322 "ElasticsearchDomainStatus$EBSOptions": "<p>The <code>EBSOptions</code> for the specified domain. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs\" target=\"_blank\">Configuring EBS-based Storage</a> for more information.</p>", 323 "UpdateElasticsearchDomainConfigRequest$EBSOptions": "<p>Specify the type and size of the EBS volume that you want to use. </p>" 324 } 325 }, 326 "EBSOptionsStatus": { 327 "base": "<p> Status of the EBS options for the specified Elasticsearch domain.</p>", 328 "refs": { 329 "ElasticsearchDomainConfig$EBSOptions": "<p>Specifies the <code>EBSOptions</code> for the Elasticsearch domain.</p>" 330 } 331 }, 332 "ESPartitionInstanceType": { 333 "base": null, 334 "refs": { 335 "DescribeElasticsearchInstanceTypeLimitsRequest$InstanceType": "<p> The instance type for an Elasticsearch cluster for which Elasticsearch <code> <a>Limits</a> </code> are needed. </p>", 336 "ElasticsearchClusterConfig$InstanceType": "<p>The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.</p>", 337 "ElasticsearchClusterConfig$DedicatedMasterType": "<p>The instance type for a dedicated master node.</p>", 338 "ElasticsearchInstanceTypeList$member": null, 339 "ReservedElasticsearchInstance$ElasticsearchInstanceType": "<p>The Elasticsearch instance type offered by the reserved instance offering.</p>", 340 "ReservedElasticsearchInstanceOffering$ElasticsearchInstanceType": "<p>The Elasticsearch instance type offered by the reserved instance offering.</p>" 341 } 342 }, 343 "ESWarmPartitionInstanceType": { 344 "base": null, 345 "refs": { 346 "ElasticsearchClusterConfig$WarmType": "<p>The instance type for the Elasticsearch cluster's warm nodes.</p>" 347 } 348 }, 349 "ElasticsearchClusterConfig": { 350 "base": "<p>Specifies the configuration for the domain cluster, such as the type and number of instances.</p>", 351 "refs": { 352 "CreateElasticsearchDomainRequest$ElasticsearchClusterConfig": "<p>Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster. </p>", 353 "ElasticsearchClusterConfigStatus$Options": "<p> Specifies the cluster configuration for the specified Elasticsearch domain.</p>", 354 "ElasticsearchDomainStatus$ElasticsearchClusterConfig": "<p>The type and number of instances in the domain cluster.</p>", 355 "UpdateElasticsearchDomainConfigRequest$ElasticsearchClusterConfig": "<p>The type and number of instances to instantiate for the domain cluster.</p>" 356 } 357 }, 358 "ElasticsearchClusterConfigStatus": { 359 "base": "<p> Specifies the configuration status for the specified Elasticsearch domain.</p>", 360 "refs": { 361 "ElasticsearchDomainConfig$ElasticsearchClusterConfig": "<p>Specifies the <code>ElasticsearchClusterConfig</code> for the Elasticsearch domain.</p>" 362 } 363 }, 364 "ElasticsearchDomainConfig": { 365 "base": "<p>The configuration of an Elasticsearch domain.</p>", 366 "refs": { 367 "DescribeElasticsearchDomainConfigResponse$DomainConfig": "<p>The configuration information of the domain requested in the <code>DescribeElasticsearchDomainConfig</code> request.</p>", 368 "UpdateElasticsearchDomainConfigResponse$DomainConfig": "<p>The status of the updated Elasticsearch domain. </p>" 369 } 370 }, 371 "ElasticsearchDomainStatus": { 372 "base": "<p>The current status of an Elasticsearch domain.</p>", 373 "refs": { 374 "CreateElasticsearchDomainResponse$DomainStatus": "<p>The status of the newly created Elasticsearch domain. </p>", 375 "DeleteElasticsearchDomainResponse$DomainStatus": "<p>The status of the Elasticsearch domain being deleted.</p>", 376 "DescribeElasticsearchDomainResponse$DomainStatus": "<p>The current status of the Elasticsearch domain.</p>", 377 "ElasticsearchDomainStatusList$member": null 378 } 379 }, 380 "ElasticsearchDomainStatusList": { 381 "base": "<p>A list that contains the status of each requested Elasticsearch domain.</p>", 382 "refs": { 383 "DescribeElasticsearchDomainsResponse$DomainStatusList": "<p>The status of the domains requested in the <code>DescribeElasticsearchDomains</code> request.</p>" 384 } 385 }, 386 "ElasticsearchInstanceTypeList": { 387 "base": "<p> List of instance types supported by Amazon Elasticsearch service. </p>", 388 "refs": { 389 "ListElasticsearchInstanceTypesResponse$ElasticsearchInstanceTypes": "<p> List of instance types supported by Amazon Elasticsearch service for given <code> <a>ElasticsearchVersion</a> </code> </p>" 390 } 391 }, 392 "ElasticsearchVersionList": { 393 "base": "<p>List of supported elastic search versions. </p>", 394 "refs": { 395 "CompatibleVersionsMap$TargetVersions": null, 396 "ListElasticsearchVersionsResponse$ElasticsearchVersions": null 397 } 398 }, 399 "ElasticsearchVersionStatus": { 400 "base": "<p> Status of the Elasticsearch version options for the specified Elasticsearch domain.</p>", 401 "refs": { 402 "ElasticsearchDomainConfig$ElasticsearchVersion": "<p>String of format X.Y to specify version for the Elasticsearch domain.</p>" 403 } 404 }, 405 "ElasticsearchVersionString": { 406 "base": null, 407 "refs": { 408 "CompatibleVersionsMap$SourceVersion": "<p>The current version of Elasticsearch on which a domain is.</p>", 409 "CreateElasticsearchDomainRequest$ElasticsearchVersion": "<p>String of format X.Y to specify version for the Elasticsearch domain eg. \"1.5\" or \"2.3\". For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains\" target=\"_blank\">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>.</p>", 410 "DescribeElasticsearchInstanceTypeLimitsRequest$ElasticsearchVersion": "<p> Version of Elasticsearch for which <code> <a>Limits</a> </code> are needed. </p>", 411 "ElasticsearchDomainStatus$ElasticsearchVersion": null, 412 "ElasticsearchVersionList$member": null, 413 "ElasticsearchVersionStatus$Options": "<p> Specifies the Elasticsearch version for the specified Elasticsearch domain.</p>", 414 "ListElasticsearchInstanceTypesRequest$ElasticsearchVersion": "<p>Version of Elasticsearch for which list of supported elasticsearch instance types are needed. </p>", 415 "UpgradeElasticsearchDomainRequest$TargetVersion": "<p>The version of Elasticsearch that you intend to upgrade the domain to.</p>", 416 "UpgradeElasticsearchDomainResponse$TargetVersion": "<p>The version of Elasticsearch that you intend to upgrade the domain to.</p>" 417 } 418 }, 419 "EncryptionAtRestOptions": { 420 "base": "<p>Specifies the Encryption At Rest Options.</p>", 421 "refs": { 422 "CreateElasticsearchDomainRequest$EncryptionAtRestOptions": "<p>Specifies the Encryption At Rest Options.</p>", 423 "ElasticsearchDomainStatus$EncryptionAtRestOptions": "<p> Specifies the status of the <code>EncryptionAtRestOptions</code>.</p>", 424 "EncryptionAtRestOptionsStatus$Options": "<p> Specifies the Encryption At Rest options for the specified Elasticsearch domain.</p>" 425 } 426 }, 427 "EncryptionAtRestOptionsStatus": { 428 "base": "<p> Status of the Encryption At Rest options for the specified Elasticsearch domain.</p>", 429 "refs": { 430 "ElasticsearchDomainConfig$EncryptionAtRestOptions": "<p>Specifies the <code>EncryptionAtRestOptions</code> for the Elasticsearch domain.</p>" 431 } 432 }, 433 "EndpointsMap": { 434 "base": null, 435 "refs": { 436 "ElasticsearchDomainStatus$Endpoints": "<p>Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example <code>key, value</code>: <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>.</p>" 437 } 438 }, 439 "ErrorMessage": { 440 "base": null, 441 "refs": { 442 "BaseException$message": "<p>A description of the error.</p>" 443 } 444 }, 445 "GUID": { 446 "base": null, 447 "refs": { 448 "DescribeReservedElasticsearchInstanceOfferingsRequest$ReservedElasticsearchInstanceOfferingId": "<p>The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.</p>", 449 "DescribeReservedElasticsearchInstancesRequest$ReservedElasticsearchInstanceId": "<p>The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.</p>", 450 "PurchaseReservedElasticsearchInstanceOfferingRequest$ReservedElasticsearchInstanceOfferingId": "<p>The ID of the reserved Elasticsearch instance offering to purchase.</p>", 451 "PurchaseReservedElasticsearchInstanceOfferingResponse$ReservedElasticsearchInstanceId": "<p>Details of the reserved Elasticsearch instance which was purchased.</p>", 452 "ReservedElasticsearchInstance$ReservedElasticsearchInstanceId": "<p>The unique identifier for the reservation.</p>", 453 "ReservedElasticsearchInstanceOffering$ReservedElasticsearchInstanceOfferingId": "<p>The Elasticsearch reserved instance offering identifier.</p>" 454 } 455 }, 456 "GetCompatibleElasticsearchVersionsRequest": { 457 "base": "<p> Container for request parameters to <code> <a>GetCompatibleElasticsearchVersions</a> </code> operation. </p>", 458 "refs": { 459 } 460 }, 461 "GetCompatibleElasticsearchVersionsResponse": { 462 "base": "<p> Container for response returned by <code> <a>GetCompatibleElasticsearchVersions</a> </code> operation. </p>", 463 "refs": { 464 } 465 }, 466 "GetUpgradeHistoryRequest": { 467 "base": "<p> Container for request parameters to <code> <a>GetUpgradeHistory</a> </code> operation. </p>", 468 "refs": { 469 } 470 }, 471 "GetUpgradeHistoryResponse": { 472 "base": "<p> Container for response returned by <code> <a>GetUpgradeHistory</a> </code> operation. </p>", 473 "refs": { 474 } 475 }, 476 "GetUpgradeStatusRequest": { 477 "base": "<p> Container for request parameters to <code> <a>GetUpgradeStatus</a> </code> operation. </p>", 478 "refs": { 479 } 480 }, 481 "GetUpgradeStatusResponse": { 482 "base": "<p> Container for response returned by <code> <a>GetUpgradeStatus</a> </code> operation. </p>", 483 "refs": { 484 } 485 }, 486 "IdentityPoolId": { 487 "base": null, 488 "refs": { 489 "CognitoOptions$IdentityPoolId": "<p>Specifies the Cognito identity pool ID for Kibana authentication.</p>" 490 } 491 }, 492 "InstanceCount": { 493 "base": "<p>Specifies the number of EC2 instances in the Elasticsearch domain.</p>", 494 "refs": { 495 "PurchaseReservedElasticsearchInstanceOfferingRequest$InstanceCount": "<p>The number of Elasticsearch instances to reserve.</p>" 496 } 497 }, 498 "InstanceCountLimits": { 499 "base": "<p> InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType. </p>", 500 "refs": { 501 "InstanceLimits$InstanceCountLimits": null 502 } 503 }, 504 "InstanceLimits": { 505 "base": "<p>InstanceLimits represents the list of instance related attributes that are available for given InstanceType. </p>", 506 "refs": { 507 "Limits$InstanceLimits": null 508 } 509 }, 510 "InstanceRole": { 511 "base": null, 512 "refs": { 513 "LimitsByRole$key": null 514 } 515 }, 516 "Integer": { 517 "base": null, 518 "refs": { 519 "ReservedElasticsearchInstance$Duration": "<p>The duration, in seconds, for which the Elasticsearch instance is reserved.</p>", 520 "ReservedElasticsearchInstance$ElasticsearchInstanceCount": "<p>The number of Elasticsearch instances that have been reserved.</p>", 521 "ReservedElasticsearchInstanceOffering$Duration": "<p>The duration, in seconds, for which the offering will reserve the Elasticsearch instance.</p>" 522 } 523 }, 524 "IntegerClass": { 525 "base": null, 526 "refs": { 527 "EBSOptions$VolumeSize": "<p> Integer to specify the size of an EBS volume.</p>", 528 "EBSOptions$Iops": "<p>Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).</p>", 529 "ElasticsearchClusterConfig$InstanceCount": "<p>The number of instances in the specified domain cluster.</p>", 530 "ElasticsearchClusterConfig$DedicatedMasterCount": "<p>Total number of dedicated master nodes, active and on standby, for the cluster.</p>", 531 "ElasticsearchClusterConfig$WarmCount": "<p>The number of warm nodes in the cluster.</p>", 532 "SnapshotOptions$AutomatedSnapshotStartHour": "<p>Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.</p>", 533 "ZoneAwarenessConfig$AvailabilityZoneCount": "<p>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</p>" 534 } 535 }, 536 "InternalException": { 537 "base": "<p>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.</p>", 538 "refs": { 539 } 540 }, 541 "InvalidTypeException": { 542 "base": "<p>An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.</p>", 543 "refs": { 544 } 545 }, 546 "Issue": { 547 "base": null, 548 "refs": { 549 "Issues$member": null 550 } 551 }, 552 "Issues": { 553 "base": null, 554 "refs": { 555 "UpgradeStepItem$Issues": "<p>A list of strings containing detailed information about the errors encountered in a particular step.</p>" 556 } 557 }, 558 "KmsKeyId": { 559 "base": null, 560 "refs": { 561 "EncryptionAtRestOptions$KmsKeyId": "<p> Specifies the KMS Key ID for Encryption At Rest options.</p>" 562 } 563 }, 564 "LimitExceededException": { 565 "base": "<p>An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.</p>", 566 "refs": { 567 } 568 }, 569 "LimitName": { 570 "base": null, 571 "refs": { 572 "AdditionalLimit$LimitName": "<p> Name of Additional Limit is specific to a given InstanceType and for each of it's <code> <a>InstanceRole</a> </code> etc. <br/> Attributes and their details: <br/> <ul> <li>MaximumNumberOfDataNodesSupported</li> This attribute will be present in Master node only to specify how much data nodes upto which given <code> <a>ESPartitionInstanceType</a> </code> can support as master node. <li>MaximumNumberOfDataNodesWithoutMasterNode</li> This attribute will be present in Data node only to specify how much data nodes of given <code> <a>ESPartitionInstanceType</a> </code> upto which you don't need any master nodes to govern them. </ul> </p>", 573 "StorageTypeLimit$LimitName": "<p> Name of storage limits that are applicable for given storage type. If <code> <a>StorageType</a> </code> is ebs, following storage options are applicable <ol> <li>MinimumVolumeSize</li> Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. <li>MaximumVolumeSize</li> Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. <li>MaximumIops</li> Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable. <li>MinimumIops</li> Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable. </ol> </p>" 574 } 575 }, 576 "LimitValue": { 577 "base": null, 578 "refs": { 579 "LimitValueList$member": null 580 } 581 }, 582 "LimitValueList": { 583 "base": null, 584 "refs": { 585 "AdditionalLimit$LimitValues": "<p> Value for given <code> <a>AdditionalLimit$LimitName</a> </code> . </p>", 586 "StorageTypeLimit$LimitValues": "<p> Values for the <code> <a>StorageTypeLimit$LimitName</a> </code> . </p>" 587 } 588 }, 589 "Limits": { 590 "base": "<p> Limits for given InstanceType and for each of it's role. <br/> Limits contains following <code> <a>StorageTypes,</a> </code> <code> <a>InstanceLimits</a> </code> and <code> <a>AdditionalLimits</a> </code> </p>", 591 "refs": { 592 "LimitsByRole$value": null 593 } 594 }, 595 "LimitsByRole": { 596 "base": "<p> Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following: <ul> <li>data: If the given InstanceType is used as data node</li> <li>master: If the given InstanceType is used as master node</li> <li>ultra_warm: If the given InstanceType is used as warm node</li> </ul> </p>", 597 "refs": { 598 "DescribeElasticsearchInstanceTypeLimitsResponse$LimitsByRole": null 599 } 600 }, 601 "ListDomainNamesResponse": { 602 "base": "<p>The result of a <code>ListDomainNames</code> operation. Contains the names of all Elasticsearch domains owned by this account.</p>", 603 "refs": { 604 } 605 }, 606 "ListElasticsearchInstanceTypesRequest": { 607 "base": "<p> Container for the parameters to the <code> <a>ListElasticsearchInstanceTypes</a> </code> operation. </p>", 608 "refs": { 609 } 610 }, 611 "ListElasticsearchInstanceTypesResponse": { 612 "base": "<p> Container for the parameters returned by <code> <a>ListElasticsearchInstanceTypes</a> </code> operation. </p>", 613 "refs": { 614 } 615 }, 616 "ListElasticsearchVersionsRequest": { 617 "base": "<p> Container for the parameters to the <code> <a>ListElasticsearchVersions</a> </code> operation. <p> Use <code> <a>MaxResults</a> </code> to control the maximum number of results to retrieve in a single call. </p> <p> Use <code> <a>NextToken</a> </code> in response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve. </p> </p>", 618 "refs": { 619 } 620 }, 621 "ListElasticsearchVersionsResponse": { 622 "base": "<p> Container for the parameters for response received from <code> <a>ListElasticsearchVersions</a> </code> operation. </p>", 623 "refs": { 624 } 625 }, 626 "ListTagsRequest": { 627 "base": "<p>Container for the parameters to the <code><a>ListTags</a></code> operation. Specify the <code>ARN</code> for the Elasticsearch domain to which the tags are attached that you want to view are attached.</p>", 628 "refs": { 629 } 630 }, 631 "ListTagsResponse": { 632 "base": "<p>The result of a <code>ListTags</code> operation. Contains tags for all requested Elasticsearch domains.</p>", 633 "refs": { 634 } 635 }, 636 "LogPublishingOption": { 637 "base": "<p>Log Publishing option that is set for given domain. <br/>Attributes and their details: <ul> <li>CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.</li> <li>Enabled: Whether the log publishing for given log type is enabled or not</li> </ul> </p>", 638 "refs": { 639 "LogPublishingOptions$value": null 640 } 641 }, 642 "LogPublishingOptions": { 643 "base": null, 644 "refs": { 645 "CreateElasticsearchDomainRequest$LogPublishingOptions": "<p>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of Elasticsearch log.</p>", 646 "ElasticsearchDomainStatus$LogPublishingOptions": "<p>Log publishing options for the given domain.</p>", 647 "LogPublishingOptionsStatus$Options": "<p>The log publishing options configured for the Elasticsearch domain.</p>", 648 "UpdateElasticsearchDomainConfigRequest$LogPublishingOptions": "<p>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of Elasticsearch log.</p>" 649 } 650 }, 651 "LogPublishingOptionsStatus": { 652 "base": "<p>The configured log publishing options for the domain and their current status.</p>", 653 "refs": { 654 "ElasticsearchDomainConfig$LogPublishingOptions": "<p>Log publishing options for the given domain.</p>" 655 } 656 }, 657 "LogType": { 658 "base": "<p>Type of Log File, it can be one of the following: <ul> <li>INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.</li> <li>SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.</li> <li>ES_APPLICATION_LOGS: Elasticsearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.</li> </ul> </p>", 659 "refs": { 660 "LogPublishingOptions$key": null 661 } 662 }, 663 "MaxResults": { 664 "base": "<p> Set this value to limit the number of results returned. </p>", 665 "refs": { 666 "DescribeReservedElasticsearchInstanceOfferingsRequest$MaxResults": "<p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>", 667 "DescribeReservedElasticsearchInstancesRequest$MaxResults": "<p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>", 668 "GetUpgradeHistoryRequest$MaxResults": null, 669 "ListElasticsearchInstanceTypesRequest$MaxResults": "<p> Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored. </p>", 670 "ListElasticsearchVersionsRequest$MaxResults": "<p> Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored. </p>" 671 } 672 }, 673 "MaximumInstanceCount": { 674 "base": "<p> Maximum number of Instances that can be instantiated for given InstanceType. </p>", 675 "refs": { 676 "InstanceCountLimits$MaximumInstanceCount": null 677 } 678 }, 679 "MinimumInstanceCount": { 680 "base": "<p> Minimum number of Instances that can be instantiated for given InstanceType. </p>", 681 "refs": { 682 "InstanceCountLimits$MinimumInstanceCount": null 683 } 684 }, 685 "NextToken": { 686 "base": "<p> Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. </p>", 687 "refs": { 688 "DescribeReservedElasticsearchInstanceOfferingsRequest$NextToken": "<p>NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.</p>", 689 "DescribeReservedElasticsearchInstanceOfferingsResponse$NextToken": "<p>Provides an identifier to allow retrieval of paginated results.</p>", 690 "DescribeReservedElasticsearchInstancesRequest$NextToken": "<p>NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.</p>", 691 "GetUpgradeHistoryRequest$NextToken": null, 692 "ListElasticsearchInstanceTypesRequest$NextToken": "<p>NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination. </p>", 693 "ListElasticsearchInstanceTypesResponse$NextToken": "<p>In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results. </p>", 694 "ListElasticsearchVersionsRequest$NextToken": null, 695 "ListElasticsearchVersionsResponse$NextToken": null 696 } 697 }, 698 "NodeToNodeEncryptionOptions": { 699 "base": "<p>Specifies the node-to-node encryption options.</p>", 700 "refs": { 701 "CreateElasticsearchDomainRequest$NodeToNodeEncryptionOptions": "<p>Specifies the NodeToNodeEncryptionOptions.</p>", 702 "ElasticsearchDomainStatus$NodeToNodeEncryptionOptions": "<p>Specifies the status of the <code>NodeToNodeEncryptionOptions</code>.</p>", 703 "NodeToNodeEncryptionOptionsStatus$Options": "<p>Specifies the node-to-node encryption options for the specified Elasticsearch domain.</p>" 704 } 705 }, 706 "NodeToNodeEncryptionOptionsStatus": { 707 "base": "<p>Status of the node-to-node encryption options for the specified Elasticsearch domain.</p>", 708 "refs": { 709 "ElasticsearchDomainConfig$NodeToNodeEncryptionOptions": "<p>Specifies the <code>NodeToNodeEncryptionOptions</code> for the Elasticsearch domain.</p>" 710 } 711 }, 712 "OptionState": { 713 "base": "<p>The state of a requested change. One of the following:</p> <ul> <li>Processing: The request change is still in-process.</li> <li>Active: The request change is processed and deployed to the Elasticsearch domain.</li> </ul>", 714 "refs": { 715 "OptionStatus$State": "<p>Provides the <code>OptionState</code> for the Elasticsearch domain.</p>" 716 } 717 }, 718 "OptionStatus": { 719 "base": "<p>Provides the current status of the entity.</p>", 720 "refs": { 721 "AccessPoliciesStatus$Status": "<p>The status of the access policy for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. </p>", 722 "AdvancedOptionsStatus$Status": "<p> Specifies the status of <code>OptionStatus</code> for advanced options for the specified Elasticsearch domain.</p>", 723 "CognitoOptionsStatus$Status": "<p>Specifies the status of the Cognito options for the specified Elasticsearch domain.</p>", 724 "DomainEndpointOptionsStatus$Status": "<p>The status of the endpoint options for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. </p>", 725 "EBSOptionsStatus$Status": "<p> Specifies the status of the EBS options for the specified Elasticsearch domain.</p>", 726 "ElasticsearchClusterConfigStatus$Status": "<p> Specifies the status of the configuration for the specified Elasticsearch domain.</p>", 727 "ElasticsearchVersionStatus$Status": "<p> Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.</p>", 728 "EncryptionAtRestOptionsStatus$Status": "<p> Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.</p>", 729 "LogPublishingOptionsStatus$Status": "<p>The status of the log publishing options for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. </p>", 730 "NodeToNodeEncryptionOptionsStatus$Status": "<p>Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.</p>", 731 "SnapshotOptionsStatus$Status": "<p>Specifies the status of a daily automated snapshot.</p>", 732 "VPCDerivedInfoStatus$Status": "<p> Specifies the status of the VPC options for the specified Elasticsearch domain.</p>" 733 } 734 }, 735 "PolicyDocument": { 736 "base": "<p>Access policy rules for an Elasticsearch domain service endpoints. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies\" target=\"_blank\">Configuring Access Policies</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>. The maximum size of a policy document is 100 KB.</p>", 737 "refs": { 738 "AccessPoliciesStatus$Options": "<p>The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies\" target=\"_blank\"> Configuring Access Policies</a>for more information.</p>", 739 "CreateElasticsearchDomainRequest$AccessPolicies": "<p> IAM access policy as a JSON-formatted string.</p>", 740 "ElasticsearchDomainStatus$AccessPolicies": "<p> IAM access policy as a JSON-formatted string.</p>", 741 "UpdateElasticsearchDomainConfigRequest$AccessPolicies": "<p>IAM access policy as a JSON-formatted string.</p>" 742 } 743 }, 744 "PurchaseReservedElasticsearchInstanceOfferingRequest": { 745 "base": "<p>Container for parameters to <code>PurchaseReservedElasticsearchInstanceOffering</code></p>", 746 "refs": { 747 } 748 }, 749 "PurchaseReservedElasticsearchInstanceOfferingResponse": { 750 "base": "<p>Represents the output of a <code>PurchaseReservedElasticsearchInstanceOffering</code> operation.</p>", 751 "refs": { 752 } 753 }, 754 "RecurringCharge": { 755 "base": "<p>Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.</p>", 756 "refs": { 757 "RecurringChargeList$member": null 758 } 759 }, 760 "RecurringChargeList": { 761 "base": null, 762 "refs": { 763 "ReservedElasticsearchInstance$RecurringCharges": "<p>The charge to your account regardless of whether you are creating any domains using the instance offering.</p>", 764 "ReservedElasticsearchInstanceOffering$RecurringCharges": "<p>The charge to your account regardless of whether you are creating any domains using the instance offering.</p>" 765 } 766 }, 767 "RemoveTagsRequest": { 768 "base": "<p>Container for the parameters to the <code><a>RemoveTags</a></code> operation. Specify the <code>ARN</code> for the Elasticsearch domain from which you want to remove the specified <code>TagKey</code>.</p>", 769 "refs": { 770 } 771 }, 772 "ReservationToken": { 773 "base": null, 774 "refs": { 775 "PurchaseReservedElasticsearchInstanceOfferingRequest$ReservationName": "<p>A customer-specified identifier to track this reservation.</p>", 776 "PurchaseReservedElasticsearchInstanceOfferingResponse$ReservationName": "<p>The customer-specified identifier used to track this reservation.</p>", 777 "ReservedElasticsearchInstance$ReservationName": "<p>The customer-specified identifier to track this reservation.</p>" 778 } 779 }, 780 "ReservedElasticsearchInstance": { 781 "base": "<p>Details of a reserved Elasticsearch instance.</p>", 782 "refs": { 783 "ReservedElasticsearchInstanceList$member": null 784 } 785 }, 786 "ReservedElasticsearchInstanceList": { 787 "base": null, 788 "refs": { 789 "DescribeReservedElasticsearchInstancesResponse$ReservedElasticsearchInstances": "<p>List of reserved Elasticsearch instances.</p>" 790 } 791 }, 792 "ReservedElasticsearchInstanceOffering": { 793 "base": "<p>Details of a reserved Elasticsearch instance offering.</p>", 794 "refs": { 795 "ReservedElasticsearchInstanceOfferingList$member": null 796 } 797 }, 798 "ReservedElasticsearchInstanceOfferingList": { 799 "base": null, 800 "refs": { 801 "DescribeReservedElasticsearchInstanceOfferingsResponse$ReservedElasticsearchInstanceOfferings": "<p>List of reserved Elasticsearch instance offerings</p>" 802 } 803 }, 804 "ReservedElasticsearchInstancePaymentOption": { 805 "base": null, 806 "refs": { 807 "ReservedElasticsearchInstance$PaymentOption": "<p>The payment option as defined in the reserved Elasticsearch instance offering.</p>", 808 "ReservedElasticsearchInstanceOffering$PaymentOption": "<p>Payment option for the reserved Elasticsearch instance offering</p>" 809 } 810 }, 811 "ResourceAlreadyExistsException": { 812 "base": "<p>An exception for creating a resource that already exists. Gives http status code of 400.</p>", 813 "refs": { 814 } 815 }, 816 "ResourceNotFoundException": { 817 "base": "<p>An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.</p>", 818 "refs": { 819 } 820 }, 821 "RoleArn": { 822 "base": null, 823 "refs": { 824 "CognitoOptions$RoleArn": "<p>Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.</p>" 825 } 826 }, 827 "ServiceSoftwareOptions": { 828 "base": "<p>The current options of an Elasticsearch domain service software options.</p>", 829 "refs": { 830 "CancelElasticsearchServiceSoftwareUpdateResponse$ServiceSoftwareOptions": "<p>The current status of the Elasticsearch service software update.</p>", 831 "ElasticsearchDomainStatus$ServiceSoftwareOptions": "<p>The current status of the Elasticsearch domain's service software.</p>", 832 "StartElasticsearchServiceSoftwareUpdateResponse$ServiceSoftwareOptions": "<p>The current status of the Elasticsearch service software update.</p>" 833 } 834 }, 835 "ServiceUrl": { 836 "base": "<p>The endpoint to which service requests are submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com</code>.</p>", 837 "refs": { 838 "ElasticsearchDomainStatus$Endpoint": "<p>The Elasticsearch domain endpoint that you use to submit index and search requests.</p>", 839 "EndpointsMap$value": null 840 } 841 }, 842 "SnapshotOptions": { 843 "base": "<p>Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.</p>", 844 "refs": { 845 "CreateElasticsearchDomainRequest$SnapshotOptions": "<p>Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours. </p>", 846 "ElasticsearchDomainStatus$SnapshotOptions": "<p>Specifies the status of the <code>SnapshotOptions</code></p>", 847 "SnapshotOptionsStatus$Options": "<p>Specifies the daily snapshot options specified for the Elasticsearch domain.</p>", 848 "UpdateElasticsearchDomainConfigRequest$SnapshotOptions": "<p>Option to set the time, in UTC format, for the daily automated snapshot. Default value is <code>0</code> hours. </p>" 849 } 850 }, 851 "SnapshotOptionsStatus": { 852 "base": "<p>Status of a daily automated snapshot.</p>", 853 "refs": { 854 "ElasticsearchDomainConfig$SnapshotOptions": "<p>Specifies the <code>SnapshotOptions</code> for the Elasticsearch domain.</p>" 855 } 856 }, 857 "StartElasticsearchServiceSoftwareUpdateRequest": { 858 "base": "<p>Container for the parameters to the <code><a>StartElasticsearchServiceSoftwareUpdate</a></code> operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.</p>", 859 "refs": { 860 } 861 }, 862 "StartElasticsearchServiceSoftwareUpdateResponse": { 863 "base": "<p>The result of a <code>StartElasticsearchServiceSoftwareUpdate</code> operation. Contains the status of the update.</p>", 864 "refs": { 865 } 866 }, 867 "StartTimestamp": { 868 "base": null, 869 "refs": { 870 "UpgradeHistory$StartTimestamp": "<p>UTC Timestamp at which the Upgrade API call was made in \"yyyy-MM-ddTHH:mm:ssZ\" format.</p>" 871 } 872 }, 873 "StorageSubTypeName": { 874 "base": "<p> SubType of the given storage type. List of available sub-storage options: For \"instance\" storageType we wont have any storageSubType, in case of \"ebs\" storageType we will have following valid storageSubTypes <ol> <li>standard</li> <li>gp2</li> <li>io1</li> </ol> Refer <code><a>VolumeType</a></code> for more information regarding above EBS storage options. </p>", 875 "refs": { 876 "StorageType$StorageSubTypeName": null 877 } 878 }, 879 "StorageType": { 880 "base": "<p>StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType. </p>", 881 "refs": { 882 "StorageTypeList$member": null 883 } 884 }, 885 "StorageTypeLimit": { 886 "base": "<p>Limits that are applicable for given storage type. </p>", 887 "refs": { 888 "StorageTypeLimitList$member": null 889 } 890 }, 891 "StorageTypeLimitList": { 892 "base": null, 893 "refs": { 894 "StorageType$StorageTypeLimits": "<p>List of limits that are applicable for given storage type. </p>" 895 } 896 }, 897 "StorageTypeList": { 898 "base": null, 899 "refs": { 900 "Limits$StorageTypes": "<p>StorageType represents the list of storage related types and attributes that are available for given InstanceType. </p>" 901 } 902 }, 903 "StorageTypeName": { 904 "base": "<p> Type of the storage. List of available storage options: <ol> <li>instance</li> Inbuilt storage available for the given Instance <li>ebs</li> Elastic block storage that would be attached to the given Instance </ol> </p>", 905 "refs": { 906 "StorageType$StorageTypeName": null 907 } 908 }, 909 "String": { 910 "base": null, 911 "refs": { 912 "AdvancedOptions$key": null, 913 "AdvancedOptions$value": null, 914 "DescribeReservedElasticsearchInstancesResponse$NextToken": "<p>Provides an identifier to allow retrieval of paginated results.</p>", 915 "EndpointsMap$key": null, 916 "GetUpgradeHistoryResponse$NextToken": "<p>Pagination token that needs to be supplied to the next call to get the next page of results</p>", 917 "RecurringCharge$RecurringChargeFrequency": "<p>The frequency of the recurring charge.</p>", 918 "ReservedElasticsearchInstance$ReservedElasticsearchInstanceOfferingId": "<p>The offering identifier.</p>", 919 "ReservedElasticsearchInstance$CurrencyCode": "<p>The currency code for the reserved Elasticsearch instance offering.</p>", 920 "ReservedElasticsearchInstance$State": "<p>The state of the reserved Elasticsearch instance.</p>", 921 "ReservedElasticsearchInstanceOffering$CurrencyCode": "<p>The currency code for the reserved Elasticsearch instance offering.</p>", 922 "ServiceSoftwareOptions$CurrentVersion": "<p>The current service software version that is present on the domain.</p>", 923 "ServiceSoftwareOptions$NewVersion": "<p>The new service software version if one is available.</p>", 924 "ServiceSoftwareOptions$Description": "<p>The description of the <code>UpdateStatus</code>.</p>", 925 "StringList$member": null, 926 "VPCDerivedInfo$VPCId": "<p>The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.</p>" 927 } 928 }, 929 "StringList": { 930 "base": null, 931 "refs": { 932 "RemoveTagsRequest$TagKeys": "<p>Specifies the <code>TagKey</code> list which you want to remove from the Elasticsearch domain.</p>", 933 "VPCDerivedInfo$SubnetIds": "<p>Specifies the subnets for VPC endpoint.</p>", 934 "VPCDerivedInfo$AvailabilityZones": "<p>The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.</p>", 935 "VPCDerivedInfo$SecurityGroupIds": "<p>Specifies the security groups for VPC endpoint.</p>", 936 "VPCOptions$SubnetIds": "<p>Specifies the subnets for VPC endpoint.</p>", 937 "VPCOptions$SecurityGroupIds": "<p>Specifies the security groups for VPC endpoint.</p>" 938 } 939 }, 940 "TLSSecurityPolicy": { 941 "base": null, 942 "refs": { 943 "DomainEndpointOptions$TLSSecurityPolicy": "<p>Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. <br/> It can be one of the following values: <ul> <li><b>Policy-Min-TLS-1-0-2019-07: </b> TLS security policy which supports TLSv1.0 and higher.</li> <li><b>Policy-Min-TLS-1-2-2019-07: </b> TLS security policy which supports only TLSv1.2</li> </ul> </p>" 944 } 945 }, 946 "Tag": { 947 "base": "<p>Specifies a key value pair for a resource tag.</p>", 948 "refs": { 949 "TagList$member": null 950 } 951 }, 952 "TagKey": { 953 "base": "<p>A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.</p>", 954 "refs": { 955 "Tag$Key": "<p>Specifies the <code>TagKey</code>, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.</p>" 956 } 957 }, 958 "TagList": { 959 "base": "<p>A list of <code>Tag</code> </p>", 960 "refs": { 961 "AddTagsRequest$TagList": "<p> List of <code>Tag</code> that need to be added for the Elasticsearch domain. </p>", 962 "ListTagsResponse$TagList": "<p> List of <code>Tag</code> for the requested Elasticsearch domain.</p>" 963 } 964 }, 965 "TagValue": { 966 "base": "<p>A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set.</p>", 967 "refs": { 968 "Tag$Value": "<p>Specifies the <code>TagValue</code>, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of <code>project : Trinity</code> and <code>cost-center : Trinity</code></p>" 969 } 970 }, 971 "UIntValue": { 972 "base": null, 973 "refs": { 974 "OptionStatus$UpdateVersion": "<p>Specifies the latest version for the entity.</p>" 975 } 976 }, 977 "UpdateElasticsearchDomainConfigRequest": { 978 "base": "<p>Container for the parameters to the <code><a>UpdateElasticsearchDomain</a></code> operation. Specifies the type and number of instances in the domain cluster.</p>", 979 "refs": { 980 } 981 }, 982 "UpdateElasticsearchDomainConfigResponse": { 983 "base": "<p>The result of an <code>UpdateElasticsearchDomain</code> request. Contains the status of the Elasticsearch domain being updated.</p>", 984 "refs": { 985 } 986 }, 987 "UpdateTimestamp": { 988 "base": null, 989 "refs": { 990 "OptionStatus$CreationDate": "<p>Timestamp which tells the creation date for the entity.</p>", 991 "OptionStatus$UpdateDate": "<p>Timestamp which tells the last updated time for the entity.</p>", 992 "ReservedElasticsearchInstance$StartTime": "<p>The time the reservation started.</p>" 993 } 994 }, 995 "UpgradeElasticsearchDomainRequest": { 996 "base": "<p> Container for request parameters to <code> <a>UpgradeElasticsearchDomain</a> </code> operation. </p>", 997 "refs": { 998 } 999 }, 1000 "UpgradeElasticsearchDomainResponse": { 1001 "base": "<p> Container for response returned by <code> <a>UpgradeElasticsearchDomain</a> </code> operation. </p>", 1002 "refs": { 1003 } 1004 }, 1005 "UpgradeHistory": { 1006 "base": "<p>History of the last 10 Upgrades and Upgrade Eligibility Checks.</p>", 1007 "refs": { 1008 "UpgradeHistoryList$member": null 1009 } 1010 }, 1011 "UpgradeHistoryList": { 1012 "base": null, 1013 "refs": { 1014 "GetUpgradeHistoryResponse$UpgradeHistories": "<p> A list of <code> <a>UpgradeHistory</a> </code> objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of <code> <a>GetUpgradeHistoryResponse</a> </code> object. </p>" 1015 } 1016 }, 1017 "UpgradeName": { 1018 "base": null, 1019 "refs": { 1020 "GetUpgradeStatusResponse$UpgradeName": "<p>A string that describes the update briefly</p>", 1021 "UpgradeHistory$UpgradeName": "<p>A string that describes the update briefly</p>" 1022 } 1023 }, 1024 "UpgradeStatus": { 1025 "base": null, 1026 "refs": { 1027 "GetUpgradeStatusResponse$StepStatus": "<p> One of 4 statuses that a step can go through returned as part of the <code> <a>GetUpgradeStatusResponse</a> </code> object. The status can take one of the following values: <ul> <li>In Progress</li> <li>Succeeded</li> <li>Succeeded with Issues</li> <li>Failed</li> </ul> </p>", 1028 "UpgradeHistory$UpgradeStatus": "<p> The overall status of the update. The status can take one of the following values: <ul> <li>In Progress</li> <li>Succeeded</li> <li>Succeeded with Issues</li> <li>Failed</li> </ul> </p>", 1029 "UpgradeStepItem$UpgradeStepStatus": "<p> The status of a particular step during an upgrade. The status can take one of the following values: <ul> <li>In Progress</li> <li>Succeeded</li> <li>Succeeded with Issues</li> <li>Failed</li> </ul> </p>" 1030 } 1031 }, 1032 "UpgradeStep": { 1033 "base": null, 1034 "refs": { 1035 "GetUpgradeStatusResponse$UpgradeStep": "<p> Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: <ul> <li>PreUpgradeCheck</li> <li>Snapshot</li> <li>Upgrade</li> </ul> </p>", 1036 "UpgradeStepItem$UpgradeStep": "<p> Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: <ul> <li>PreUpgradeCheck</li> <li>Snapshot</li> <li>Upgrade</li> </ul> </p>" 1037 } 1038 }, 1039 "UpgradeStepItem": { 1040 "base": "<p>Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.</p>", 1041 "refs": { 1042 "UpgradeStepsList$member": null 1043 } 1044 }, 1045 "UpgradeStepsList": { 1046 "base": null, 1047 "refs": { 1048 "UpgradeHistory$StepsList": "<p> A list of <code> <a>UpgradeStepItem</a> </code> s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check. </p>" 1049 } 1050 }, 1051 "UserPoolId": { 1052 "base": null, 1053 "refs": { 1054 "CognitoOptions$UserPoolId": "<p>Specifies the Cognito user pool ID for Kibana authentication.</p>" 1055 } 1056 }, 1057 "VPCDerivedInfo": { 1058 "base": "<p>Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html\" target=\"_blank\"> VPC Endpoints for Amazon Elasticsearch Service Domains</a>.</p>", 1059 "refs": { 1060 "ElasticsearchDomainStatus$VPCOptions": "<p>The <code>VPCOptions</code> for the specified domain. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html\" target=\"_blank\">VPC Endpoints for Amazon Elasticsearch Service Domains</a>.</p>", 1061 "VPCDerivedInfoStatus$Options": "<p> Specifies the VPC options for the specified Elasticsearch domain.</p>" 1062 } 1063 }, 1064 "VPCDerivedInfoStatus": { 1065 "base": "<p> Status of the VPC options for the specified Elasticsearch domain.</p>", 1066 "refs": { 1067 "ElasticsearchDomainConfig$VPCOptions": "<p>The <code>VPCOptions</code> for the specified domain. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html\" target=\"_blank\">VPC Endpoints for Amazon Elasticsearch Service Domains</a>.</p>" 1068 } 1069 }, 1070 "VPCOptions": { 1071 "base": "<p>Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html\" target=\"_blank\"> VPC Endpoints for Amazon Elasticsearch Service Domains</a>.</p>", 1072 "refs": { 1073 "CreateElasticsearchDomainRequest$VPCOptions": "<p>Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc\" target=\"_blank\">Creating a VPC</a> in <i>VPC Endpoints for Amazon Elasticsearch Service Domains</i></p>", 1074 "UpdateElasticsearchDomainConfigRequest$VPCOptions": "<p>Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html#es-creating-vpc\" target=\"_blank\">Creating a VPC</a> in <i>VPC Endpoints for Amazon Elasticsearch Service Domains</i></p>" 1075 } 1076 }, 1077 "ValidationException": { 1078 "base": "<p>An exception for missing / invalid input fields. Gives http status code of 400.</p>", 1079 "refs": { 1080 } 1081 }, 1082 "VolumeType": { 1083 "base": "<p> The type of EBS volume, standard, gp2, or io1. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs\" target=\"_blank\">Configuring EBS-based Storage</a>for more information.</p>", 1084 "refs": { 1085 "EBSOptions$VolumeType": "<p> Specifies the volume type for EBS-based storage.</p>" 1086 } 1087 }, 1088 "ZoneAwarenessConfig": { 1089 "base": "<p>Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.</p>", 1090 "refs": { 1091 "ElasticsearchClusterConfig$ZoneAwarenessConfig": "<p>Specifies the zone awareness configuration for a domain when zone awareness is enabled.</p>" 1092 } 1093 } 1094 } 1095} 1096