github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/opensearch/2021-01-01/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<fullname>Amazon OpenSearch Configuration Service</fullname> <p>Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains.</p> <p>For sample code that uses the configuration API, see the <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-configuration-samples.html\"> Amazon OpenSearch Service Developer Guide</a>. The guide also contains <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/request-signing.html\"> sample code for sending signed HTTP requests to the OpenSearch 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#service-regions\" target=\"_blank\">Regions and Endpoints</a>. </p>", 4 "operations": { 5 "AcceptInboundConnection": "<p>Allows the remote domain owner to accept an inbound cross-cluster connection request.</p>", 6 "AddTags": "<p>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 <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-awsresorcetagging\" target=\"_blank\"> Tagging Amazon OpenSearch Service domains</a> for more information. </p>", 7 "AssociatePackage": "<p>Associates a package with an Amazon OpenSearch Service domain.</p>", 8 "CancelServiceSoftwareUpdate": "<p>Cancels a scheduled service software update for an Amazon OpenSearch Service 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>", 9 "CreateDomain": "<p>Creates a new Amazon OpenSearch Service domain. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html\" target=\"_blank\">Creating and managing Amazon OpenSearch Service domains </a> in the <i>Amazon OpenSearch Service Developer Guide</i>. </p>", 10 "CreateOutboundConnection": "<p>Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.</p>", 11 "CreatePackage": "<p>Create a package for use with Amazon OpenSearch Service domains.</p>", 12 "DeleteDomain": "<p>Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered. </p>", 13 "DeleteInboundConnection": "<p>Allows the remote domain owner to delete an existing inbound cross-cluster connection.</p>", 14 "DeleteOutboundConnection": "<p>Allows the local domain owner to delete an existing outbound cross-cluster connection.</p>", 15 "DeletePackage": "<p>Deletes the package.</p>", 16 "DescribeDomain": "<p>Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN. </p>", 17 "DescribeDomainAutoTunes": "<p>Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date. </p>", 18 "DescribeDomainConfig": "<p>Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options. </p>", 19 "DescribeDomains": "<p>Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN. </p>", 20 "DescribeInboundConnections": "<p>Lists all the inbound cross-cluster connections for a remote domain.</p>", 21 "DescribeInstanceTypeLimits": "<p> Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the <code> <a>DomainName</a> </code> to see which limits you can modify. </p>", 22 "DescribeOutboundConnections": "<p>Lists all the outbound cross-cluster connections for a local domain.</p>", 23 "DescribePackages": "<p>Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination. </p>", 24 "DescribeReservedInstanceOfferings": "<p>Lists available reserved OpenSearch instance offerings.</p>", 25 "DescribeReservedInstances": "<p>Returns information about reserved OpenSearch instances for this account.</p>", 26 "DissociatePackage": "<p>Dissociates a package from the Amazon OpenSearch Service domain.</p>", 27 "GetCompatibleVersions": "<p> Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a <code> <a>DomainName</a> </code> to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain. </p>", 28 "GetPackageVersionHistory": "<p>Returns a list of package versions, along with their creation time and commit message.</p>", 29 "GetUpgradeHistory": "<p>Retrieves the complete history of the last 10 upgrades performed on the domain.</p>", 30 "GetUpgradeStatus": "<p>Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain. </p>", 31 "ListDomainNames": "<p>Returns the names of all domains owned by the current user's account.</p>", 32 "ListDomainsForPackage": "<p>Lists all Amazon OpenSearch Service domains associated with the package.</p>", 33 "ListInstanceTypeDetails": null, 34 "ListPackagesForDomain": "<p>Lists all packages associated with the Amazon OpenSearch Service domain.</p>", 35 "ListTags": "<p>Returns all tags for the given domain.</p>", 36 "ListVersions": "<p>List all supported versions of OpenSearch and Elasticsearch.</p>", 37 "PurchaseReservedInstanceOffering": "<p>Allows you to purchase reserved OpenSearch instances.</p>", 38 "RejectInboundConnection": "<p>Allows the remote domain owner to reject an inbound cross-cluster connection request.</p>", 39 "RemoveTags": "<p>Removes the specified set of tags from the given domain.</p>", 40 "StartServiceSoftwareUpdate": "<p>Schedules a service software update for an Amazon OpenSearch Service domain.</p>", 41 "UpdateDomainConfig": "<p>Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances. </p>", 42 "UpdatePackage": "<p>Updates a package for use with Amazon OpenSearch Service domains.</p>", 43 "UpgradeDomain": "<p>Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch. </p>" 44 }, 45 "shapes": { 46 "ARN": { 47 "base": "<p>The Amazon Resource Name (ARN) of the domain. See <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html\" target=\"_blank\">Identifiers for IAM Entities </a> in <i>Using AWS Identity and Access Management</i> for more information. </p>", 48 "refs": { 49 "AddTagsRequest$ARN": "<p>Specify the <code>ARN</code> of the domain you want to add tags to. </p>", 50 "DomainEndpointOptions$CustomEndpointCertificateArn": "<p>The ACM certificate ARN for your custom endpoint.</p>", 51 "DomainStatus$ARN": "<p>The Amazon Resource Name (ARN) of a domain. See <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html\" target=\"_blank\">IAM identifiers </a> in the <i>AWS Identity and Access Management User Guide</i> for more information. </p>", 52 "ListTagsRequest$ARN": "<p>Specify the <code>ARN</code> of the domain that the tags you want to view are attached to. </p>", 53 "MasterUserOptions$MasterUserARN": "<p>ARN for the master user (if IAM is enabled).</p>", 54 "RemoveTagsRequest$ARN": "<p>The <code>ARN</code> of the domain from which you want to delete the specified tags. </p>" 55 } 56 }, 57 "AWSDomainInformation": { 58 "base": null, 59 "refs": { 60 "DomainInformationContainer$AWSDomainInformation": null 61 } 62 }, 63 "AcceptInboundConnectionRequest": { 64 "base": "<p>Container for the parameters to the <code> <a>AcceptInboundConnection</a> </code> operation. </p>", 65 "refs": { 66 } 67 }, 68 "AcceptInboundConnectionResponse": { 69 "base": "<p>The result of an <code> <a>AcceptInboundConnection</a> </code> operation. Contains details about the accepted inbound connection. </p>", 70 "refs": { 71 } 72 }, 73 "AccessDeniedException": { 74 "base": "<p>An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.</p>", 75 "refs": { 76 } 77 }, 78 "AccessPoliciesStatus": { 79 "base": "<p>The configured access rules for the domain's document and search endpoints, and the current status of those rules. </p>", 80 "refs": { 81 "DomainConfig$AccessPolicies": "<p>IAM access policy as a JSON-formatted string.</p>" 82 } 83 }, 84 "AddTagsRequest": { 85 "base": "<p>Container for the parameters to the <code> <a>AddTags</a> </code> operation. Specifies the tags to attach to the domain. </p>", 86 "refs": { 87 } 88 }, 89 "AdditionalLimit": { 90 "base": "<p> List of limits that are specific to a given InstanceType and for each of its <code> <a>InstanceRole</a> </code> . </p>", 91 "refs": { 92 "AdditionalLimitList$member": null 93 } 94 }, 95 "AdditionalLimitList": { 96 "base": null, 97 "refs": { 98 "Limits$AdditionalLimits": "<p> List of additional limits that are specific to a given InstanceType and for each of its <code> <a>InstanceRole</a> </code> . </p>" 99 } 100 }, 101 "AdvancedOptions": { 102 "base": "<p>Exposes select native OpenSearch configuration values from <code>opensearch.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/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options\" target=\"_blank\">Advanced cluster parameters </a> for more information. </li> <li>Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded. </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options\"> Advanced cluster parameters</a>. </p>", 103 "refs": { 104 "AdvancedOptionsStatus$Options": "<p>The status of advanced options for the specified domain.</p>", 105 "CreateDomainRequest$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/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options\" target=\"_blank\">Advanced cluster parameters </a> for more information. </p>", 106 "DomainStatus$AdvancedOptions": "<p>The status of the <code>AdvancedOptions</code>. </p>", 107 "UpdateDomainConfigRequest$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/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options\" target=\"_blank\">Advanced options </a> for more information. </p>", 108 "UpgradeDomainRequest$AdvancedOptions": null, 109 "UpgradeDomainResponse$AdvancedOptions": null 110 } 111 }, 112 "AdvancedOptionsStatus": { 113 "base": "<p>Status of the advanced options for the specified 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/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options\" target=\"_blank\">Advanced cluster parameters </a> for more information. </li> <li>Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded. </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options\"> Advanced cluster parameters</a>. </p>", 114 "refs": { 115 "DomainConfig$AdvancedOptions": "<p>The <code>AdvancedOptions</code> for the domain. See <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options\" target=\"_blank\">Advanced options </a> for more information. </p>" 116 } 117 }, 118 "AdvancedSecurityOptions": { 119 "base": "<p>The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled. </p>", 120 "refs": { 121 "AdvancedSecurityOptionsStatus$Options": "<p>Advanced security options for the specified domain.</p>", 122 "DomainStatus$AdvancedSecurityOptions": "<p>The current status of the domain's advanced security options.</p>" 123 } 124 }, 125 "AdvancedSecurityOptionsInput": { 126 "base": "<p>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). </p>", 127 "refs": { 128 "CreateDomainRequest$AdvancedSecurityOptions": "<p>Specifies advanced security options.</p>", 129 "UpdateDomainConfigRequest$AdvancedSecurityOptions": "<p>Specifies advanced security options.</p>" 130 } 131 }, 132 "AdvancedSecurityOptionsStatus": { 133 "base": "<p>The status of advanced security options for the specified domain.</p>", 134 "refs": { 135 "DomainConfig$AdvancedSecurityOptions": "<p>Specifies <code>AdvancedSecurityOptions</code> for the domain. </p>" 136 } 137 }, 138 "AssociatePackageRequest": { 139 "base": "<p> Container for the request parameters to the <code> <a>AssociatePackage</a> </code> operation. </p>", 140 "refs": { 141 } 142 }, 143 "AssociatePackageResponse": { 144 "base": "<p> Container for the response returned by <code> <a>AssociatePackage</a> </code> operation. </p>", 145 "refs": { 146 } 147 }, 148 "AutoTune": { 149 "base": "<p>Specifies the Auto-Tune type and Auto-Tune action details.</p>", 150 "refs": { 151 "AutoTuneList$member": null 152 } 153 }, 154 "AutoTuneDate": { 155 "base": "<p>The timestamp of the Auto-Tune action scheduled for the domain.</p>", 156 "refs": { 157 "ScheduledAutoTuneDetails$Date": "<p>The timestamp of the Auto-Tune action scheduled for the domain.</p>" 158 } 159 }, 160 "AutoTuneDesiredState": { 161 "base": "<p>The Auto-Tune desired state. Valid values are ENABLED and DISABLED.</p>", 162 "refs": { 163 "AutoTuneOptions$DesiredState": "<p>The Auto-Tune desired state. Valid values are ENABLED and DISABLED.</p>", 164 "AutoTuneOptionsInput$DesiredState": "<p>The Auto-Tune desired state. Valid values are ENABLED and DISABLED.</p>" 165 } 166 }, 167 "AutoTuneDetails": { 168 "base": "<p>Specifies details about the Auto-Tune action. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>", 169 "refs": { 170 "AutoTune$AutoTuneDetails": "<p>Specifies details about the Auto-Tune action. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>" 171 } 172 }, 173 "AutoTuneList": { 174 "base": null, 175 "refs": { 176 "DescribeDomainAutoTunesResponse$AutoTunes": "<p>The list of setting adjustments that Auto-Tune has made to the domain. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>" 177 } 178 }, 179 "AutoTuneMaintenanceSchedule": { 180 "base": "<p>Specifies the Auto-Tune maintenance schedule. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>", 181 "refs": { 182 "AutoTuneMaintenanceScheduleList$member": null 183 } 184 }, 185 "AutoTuneMaintenanceScheduleList": { 186 "base": null, 187 "refs": { 188 "AutoTuneOptions$MaintenanceSchedules": "<p>A list of maintenance schedules. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>", 189 "AutoTuneOptionsInput$MaintenanceSchedules": "<p>A list of maintenance schedules. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>" 190 } 191 }, 192 "AutoTuneOptions": { 193 "base": "<p>The Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules. </p>", 194 "refs": { 195 "AutoTuneOptionsStatus$Options": "<p>Specifies Auto-Tune options for the domain.</p>", 196 "UpdateDomainConfigRequest$AutoTuneOptions": "<p>Specifies Auto-Tune options.</p>" 197 } 198 }, 199 "AutoTuneOptionsInput": { 200 "base": "<p>The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules. </p>", 201 "refs": { 202 "CreateDomainRequest$AutoTuneOptions": "<p>Specifies Auto-Tune options.</p>" 203 } 204 }, 205 "AutoTuneOptionsOutput": { 206 "base": "<p>The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules. </p>", 207 "refs": { 208 "DomainStatus$AutoTuneOptions": "<p>The current status of the domain's Auto-Tune options.</p>" 209 } 210 }, 211 "AutoTuneOptionsStatus": { 212 "base": "<p>The Auto-Tune status for the domain.</p>", 213 "refs": { 214 "DomainConfig$AutoTuneOptions": "<p>Specifies <code>AutoTuneOptions</code> for the domain. </p>" 215 } 216 }, 217 "AutoTuneState": { 218 "base": "<p>The Auto-Tune state for the domain. For valid states see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service</a>. </p>", 219 "refs": { 220 "AutoTuneOptionsOutput$State": "<p>The <code>AutoTuneState</code> for the domain. </p>", 221 "AutoTuneStatus$State": "<p>The <code>AutoTuneState</code> for the domain. </p>" 222 } 223 }, 224 "AutoTuneStatus": { 225 "base": "<p>Provides the current Auto-Tune status for the domain.</p>", 226 "refs": { 227 "AutoTuneOptionsStatus$Status": "<p>The status of the Auto-Tune options for the domain.</p>" 228 } 229 }, 230 "AutoTuneType": { 231 "base": "<p>Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.</p>", 232 "refs": { 233 "AutoTune$AutoTuneType": "<p>Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.</p>" 234 } 235 }, 236 "BackendRole": { 237 "base": null, 238 "refs": { 239 "SAMLOptionsInput$MasterBackendRole": "<p>The backend role that the SAML master user is mapped to.</p>" 240 } 241 }, 242 "BaseException": { 243 "base": "<p>An error occurred while processing the request.</p>", 244 "refs": { 245 } 246 }, 247 "Boolean": { 248 "base": null, 249 "refs": { 250 "AdvancedSecurityOptions$Enabled": "<p>True if advanced security is enabled.</p>", 251 "AdvancedSecurityOptions$InternalUserDatabaseEnabled": "<p>True if the internal user database is enabled.</p>", 252 "AdvancedSecurityOptionsInput$Enabled": "<p>True if advanced security is enabled.</p>", 253 "AdvancedSecurityOptionsInput$InternalUserDatabaseEnabled": "<p>True if the internal user database is enabled.</p>", 254 "AutoTuneStatus$PendingDeletion": "<p>Indicates whether the domain is being deleted.</p>", 255 "ClusterConfig$DedicatedMasterEnabled": "<p>A boolean value to indicate whether a dedicated master node is enabled. See <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains.html#managedomains-dedicatedmasternodes\" target=\"_blank\">Dedicated master nodes in Amazon OpenSearch Service </a> for more information. </p>", 256 "ClusterConfig$ZoneAwarenessEnabled": "<p>A boolean value to indicate whether zone awareness is enabled. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html\" target=\"_blank\">Configuring a multi-AZ domain in Amazon OpenSearch Service </a> for more information. </p>", 257 "ClusterConfig$WarmEnabled": "<p>True to enable UltraWarm storage.</p>", 258 "CognitoOptions$Enabled": "<p>The option to enable Cognito for OpenSearch Dashboards authentication.</p>", 259 "ColdStorageOptions$Enabled": "<p>Enable cold storage option. Accepted values true or false</p>", 260 "DomainEndpointOptions$EnforceHTTPS": "<p>Whether only HTTPS endpoint should be enabled for the domain.</p>", 261 "DomainEndpointOptions$CustomEndpointEnabled": "<p>Whether to enable a custom endpoint for the domain.</p>", 262 "DomainStatus$Created": "<p>The domain creation status. <code>True</code> if the creation of a domain is complete. <code> False </code> if domain creation is still in progress. </p>", 263 "DomainStatus$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>", 264 "DomainStatus$Processing": "<p>The status of the domain configuration. <code>True</code> if Amazon OpenSearch Service is processing configuration changes. <code>False</code> if the configuration is active. </p>", 265 "DomainStatus$UpgradeProcessing": "<p>The status of a domain version upgrade. <code>True</code> if Amazon OpenSearch Service is undergoing a version upgrade. <code>False</code> if the configuration is active. </p>", 266 "EBSOptions$EBSEnabled": "<p>Whether EBS-based storage is enabled.</p>", 267 "EncryptionAtRestOptions$Enabled": "<p>The option to enable encryption at rest.</p>", 268 "InstanceTypeDetails$EncryptionEnabled": null, 269 "InstanceTypeDetails$CognitoEnabled": null, 270 "InstanceTypeDetails$AppLogsEnabled": null, 271 "InstanceTypeDetails$AdvancedSecurityEnabled": null, 272 "InstanceTypeDetails$WarmEnabled": null, 273 "LogPublishingOption$Enabled": "<p>Whether the given log publishing option is enabled or not.</p>", 274 "NodeToNodeEncryptionOptions$Enabled": "<p>True to enable node-to-node encryption.</p>", 275 "OptionStatus$PendingDeletion": "<p>Indicates whether the domain is being deleted.</p>", 276 "SAMLOptionsInput$Enabled": "<p>True if SAML is enabled.</p>", 277 "SAMLOptionsOutput$Enabled": "<p>True if SAML is enabled.</p>", 278 "ServiceSoftwareOptions$UpdateAvailable": "<p> <code>True</code> if you're able to update your service software version. <code>False</code> if you can't update your service software version. </p>", 279 "ServiceSoftwareOptions$Cancellable": "<p> <code>True</code> if you're able to cancel your service software version update. <code>False</code> if you can't cancel your service software update. </p>", 280 "ServiceSoftwareOptions$OptionalDeployment": "<p> <code>True</code> if a service software is never automatically updated. <code>False</code> if a service software is automatically updated after <code>AutomatedUpdateDate</code>. </p>", 281 "UpgradeDomainRequest$PerformCheckOnly": "<p> When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade. </p>", 282 "UpgradeDomainResponse$PerformCheckOnly": "<p> When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade. </p>" 283 } 284 }, 285 "CancelServiceSoftwareUpdateRequest": { 286 "base": "<p>Container for the parameters to the <code> <a>CancelServiceSoftwareUpdate</a> </code> operation. Specifies the name of the domain that you wish to cancel a service software update on. </p>", 287 "refs": { 288 } 289 }, 290 "CancelServiceSoftwareUpdateResponse": { 291 "base": "<p>The result of a <code>CancelServiceSoftwareUpdate</code> operation. Contains the status of the update. </p>", 292 "refs": { 293 } 294 }, 295 "CloudWatchLogsLogGroupArn": { 296 "base": "<p>ARN of the Cloudwatch log group to publish logs to.</p>", 297 "refs": { 298 "LogPublishingOption$CloudWatchLogsLogGroupArn": null 299 } 300 }, 301 "ClusterConfig": { 302 "base": "<p>The configuration for the domain cluster, such as the type and number of instances.</p>", 303 "refs": { 304 "ClusterConfigStatus$Options": "<p>The cluster configuration for the specified domain.</p>", 305 "CreateDomainRequest$ClusterConfig": "<p>Configuration options for a domain. Specifies the instance type and number of instances in the domain. </p>", 306 "DomainStatus$ClusterConfig": "<p>The type and number of instances in the domain.</p>", 307 "UpdateDomainConfigRequest$ClusterConfig": "<p>The type and number of instances to instantiate for the domain cluster.</p>" 308 } 309 }, 310 "ClusterConfigStatus": { 311 "base": "<p>The configuration status for the specified domain.</p>", 312 "refs": { 313 "DomainConfig$ClusterConfig": "<p>The <code>ClusterConfig</code> for the domain. </p>" 314 } 315 }, 316 "CognitoOptions": { 317 "base": "<p>Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html\" target=\"_blank\">Configuring Amazon Cognito authentication for OpenSearch Dashboards</a>. </p>", 318 "refs": { 319 "CognitoOptionsStatus$Options": "<p>Cognito options for the specified domain.</p>", 320 "CreateDomainRequest$CognitoOptions": "<p>Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html\" target=\"_blank\">Configuring Amazon Cognito authentication for OpenSearch Dashboards</a>. </p>", 321 "DomainStatus$CognitoOptions": "<p>The <code>CognitoOptions</code> for the specified domain. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html\" target=\"_blank\">Configuring Amazon Cognito authentication for OpenSearch Dashboards</a>. </p>", 322 "UpdateDomainConfigRequest$CognitoOptions": "<p>Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html\" target=\"_blank\">Configuring Amazon Cognito authentication for OpenSearch Dashboards</a>. </p>" 323 } 324 }, 325 "CognitoOptionsStatus": { 326 "base": "<p>The status of the Cognito options for the specified domain.</p>", 327 "refs": { 328 "DomainConfig$CognitoOptions": "<p>The <code>CognitoOptions</code> for the specified domain. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html\" target=\"_blank\">Configuring Amazon Cognito authentication for OpenSearch Dashboards</a>. </p>" 329 } 330 }, 331 "ColdStorageOptions": { 332 "base": "<p>Specifies the configuration for cold storage options such as enabled</p>", 333 "refs": { 334 "ClusterConfig$ColdStorageOptions": "<p>Specifies the <code>ColdStorageOptions</code> config for a Domain</p>" 335 } 336 }, 337 "CommitMessage": { 338 "base": null, 339 "refs": { 340 "PackageVersionHistory$CommitMessage": "<p>A message associated with the package version.</p>", 341 "UpdatePackageRequest$CommitMessage": "<p>A commit message for the new version which is shown as part of <code>GetPackageVersionHistoryResponse</code>. </p>" 342 } 343 }, 344 "CompatibleVersionsList": { 345 "base": null, 346 "refs": { 347 "GetCompatibleVersionsResponse$CompatibleVersions": "<p> A map of compatible OpenSearch versions returned as part of the <code> <a>GetCompatibleVersions</a> </code> operation. </p>" 348 } 349 }, 350 "CompatibleVersionsMap": { 351 "base": "<p> A map from an <code> <a>EngineVersion</a> </code> to a list of compatible <code> <a>EngineVersion</a> </code> s to which the domain can be upgraded. </p>", 352 "refs": { 353 "CompatibleVersionsList$member": null 354 } 355 }, 356 "ConflictException": { 357 "base": "<p>An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.</p>", 358 "refs": { 359 } 360 }, 361 "ConnectionAlias": { 362 "base": null, 363 "refs": { 364 "CreateOutboundConnectionRequest$ConnectionAlias": "<p>The connection alias used used by the customer for this cross-cluster connection.</p>", 365 "CreateOutboundConnectionResponse$ConnectionAlias": "<p>The connection alias provided during the create connection request.</p>", 366 "OutboundConnection$ConnectionAlias": "<p>The connection alias for the outbound cross-cluster connection.</p>" 367 } 368 }, 369 "ConnectionId": { 370 "base": null, 371 "refs": { 372 "AcceptInboundConnectionRequest$ConnectionId": "<p>The ID of the inbound connection you want to accept.</p>", 373 "CreateOutboundConnectionResponse$ConnectionId": "<p>The unique ID for the created outbound connection, which is used for subsequent operations on the connection.</p>", 374 "DeleteInboundConnectionRequest$ConnectionId": "<p>The ID of the inbound connection to permanently delete.</p>", 375 "DeleteOutboundConnectionRequest$ConnectionId": "<p>The ID of the outbound connection you want to permanently delete.</p>", 376 "InboundConnection$ConnectionId": "<p>The connection ID for the inbound cross-cluster connection.</p>", 377 "OutboundConnection$ConnectionId": "<p>The connection ID for the outbound cross-cluster connection.</p>", 378 "RejectInboundConnectionRequest$ConnectionId": "<p>The ID of the inbound connection to reject.</p>" 379 } 380 }, 381 "ConnectionStatusMessage": { 382 "base": null, 383 "refs": { 384 "InboundConnectionStatus$Message": "<p>Verbose information for the inbound connection status.</p>", 385 "OutboundConnectionStatus$Message": "<p>Verbose information for the outbound connection status.</p>" 386 } 387 }, 388 "CreateDomainRequest": { 389 "base": null, 390 "refs": { 391 } 392 }, 393 "CreateDomainResponse": { 394 "base": "<p>The result of a <code>CreateDomain</code> operation. Contains the status of the newly created Amazon OpenSearch Service domain. </p>", 395 "refs": { 396 } 397 }, 398 "CreateOutboundConnectionRequest": { 399 "base": "<p>Container for the parameters to the <code> <a>CreateOutboundConnection</a> </code> operation. </p>", 400 "refs": { 401 } 402 }, 403 "CreateOutboundConnectionResponse": { 404 "base": "<p>The result of a <code> <a>CreateOutboundConnection</a> </code> request. Contains the details about the newly created cross-cluster connection. </p>", 405 "refs": { 406 } 407 }, 408 "CreatePackageRequest": { 409 "base": "<p> Container for request parameters to the <code> <a>CreatePackage</a> </code> operation. </p>", 410 "refs": { 411 } 412 }, 413 "CreatePackageResponse": { 414 "base": "<p> Container for the response returned by the <code> <a>CreatePackage</a> </code> operation. </p>", 415 "refs": { 416 } 417 }, 418 "CreatedAt": { 419 "base": null, 420 "refs": { 421 "PackageDetails$CreatedAt": "<p>The timestamp of when the package was created.</p>", 422 "PackageVersionHistory$CreatedAt": "<p>The timestamp of when the package was created.</p>" 423 } 424 }, 425 "DeleteDomainRequest": { 426 "base": "<p>Container for the parameters to the <code> <a>DeleteDomain</a> </code> operation. Specifies the name of the domain you want to delete. </p>", 427 "refs": { 428 } 429 }, 430 "DeleteDomainResponse": { 431 "base": "<p>The result of a <code>DeleteDomain</code> 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. </p>", 432 "refs": { 433 } 434 }, 435 "DeleteInboundConnectionRequest": { 436 "base": "<p>Container for the parameters to the <code> <a>DeleteInboundConnection</a> </code> operation. </p>", 437 "refs": { 438 } 439 }, 440 "DeleteInboundConnectionResponse": { 441 "base": "<p>The result of a <code> <a>DeleteInboundConnection</a> </code> operation. Contains details about the deleted inbound connection. </p>", 442 "refs": { 443 } 444 }, 445 "DeleteOutboundConnectionRequest": { 446 "base": "<p>Container for the parameters to the <code> <a>DeleteOutboundConnection</a> </code> operation. </p>", 447 "refs": { 448 } 449 }, 450 "DeleteOutboundConnectionResponse": { 451 "base": "<p>The result of a <code> <a>DeleteOutboundConnection</a> </code> operation. Contains details about the deleted outbound connection. </p>", 452 "refs": { 453 } 454 }, 455 "DeletePackageRequest": { 456 "base": "<p> Container for the request parameters to the <code> <a>DeletePackage</a> </code> operation. </p>", 457 "refs": { 458 } 459 }, 460 "DeletePackageResponse": { 461 "base": "<p> Container for the response parameters to the <code> <a>DeletePackage</a> </code> operation. </p>", 462 "refs": { 463 } 464 }, 465 "DeploymentCloseDateTimeStamp": { 466 "base": null, 467 "refs": { 468 "ServiceSoftwareOptions$AutomatedUpdateDate": "<p>The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software. </p>" 469 } 470 }, 471 "DeploymentStatus": { 472 "base": null, 473 "refs": { 474 "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>" 475 } 476 }, 477 "DescribeDomainAutoTunesRequest": { 478 "base": "<p>Container for the parameters to the <code>DescribeDomainAutoTunes</code> operation. </p>", 479 "refs": { 480 } 481 }, 482 "DescribeDomainAutoTunesResponse": { 483 "base": "<p>The result of a <code>DescribeDomainAutoTunes</code> request. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>", 484 "refs": { 485 } 486 }, 487 "DescribeDomainConfigRequest": { 488 "base": "<p>Container for the parameters to the <code>DescribeDomainConfig</code> operation. Specifies the domain name for which you want configuration information. </p>", 489 "refs": { 490 } 491 }, 492 "DescribeDomainConfigResponse": { 493 "base": "<p>The result of a <code>DescribeDomainConfig</code> request. Contains the configuration information of the requested domain. </p>", 494 "refs": { 495 } 496 }, 497 "DescribeDomainRequest": { 498 "base": "<p>Container for the parameters to the <code> <a>DescribeDomain</a> </code> operation. </p>", 499 "refs": { 500 } 501 }, 502 "DescribeDomainResponse": { 503 "base": "<p>The result of a <code>DescribeDomain</code> request. Contains the status of the domain specified in the request. </p>", 504 "refs": { 505 } 506 }, 507 "DescribeDomainsRequest": { 508 "base": "<p>Container for the parameters to the <code> <a>DescribeDomains</a> </code> operation. By default, the API returns the status of all domains. </p>", 509 "refs": { 510 } 511 }, 512 "DescribeDomainsResponse": { 513 "base": "<p>The result of a <code>DescribeDomains</code> request. Contains the status of the specified domains or all domains owned by the account. </p>", 514 "refs": { 515 } 516 }, 517 "DescribeInboundConnectionsRequest": { 518 "base": "<p>Container for the parameters to the <code> <a>DescribeInboundConnections</a> </code> operation. </p>", 519 "refs": { 520 } 521 }, 522 "DescribeInboundConnectionsResponse": { 523 "base": "<p>The result of a <code> <a>DescribeInboundConnections</a> </code> request. Contains a list of connections matching the filter criteria. </p>", 524 "refs": { 525 } 526 }, 527 "DescribeInstanceTypeLimitsRequest": { 528 "base": "<p> Container for the parameters to the <code> <a>DescribeInstanceTypeLimits</a> </code> operation. </p>", 529 "refs": { 530 } 531 }, 532 "DescribeInstanceTypeLimitsResponse": { 533 "base": "<p> Container for the parameters received from the <code> <a>DescribeInstanceTypeLimits</a> </code> operation. </p>", 534 "refs": { 535 } 536 }, 537 "DescribeOutboundConnectionsRequest": { 538 "base": "<p>Container for the parameters to the <code> <a>DescribeOutboundConnections</a> </code> operation. </p>", 539 "refs": { 540 } 541 }, 542 "DescribeOutboundConnectionsResponse": { 543 "base": "<p>The result of a <code> <a>DescribeOutboundConnections</a> </code> request. Contains the list of connections matching the filter criteria. </p>", 544 "refs": { 545 } 546 }, 547 "DescribePackagesFilter": { 548 "base": "<p>A filter to apply to the <code>DescribePackage</code> response. </p>", 549 "refs": { 550 "DescribePackagesFilterList$member": null 551 } 552 }, 553 "DescribePackagesFilterList": { 554 "base": "<p>A list of <code>DescribePackagesFilter</code> to filter the packages included in a <code>DescribePackages</code> response. </p>", 555 "refs": { 556 "DescribePackagesRequest$Filters": "<p>Only returns packages that match the <code>DescribePackagesFilterList</code> values. </p>" 557 } 558 }, 559 "DescribePackagesFilterName": { 560 "base": null, 561 "refs": { 562 "DescribePackagesFilter$Name": "<p>Any field from <code>PackageDetails</code>. </p>" 563 } 564 }, 565 "DescribePackagesFilterValue": { 566 "base": null, 567 "refs": { 568 "DescribePackagesFilterValues$member": null 569 } 570 }, 571 "DescribePackagesFilterValues": { 572 "base": null, 573 "refs": { 574 "DescribePackagesFilter$Value": "<p>A list of values for the specified field.</p>" 575 } 576 }, 577 "DescribePackagesRequest": { 578 "base": "<p> Container for the request parameters to the <code> <a>DescribePackage</a> </code> operation. </p>", 579 "refs": { 580 } 581 }, 582 "DescribePackagesResponse": { 583 "base": "<p> Container for the response returned by the <code> <a>DescribePackages</a> </code> operation. </p>", 584 "refs": { 585 } 586 }, 587 "DescribeReservedInstanceOfferingsRequest": { 588 "base": "<p>Container for parameters to <code>DescribeReservedInstanceOfferings</code> </p>", 589 "refs": { 590 } 591 }, 592 "DescribeReservedInstanceOfferingsResponse": { 593 "base": "<p>Container for results from <code>DescribeReservedInstanceOfferings</code> </p>", 594 "refs": { 595 } 596 }, 597 "DescribeReservedInstancesRequest": { 598 "base": "<p>Container for parameters to <code>DescribeReservedInstances</code> </p>", 599 "refs": { 600 } 601 }, 602 "DescribeReservedInstancesResponse": { 603 "base": "<p>Container for results from <code>DescribeReservedInstances</code> </p>", 604 "refs": { 605 } 606 }, 607 "DisabledOperationException": { 608 "base": "<p>An error occured because the client wanted to access a not supported operation. Gives http status code of 409.</p>", 609 "refs": { 610 } 611 }, 612 "DissociatePackageRequest": { 613 "base": "<p> Container for the request parameters to the <code> <a>DissociatePackage</a> </code> operation. </p>", 614 "refs": { 615 } 616 }, 617 "DissociatePackageResponse": { 618 "base": "<p> Container for the response returned by <code> <a>DissociatePackage</a> </code> operation. </p>", 619 "refs": { 620 } 621 }, 622 "DomainConfig": { 623 "base": "<p>The configuration of a domain.</p>", 624 "refs": { 625 "DescribeDomainConfigResponse$DomainConfig": "<p>The configuration information of the domain requested in the <code>DescribeDomainConfig</code> request. </p>", 626 "UpdateDomainConfigResponse$DomainConfig": "<p>The status of the updated domain.</p>" 627 } 628 }, 629 "DomainEndpointOptions": { 630 "base": "<p>Options to configure the endpoint for the domain.</p>", 631 "refs": { 632 "CreateDomainRequest$DomainEndpointOptions": "<p>Options to specify configurations that will be applied to the domain endpoint.</p>", 633 "DomainEndpointOptionsStatus$Options": "<p>Options to configure the endpoint for the domain.</p>", 634 "DomainStatus$DomainEndpointOptions": "<p>The current status of the domain's endpoint options.</p>", 635 "UpdateDomainConfigRequest$DomainEndpointOptions": "<p>Options to specify configuration that will be applied to the domain endpoint.</p>" 636 } 637 }, 638 "DomainEndpointOptionsStatus": { 639 "base": "<p>The configured endpoint options for the domain and their current status.</p>", 640 "refs": { 641 "DomainConfig$DomainEndpointOptions": "<p>The <code>DomainEndpointOptions</code> for the domain. </p>" 642 } 643 }, 644 "DomainId": { 645 "base": "<p>Unique identifier for the domain.</p>", 646 "refs": { 647 "DomainStatus$DomainId": "<p>The unique identifier for the specified domain.</p>" 648 } 649 }, 650 "DomainInfo": { 651 "base": null, 652 "refs": { 653 "DomainInfoList$member": null 654 } 655 }, 656 "DomainInfoList": { 657 "base": "<p>Contains the list of domain information.</p>", 658 "refs": { 659 "ListDomainNamesResponse$DomainNames": "<p>List of domain names and respective engine types.</p>" 660 } 661 }, 662 "DomainInformationContainer": { 663 "base": null, 664 "refs": { 665 "CreateOutboundConnectionRequest$LocalDomainInfo": "<p>The <code> <a>AWSDomainInformation</a> </code> for the local OpenSearch domain. </p>", 666 "CreateOutboundConnectionRequest$RemoteDomainInfo": "<p>The <code> <a>AWSDomainInformation</a> </code> for the remote OpenSearch domain. </p>", 667 "CreateOutboundConnectionResponse$LocalDomainInfo": "<p>The <code> <a>AWSDomainInformation</a> </code> for the local OpenSearch domain. </p>", 668 "CreateOutboundConnectionResponse$RemoteDomainInfo": "<p>The <code> <a>AWSDomainInformation</a> </code> for the remote OpenSearch domain. </p>", 669 "InboundConnection$LocalDomainInfo": "<p>The <code> <a>AWSDomainInformation</a> </code> for the local OpenSearch domain. </p>", 670 "InboundConnection$RemoteDomainInfo": "<p>The <code> <a>AWSDomainInformation</a> </code> for the remote OpenSearch domain. </p>", 671 "OutboundConnection$LocalDomainInfo": "<p>The <code> <a>DomainInformation</a> </code> for the local OpenSearch domain. </p>", 672 "OutboundConnection$RemoteDomainInfo": "<p>The <code> <a>DomainInformation</a> </code> for the remote OpenSearch domain. </p>" 673 } 674 }, 675 "DomainName": { 676 "base": "<p>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). </p>", 677 "refs": { 678 "AWSDomainInformation$DomainName": null, 679 "AssociatePackageRequest$DomainName": "<p>The name of the domain to associate the package with.</p>", 680 "CancelServiceSoftwareUpdateRequest$DomainName": "<p>The name of the domain that you want to stop the latest service software update on.</p>", 681 "CreateDomainRequest$DomainName": "<p>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). </p>", 682 "DeleteDomainRequest$DomainName": "<p>The name of the domain you want to permanently delete.</p>", 683 "DescribeDomainAutoTunesRequest$DomainName": "<p>The domain name for which you want Auto-Tune action details.</p>", 684 "DescribeDomainConfigRequest$DomainName": "<p>The domain you want to get information about.</p>", 685 "DescribeDomainRequest$DomainName": "<p>The name of the domain for which you want information.</p>", 686 "DescribeInstanceTypeLimitsRequest$DomainName": "<p> The name of the domain you want to modify. Only include this value if you're querying OpenSearch <code> <a>Limits</a> </code> for an existing domain. </p>", 687 "DissociatePackageRequest$DomainName": "<p>The name of the domain to associate the package with.</p>", 688 "DomainInfo$DomainName": "<p>The <code>DomainName</code>. </p>", 689 "DomainNameList$member": null, 690 "DomainPackageDetails$DomainName": "<p>The name of the domain you've associated a package with.</p>", 691 "DomainStatus$DomainName": "<p>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). </p>", 692 "GetCompatibleVersionsRequest$DomainName": null, 693 "GetUpgradeHistoryRequest$DomainName": null, 694 "GetUpgradeStatusRequest$DomainName": null, 695 "ListInstanceTypeDetailsRequest$DomainName": null, 696 "ListPackagesForDomainRequest$DomainName": "<p>The name of the domain for which you want to list associated packages.</p>", 697 "StartServiceSoftwareUpdateRequest$DomainName": "<p>The name of the domain that you want to update to the latest service software.</p>", 698 "UpdateDomainConfigRequest$DomainName": "<p>The name of the domain you're updating.</p>", 699 "UpgradeDomainRequest$DomainName": null, 700 "UpgradeDomainResponse$DomainName": null 701 } 702 }, 703 "DomainNameFqdn": { 704 "base": null, 705 "refs": { 706 "DomainEndpointOptions$CustomEndpoint": "<p>The fully qualified domain for your custom endpoint.</p>" 707 } 708 }, 709 "DomainNameList": { 710 "base": "<p>A list of domain names.</p>", 711 "refs": { 712 "DescribeDomainsRequest$DomainNames": "<p>The domains for which you want information.</p>" 713 } 714 }, 715 "DomainPackageDetails": { 716 "base": "<p>Information on a package associated with a domain.</p>", 717 "refs": { 718 "AssociatePackageResponse$DomainPackageDetails": "<p> <code>DomainPackageDetails</code> </p>", 719 "DissociatePackageResponse$DomainPackageDetails": "<p> <code>DomainPackageDetails</code> </p>", 720 "DomainPackageDetailsList$member": null 721 } 722 }, 723 "DomainPackageDetailsList": { 724 "base": null, 725 "refs": { 726 "ListDomainsForPackageResponse$DomainPackageDetailsList": "<p>List of <code>DomainPackageDetails</code> objects. </p>", 727 "ListPackagesForDomainResponse$DomainPackageDetailsList": "<p>List of <code>DomainPackageDetails</code> objects. </p>" 728 } 729 }, 730 "DomainPackageStatus": { 731 "base": null, 732 "refs": { 733 "DomainPackageDetails$DomainPackageStatus": "<p>State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.</p>" 734 } 735 }, 736 "DomainStatus": { 737 "base": "<p>The current status of a domain.</p>", 738 "refs": { 739 "CreateDomainResponse$DomainStatus": "<p>The status of the newly created domain.</p>", 740 "DeleteDomainResponse$DomainStatus": "<p>The status of the domain being deleted.</p>", 741 "DescribeDomainResponse$DomainStatus": "<p>The current status of the domain.</p>", 742 "DomainStatusList$member": null 743 } 744 }, 745 "DomainStatusList": { 746 "base": "<p>A list that contains the status of each requested domain.</p>", 747 "refs": { 748 "DescribeDomainsResponse$DomainStatusList": "<p>The status of the domains requested in the <code>DescribeDomains</code> request. </p>" 749 } 750 }, 751 "Double": { 752 "base": null, 753 "refs": { 754 "RecurringCharge$RecurringChargeAmount": "<p>The monetary amount of the recurring charge.</p>", 755 "ReservedInstance$FixedPrice": "<p>The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.</p>", 756 "ReservedInstance$UsagePrice": "<p>The rate you are charged for each hour for the domain that is using this reserved instance.</p>", 757 "ReservedInstanceOffering$FixedPrice": "<p>The upfront fixed charge you will pay to purchase the specific reserved OpenSearch instance offering.</p>", 758 "ReservedInstanceOffering$UsagePrice": "<p>The rate you are charged for each hour the domain that is using the offering is running.</p>", 759 "UpgradeStepItem$ProgressPercent": "<p>The floating point value representing the progress percentage of a particular step.</p>" 760 } 761 }, 762 "Duration": { 763 "base": "<p>The maintenance schedule duration: duration value and duration unit. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>", 764 "refs": { 765 "AutoTuneMaintenanceSchedule$Duration": "<p>Specifies maintenance schedule duration: duration value and duration unit. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>" 766 } 767 }, 768 "DurationValue": { 769 "base": "<p>Integer to specify the value of a maintenance schedule duration. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>", 770 "refs": { 771 "Duration$Value": "<p>Integer to specify the value of a maintenance schedule duration. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>" 772 } 773 }, 774 "EBSOptions": { 775 "base": "<p>Options to enable, disable, and specify the properties of EBS storage volumes.</p>", 776 "refs": { 777 "CreateDomainRequest$EBSOptions": "<p>Options to enable, disable, and specify the type and size of EBS storage volumes.</p>", 778 "DomainStatus$EBSOptions": "<p>The <code>EBSOptions</code> for the specified domain. </p>", 779 "EBSOptionsStatus$Options": "<p>The EBS options for the specified domain.</p>", 780 "UpdateDomainConfigRequest$EBSOptions": "<p>Specify the type and size of the EBS volume to use.</p>" 781 } 782 }, 783 "EBSOptionsStatus": { 784 "base": "<p>Status of the EBS options for the specified domain.</p>", 785 "refs": { 786 "DomainConfig$EBSOptions": "<p>The <code>EBSOptions</code> for the domain. </p>" 787 } 788 }, 789 "EncryptionAtRestOptions": { 790 "base": "<p>Specifies encryption at rest options.</p>", 791 "refs": { 792 "CreateDomainRequest$EncryptionAtRestOptions": "<p>Options for encryption of data at rest.</p>", 793 "DomainStatus$EncryptionAtRestOptions": "<p>The status of the <code>EncryptionAtRestOptions</code>. </p>", 794 "EncryptionAtRestOptionsStatus$Options": "<p>The Encryption At Rest options for the specified domain.</p>", 795 "UpdateDomainConfigRequest$EncryptionAtRestOptions": "<p>Specifies encryption of data at rest options.</p>" 796 } 797 }, 798 "EncryptionAtRestOptionsStatus": { 799 "base": "<p>Status of the encryption At Rest options for the specified domain.</p>", 800 "refs": { 801 "DomainConfig$EncryptionAtRestOptions": "<p>The <code>EncryptionAtRestOptions</code> for the domain. </p>" 802 } 803 }, 804 "EndpointsMap": { 805 "base": null, 806 "refs": { 807 "DomainStatus$Endpoints": "<p>Map containing the 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>" 808 } 809 }, 810 "EngineType": { 811 "base": null, 812 "refs": { 813 "DomainInfo$EngineType": "<p> Specifies the <code>EngineType</code> of the domain.</p>", 814 "ListDomainNamesRequest$EngineType": "<p> Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'. </p>" 815 } 816 }, 817 "ErrorDetails": { 818 "base": null, 819 "refs": { 820 "DomainPackageDetails$ErrorDetails": "<p>Additional information if the package is in an error state. Null otherwise.</p>", 821 "PackageDetails$ErrorDetails": "<p>Additional information if the package is in an error state. Null otherwise.</p>" 822 } 823 }, 824 "ErrorMessage": { 825 "base": null, 826 "refs": { 827 "BaseException$message": "<p>A description of the error.</p>", 828 "ErrorDetails$ErrorMessage": null 829 } 830 }, 831 "ErrorType": { 832 "base": null, 833 "refs": { 834 "ErrorDetails$ErrorType": null 835 } 836 }, 837 "Filter": { 838 "base": "<p> 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. </p>", 839 "refs": { 840 "FilterList$member": null 841 } 842 }, 843 "FilterList": { 844 "base": null, 845 "refs": { 846 "DescribeInboundConnectionsRequest$Filters": "<p> A list of filters used to match properties for inbound cross-cluster connections. Available <code> <a>Filter</a> </code> values are: <ul> <li>connection-id</li> <li>local-domain-info.domain-name</li> <li>local-domain-info.owner-id</li> <li>local-domain-info.region</li> <li>remote-domain-info.domain-name</li> </ul> </p>", 847 "DescribeOutboundConnectionsRequest$Filters": "<p> A list of filters used to match properties for outbound cross-cluster connections. Available <code> <a>Filter</a> </code> names for this operation are: <ul> <li>connection-id</li> <li>remote-domain-info.domain-name</li> <li>remote-domain-info.owner-id</li> <li>remote-domain-info.region</li> <li>local-domain-info.domain-name</li> </ul> </p>" 848 } 849 }, 850 "GUID": { 851 "base": null, 852 "refs": { 853 "DescribeReservedInstanceOfferingsRequest$ReservedInstanceOfferingId": "<p>The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier. </p>", 854 "DescribeReservedInstancesRequest$ReservedInstanceId": "<p>The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID. </p>", 855 "PurchaseReservedInstanceOfferingRequest$ReservedInstanceOfferingId": "<p>The ID of the reserved OpenSearch instance offering to purchase.</p>", 856 "PurchaseReservedInstanceOfferingResponse$ReservedInstanceId": "<p>Details of the reserved OpenSearch instance which was purchased.</p>", 857 "ReservedInstance$ReservedInstanceId": "<p>The unique identifier for the reservation.</p>", 858 "ReservedInstanceOffering$ReservedInstanceOfferingId": "<p>The OpenSearch reserved instance offering identifier.</p>" 859 } 860 }, 861 "GetCompatibleVersionsRequest": { 862 "base": "<p> Container for the request parameters to <code> <a>GetCompatibleVersions</a> </code> operation. </p>", 863 "refs": { 864 } 865 }, 866 "GetCompatibleVersionsResponse": { 867 "base": "<p> Container for the response returned by the <code> <a>GetCompatibleVersions</a> </code> operation. </p>", 868 "refs": { 869 } 870 }, 871 "GetPackageVersionHistoryRequest": { 872 "base": "<p> Container for the request parameters to the <code> <a>GetPackageVersionHistory</a> </code> operation. </p>", 873 "refs": { 874 } 875 }, 876 "GetPackageVersionHistoryResponse": { 877 "base": "<p> Container for response returned by <code> <a>GetPackageVersionHistory</a> </code> operation. </p>", 878 "refs": { 879 } 880 }, 881 "GetUpgradeHistoryRequest": { 882 "base": "<p> Container for the request parameters to the <code> <a>GetUpgradeHistory</a> </code> operation. </p>", 883 "refs": { 884 } 885 }, 886 "GetUpgradeHistoryResponse": { 887 "base": "<p> Container for the response returned by the <code> <a>GetUpgradeHistory</a> </code> operation. </p>", 888 "refs": { 889 } 890 }, 891 "GetUpgradeStatusRequest": { 892 "base": "<p> Container for the request parameters to the <code> <a>GetUpgradeStatus</a> </code> operation. </p>", 893 "refs": { 894 } 895 }, 896 "GetUpgradeStatusResponse": { 897 "base": "<p> Container for the response returned by the <code> <a>GetUpgradeStatus</a> </code> operation. </p>", 898 "refs": { 899 } 900 }, 901 "IdentityPoolId": { 902 "base": null, 903 "refs": { 904 "CognitoOptions$IdentityPoolId": "<p>The Cognito identity pool ID for OpenSearch Dashboards authentication.</p>" 905 } 906 }, 907 "InboundConnection": { 908 "base": "<p>Details of an inbound connection.</p>", 909 "refs": { 910 "AcceptInboundConnectionResponse$Connection": "<p>The <code> <a>InboundConnection</a> </code> of the accepted inbound connection. </p>", 911 "DeleteInboundConnectionResponse$Connection": "<p>The <code> <a>InboundConnection</a> </code> of the deleted inbound connection. </p>", 912 "InboundConnections$member": null, 913 "RejectInboundConnectionResponse$Connection": "<p>The <code> <a>InboundConnection</a> </code> of the rejected inbound connection. </p>" 914 } 915 }, 916 "InboundConnectionStatus": { 917 "base": "<p>The connection status of an inbound cross-cluster connection.</p>", 918 "refs": { 919 "InboundConnection$ConnectionStatus": "<p>The <code> <a>InboundConnectionStatus</a> </code> for the outbound connection. </p>" 920 } 921 }, 922 "InboundConnectionStatusCode": { 923 "base": null, 924 "refs": { 925 "InboundConnectionStatus$StatusCode": "<p>The state code for the inbound connection. Can be one of the following:</p> <ul> <li>PENDING_ACCEPTANCE: Inbound connection is not yet accepted by the remote domain owner.</li> <li>APPROVED: Inbound connection is pending acceptance by the remote domain owner.</li> <li>PROVISIONING: Inbound connection provisioning is in progress.</li> <li>ACTIVE: Inbound connection is active and ready to use.</li> <li>REJECTING: Inbound connection rejection is in process.</li> <li>REJECTED: Inbound connection is rejected.</li> <li>DELETING: Inbound connection deletion is in progress.</li> <li>DELETED: Inbound connection is deleted and can no longer be used.</li> </ul>" 926 } 927 }, 928 "InboundConnections": { 929 "base": null, 930 "refs": { 931 "DescribeInboundConnectionsResponse$Connections": "<p>A list of <code> <a>InboundConnection</a> </code> matching the specified filter criteria. </p>" 932 } 933 }, 934 "InstanceCount": { 935 "base": "<p>The number of EC2 instances in the domain.</p>", 936 "refs": { 937 "PurchaseReservedInstanceOfferingRequest$InstanceCount": "<p>The number of OpenSearch instances to reserve.</p>" 938 } 939 }, 940 "InstanceCountLimits": { 941 "base": "<p> InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType. </p>", 942 "refs": { 943 "InstanceLimits$InstanceCountLimits": null 944 } 945 }, 946 "InstanceLimits": { 947 "base": "<p>InstanceLimits represents the list of instance-related attributes that are available for a given InstanceType. </p>", 948 "refs": { 949 "Limits$InstanceLimits": null 950 } 951 }, 952 "InstanceRole": { 953 "base": null, 954 "refs": { 955 "InstanceRoleList$member": null, 956 "LimitsByRole$key": null 957 } 958 }, 959 "InstanceRoleList": { 960 "base": null, 961 "refs": { 962 "InstanceTypeDetails$InstanceRole": null 963 } 964 }, 965 "InstanceTypeDetails": { 966 "base": null, 967 "refs": { 968 "InstanceTypeDetailsList$member": null 969 } 970 }, 971 "InstanceTypeDetailsList": { 972 "base": null, 973 "refs": { 974 "ListInstanceTypeDetailsResponse$InstanceTypeDetails": null 975 } 976 }, 977 "Integer": { 978 "base": null, 979 "refs": { 980 "ReservedInstance$Duration": "<p>The duration, in seconds, for which the OpenSearch instance is reserved.</p>", 981 "ReservedInstance$InstanceCount": "<p>The number of OpenSearch instances that have been reserved.</p>", 982 "ReservedInstanceOffering$Duration": "<p>The duration, in seconds, for which the offering will reserve the OpenSearch instance.</p>" 983 } 984 }, 985 "IntegerClass": { 986 "base": null, 987 "refs": { 988 "ClusterConfig$InstanceCount": "<p>The number of instances in the specified domain cluster.</p>", 989 "ClusterConfig$DedicatedMasterCount": "<p>Total number of dedicated master nodes, active and on standby, for the cluster.</p>", 990 "ClusterConfig$WarmCount": "<p>The number of UltraWarm nodes in the cluster.</p>", 991 "EBSOptions$VolumeSize": "<p>Integer to specify the size of an EBS volume.</p>", 992 "EBSOptions$Iops": "<p>The IOPD for a Provisioned IOPS EBS volume (SSD).</p>", 993 "SAMLOptionsInput$SessionTimeoutMinutes": "<p>The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60. </p>", 994 "SAMLOptionsOutput$SessionTimeoutMinutes": "<p>The duration, in minutes, after which a user session becomes inactive.</p>", 995 "SnapshotOptions$AutomatedSnapshotStartHour": "<p>The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is <code>0</code> hours. </p>", 996 "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>" 997 } 998 }, 999 "InternalException": { 1000 "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>", 1001 "refs": { 1002 } 1003 }, 1004 "InvalidPaginationTokenException": { 1005 "base": "<p>The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400. </p>", 1006 "refs": { 1007 } 1008 }, 1009 "InvalidTypeException": { 1010 "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>", 1011 "refs": { 1012 } 1013 }, 1014 "Issue": { 1015 "base": null, 1016 "refs": { 1017 "Issues$member": null 1018 } 1019 }, 1020 "Issues": { 1021 "base": null, 1022 "refs": { 1023 "UpgradeStepItem$Issues": "<p>A list of strings containing detailed information about the errors encountered in a particular step.</p>" 1024 } 1025 }, 1026 "KmsKeyId": { 1027 "base": null, 1028 "refs": { 1029 "EncryptionAtRestOptions$KmsKeyId": "<p>The KMS key ID for encryption at rest options.</p>" 1030 } 1031 }, 1032 "LastUpdated": { 1033 "base": null, 1034 "refs": { 1035 "DomainPackageDetails$LastUpdated": "<p>The timestamp of the most recent update to the package association status.</p>", 1036 "PackageDetails$LastUpdatedAt": null 1037 } 1038 }, 1039 "LimitExceededException": { 1040 "base": "<p>An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.</p>", 1041 "refs": { 1042 } 1043 }, 1044 "LimitName": { 1045 "base": null, 1046 "refs": { 1047 "AdditionalLimit$LimitName": "<p> Additional limit is specific to a given InstanceType and for each of its <code> <a>InstanceRole</a> </code> etc. <br/> Attributes and their details: <br/> <ul> <li>MaximumNumberOfDataNodesSupported</li> This attribute is present on the master node only to specify how much data nodes up to which given <code> <a>ESPartitionInstanceType</a> </code> can support as master node. <li>MaximumNumberOfDataNodesWithoutMasterNode</li> This attribute is present on data node only to specify how much data nodes of given <code> <a>ESPartitionInstanceType</a> </code> up to which you don't need any master nodes to govern them. </ul> </p>", 1048 "StorageTypeLimit$LimitName": "<p> Name of storage limits that are applicable for the given storage type. If <code> <a>StorageType</a> </code> is \"ebs\", the following storage options are applicable: <ol> <li>MinimumVolumeSize</li> Minimum amount of volume size that is applicable for the given storage type. Can be empty if not applicable. <li>MaximumVolumeSize</li> Maximum amount of volume size that is applicable for the given storage type. Can be empty if not applicable. <li>MaximumIops</li> Maximum amount of Iops that is applicable for given the storage type. Can be empty if not applicable. <li>MinimumIops</li> Minimum amount of Iops that is applicable for given the storage type. Can be empty if not applicable. </ol> </p>" 1049 } 1050 }, 1051 "LimitValue": { 1052 "base": null, 1053 "refs": { 1054 "LimitValueList$member": null 1055 } 1056 }, 1057 "LimitValueList": { 1058 "base": null, 1059 "refs": { 1060 "AdditionalLimit$LimitValues": "<p> Value for a given <code> <a>AdditionalLimit$LimitName</a> </code> . </p>", 1061 "StorageTypeLimit$LimitValues": "<p> Values for the <code> <a>StorageTypeLimit$LimitName</a> </code> . </p>" 1062 } 1063 }, 1064 "Limits": { 1065 "base": "<p> Limits for a given InstanceType and for each of its roles. <br/> Limits contains the following: <code> <a>StorageTypes</a> </code>, <code> <a>InstanceLimits</a> </code>, and <code> <a>AdditionalLimits</a> </code> </p>", 1066 "refs": { 1067 "LimitsByRole$value": null 1068 } 1069 }, 1070 "LimitsByRole": { 1071 "base": "<p> The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following: <ul> <li>data: If the given InstanceType is used as a data node</li> <li>master: If the given InstanceType is used as a master node</li> <li>ultra_warm: If the given InstanceType is used as a warm node</li> </ul> </p>", 1072 "refs": { 1073 "DescribeInstanceTypeLimitsResponse$LimitsByRole": null 1074 } 1075 }, 1076 "ListDomainNamesRequest": { 1077 "base": "<p> Container for the parameters to the <code><a>ListDomainNames</a></code> operation.</p>", 1078 "refs": { 1079 } 1080 }, 1081 "ListDomainNamesResponse": { 1082 "base": "<p>The result of a <code>ListDomainNames</code> operation. Contains the names of all domains owned by this account and their respective engine types.</p>", 1083 "refs": { 1084 } 1085 }, 1086 "ListDomainsForPackageRequest": { 1087 "base": "<p> Container for the request parameters to the <code> <a>ListDomainsForPackage</a> </code> operation. </p>", 1088 "refs": { 1089 } 1090 }, 1091 "ListDomainsForPackageResponse": { 1092 "base": "<p> Container for the response parameters to the <code> <a>ListDomainsForPackage</a> </code> operation. </p>", 1093 "refs": { 1094 } 1095 }, 1096 "ListInstanceTypeDetailsRequest": { 1097 "base": null, 1098 "refs": { 1099 } 1100 }, 1101 "ListInstanceTypeDetailsResponse": { 1102 "base": null, 1103 "refs": { 1104 } 1105 }, 1106 "ListPackagesForDomainRequest": { 1107 "base": "<p> Container for the request parameters to the <code> <a>ListPackagesForDomain</a> </code> operation. </p>", 1108 "refs": { 1109 } 1110 }, 1111 "ListPackagesForDomainResponse": { 1112 "base": "<p> Container for the response parameters to the <code> <a>ListPackagesForDomain</a> </code> operation. </p>", 1113 "refs": { 1114 } 1115 }, 1116 "ListTagsRequest": { 1117 "base": "<p>Container for the parameters to the <code> <a>ListTags</a> </code> operation. Specify the <code>ARN</code> of the domain that the tags you want to view are attached to. </p>", 1118 "refs": { 1119 } 1120 }, 1121 "ListTagsResponse": { 1122 "base": "<p>The result of a <code>ListTags</code> operation. Contains tags for all requested domains. </p>", 1123 "refs": { 1124 } 1125 }, 1126 "ListVersionsRequest": { 1127 "base": "<p> Container for the parameters to the <code> <a>ListVersions</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, there are no more results to retrieve. </p> </p>", 1128 "refs": { 1129 } 1130 }, 1131 "ListVersionsResponse": { 1132 "base": "<p> Container for the parameters for response received from the <code> <a>ListVersions</a> </code> operation. </p>", 1133 "refs": { 1134 } 1135 }, 1136 "LogPublishingOption": { 1137 "base": "<p>Log Publishing option that is set for a given domain. <br/>Attributes and their details: <ul> <li>CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to publish logs to.</li> <li>Enabled: Whether the log publishing for a given log type is enabled or not.</li> </ul> </p>", 1138 "refs": { 1139 "LogPublishingOptions$value": null 1140 } 1141 }, 1142 "LogPublishingOptions": { 1143 "base": null, 1144 "refs": { 1145 "CreateDomainRequest$LogPublishingOptions": "<p>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of OpenSearch log. </p>", 1146 "DomainStatus$LogPublishingOptions": "<p>Log publishing options for the given domain.</p>", 1147 "LogPublishingOptionsStatus$Options": "<p>The log publishing options configured for the domain.</p>", 1148 "UpdateDomainConfigRequest$LogPublishingOptions": "<p>Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of OpenSearch log. </p>" 1149 } 1150 }, 1151 "LogPublishingOptionsStatus": { 1152 "base": "<p>The configured log publishing options for the domain and their current status.</p>", 1153 "refs": { 1154 "DomainConfig$LogPublishingOptions": "<p>Log publishing options for the given domain.</p>" 1155 } 1156 }, 1157 "LogType": { 1158 "base": "<p>Type of log file. 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: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting. </li> <li>AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.</li> </ul> </p>", 1159 "refs": { 1160 "LogPublishingOptions$key": null 1161 } 1162 }, 1163 "Long": { 1164 "base": null, 1165 "refs": { 1166 "ReservedInstance$BillingSubscriptionId": null 1167 } 1168 }, 1169 "MasterUserOptions": { 1170 "base": "<p>Credentials for the master user: username and password, ARN, or both.</p>", 1171 "refs": { 1172 "AdvancedSecurityOptionsInput$MasterUserOptions": "<p>Credentials for the master user: username and password, ARN, or both.</p>" 1173 } 1174 }, 1175 "MaxResults": { 1176 "base": "<p> Set this value to limit the number of results returned. </p>", 1177 "refs": { 1178 "DescribeDomainAutoTunesRequest$MaxResults": "<p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>", 1179 "DescribeInboundConnectionsRequest$MaxResults": "<p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>", 1180 "DescribeOutboundConnectionsRequest$MaxResults": "<p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>", 1181 "DescribePackagesRequest$MaxResults": "<p>Limits results to a maximum number of packages.</p>", 1182 "DescribeReservedInstanceOfferingsRequest$MaxResults": "<p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>", 1183 "DescribeReservedInstancesRequest$MaxResults": "<p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>", 1184 "GetPackageVersionHistoryRequest$MaxResults": "<p>Limits results to a maximum number of package versions.</p>", 1185 "GetUpgradeHistoryRequest$MaxResults": null, 1186 "ListDomainsForPackageRequest$MaxResults": "<p>Limits the results to a maximum number of domains.</p>", 1187 "ListInstanceTypeDetailsRequest$MaxResults": null, 1188 "ListPackagesForDomainRequest$MaxResults": "<p>Limits results to a maximum number of packages.</p>", 1189 "ListVersionsRequest$MaxResults": "<p> Set this value to limit the number of results returned. Value must be greater than 10 or it won't be honored. </p>" 1190 } 1191 }, 1192 "MaximumInstanceCount": { 1193 "base": "<p> Maximum number of instances that can be instantiated for a given InstanceType. </p>", 1194 "refs": { 1195 "InstanceCountLimits$MaximumInstanceCount": null 1196 } 1197 }, 1198 "MinimumInstanceCount": { 1199 "base": "<p> Minimum number of instances that can be instantiated for a given InstanceType. </p>", 1200 "refs": { 1201 "InstanceCountLimits$MinimumInstanceCount": null 1202 } 1203 }, 1204 "NextToken": { 1205 "base": "<p> 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. </p>", 1206 "refs": { 1207 "DescribeDomainAutoTunesRequest$NextToken": "<p>NextToken is sent in case the earlier API call results contain the NextToken. Used for pagination.</p>", 1208 "DescribeDomainAutoTunesResponse$NextToken": "<p>An identifier to allow retrieval of paginated results.</p>", 1209 "DescribeInboundConnectionsRequest$NextToken": "<p>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.</p>", 1210 "DescribeInboundConnectionsResponse$NextToken": "<p>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. </p>", 1211 "DescribeOutboundConnectionsRequest$NextToken": "<p>NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.</p>", 1212 "DescribeOutboundConnectionsResponse$NextToken": "<p>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. </p>", 1213 "DescribePackagesRequest$NextToken": "<p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page. </p>", 1214 "DescribeReservedInstanceOfferingsRequest$NextToken": "<p>Provides an identifier to allow retrieval of paginated results. </p>", 1215 "DescribeReservedInstanceOfferingsResponse$NextToken": "<p>Provides an identifier to allow retrieval of paginated results.</p>", 1216 "DescribeReservedInstancesRequest$NextToken": "<p>Provides an identifier to allow retrieval of paginated results. </p>", 1217 "GetPackageVersionHistoryRequest$NextToken": "<p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page. </p>", 1218 "GetUpgradeHistoryRequest$NextToken": null, 1219 "ListDomainsForPackageRequest$NextToken": "<p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page. </p>", 1220 "ListInstanceTypeDetailsRequest$NextToken": null, 1221 "ListInstanceTypeDetailsResponse$NextToken": null, 1222 "ListPackagesForDomainRequest$NextToken": "<p>Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page. </p>", 1223 "ListVersionsRequest$NextToken": null, 1224 "ListVersionsResponse$NextToken": null 1225 } 1226 }, 1227 "NodeToNodeEncryptionOptions": { 1228 "base": "<p>The node-to-node encryption options.</p>", 1229 "refs": { 1230 "CreateDomainRequest$NodeToNodeEncryptionOptions": "<p>Node-to-node encryption options.</p>", 1231 "DomainStatus$NodeToNodeEncryptionOptions": "<p>The status of the <code>NodeToNodeEncryptionOptions</code>. </p>", 1232 "NodeToNodeEncryptionOptionsStatus$Options": "<p>The node-to-node encryption options for the specified domain.</p>", 1233 "UpdateDomainConfigRequest$NodeToNodeEncryptionOptions": "<p>Specifies node-to-node encryption options.</p>" 1234 } 1235 }, 1236 "NodeToNodeEncryptionOptionsStatus": { 1237 "base": "<p>Status of the node-to-node encryption options for the specified domain.</p>", 1238 "refs": { 1239 "DomainConfig$NodeToNodeEncryptionOptions": "<p>The <code>NodeToNodeEncryptionOptions</code> for the domain. </p>" 1240 } 1241 }, 1242 "NonEmptyString": { 1243 "base": null, 1244 "refs": { 1245 "Filter$Name": "<p> The name of the filter. </p>", 1246 "ValueStringList$member": null 1247 } 1248 }, 1249 "OpenSearchPartitionInstanceType": { 1250 "base": null, 1251 "refs": { 1252 "ClusterConfig$InstanceType": "<p>The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances. </p>", 1253 "ClusterConfig$DedicatedMasterType": "<p>The instance type for a dedicated master node.</p>", 1254 "DescribeInstanceTypeLimitsRequest$InstanceType": "<p> The instance type for an OpenSearch cluster for which OpenSearch <code> <a>Limits</a> </code> are needed. </p>", 1255 "InstanceTypeDetails$InstanceType": null, 1256 "ReservedInstance$InstanceType": "<p>The OpenSearch instance type offered by the reserved instance offering.</p>", 1257 "ReservedInstanceOffering$InstanceType": "<p>The OpenSearch instance type offered by the reserved instance offering.</p>" 1258 } 1259 }, 1260 "OpenSearchWarmPartitionInstanceType": { 1261 "base": null, 1262 "refs": { 1263 "ClusterConfig$WarmType": "<p>The instance type for the OpenSearch cluster's warm nodes.</p>" 1264 } 1265 }, 1266 "OptionState": { 1267 "base": "<p>The state of a requested change. One of the following:</p> <ul> <li>Processing: The request change is still in progress.</li> <li>Active: The request change is processed and deployed to the domain.</li> </ul>", 1268 "refs": { 1269 "OptionStatus$State": "<p>Provides the <code>OptionState</code> for the domain. </p>" 1270 } 1271 }, 1272 "OptionStatus": { 1273 "base": "<p>Provides the current status of the entity.</p>", 1274 "refs": { 1275 "AccessPoliciesStatus$Status": "<p>The status of the access policy for the domain. See <code>OptionStatus</code> for the status information that's included. </p>", 1276 "AdvancedOptionsStatus$Status": "<p>The <code>OptionStatus</code> for advanced options for the specified domain. </p>", 1277 "AdvancedSecurityOptionsStatus$Status": "<p>Status of the advanced security options for the specified domain.</p>", 1278 "ClusterConfigStatus$Status": "<p>The cluster configuration status for the specified domain.</p>", 1279 "CognitoOptionsStatus$Status": "<p>The status of the Cognito options for the specified domain.</p>", 1280 "DomainEndpointOptionsStatus$Status": "<p>The status of the endpoint options for the domain. See <code>OptionStatus</code> for the status information that's included. </p>", 1281 "EBSOptionsStatus$Status": "<p>The status of the EBS options for the specified domain.</p>", 1282 "EncryptionAtRestOptionsStatus$Status": "<p>The status of the Encryption At Rest options for the specified domain.</p>", 1283 "LogPublishingOptionsStatus$Status": "<p>The status of the log publishing options for the domain. See <code>OptionStatus</code> for the status information that's included. </p>", 1284 "NodeToNodeEncryptionOptionsStatus$Status": "<p>The status of the node-to-node encryption options for the specified domain.</p>", 1285 "SnapshotOptionsStatus$Status": "<p>The status of a daily automated snapshot.</p>", 1286 "VPCDerivedInfoStatus$Status": "<p>The status of the VPC options for the specified domain.</p>", 1287 "VersionStatus$Status": "<p>The status of the OpenSearch version options for the specified OpenSearch domain.</p>" 1288 } 1289 }, 1290 "OutboundConnection": { 1291 "base": "<p>Specifies details about an outbound connection.</p>", 1292 "refs": { 1293 "DeleteOutboundConnectionResponse$Connection": "<p>The <code> <a>OutboundConnection</a> </code> of the deleted outbound connection. </p>", 1294 "OutboundConnections$member": null 1295 } 1296 }, 1297 "OutboundConnectionStatus": { 1298 "base": "<p>The connection status of an outbound cross-cluster connection.</p>", 1299 "refs": { 1300 "CreateOutboundConnectionResponse$ConnectionStatus": "<p>The <code> <a>OutboundConnectionStatus</a> </code> for the newly created connection. </p>", 1301 "OutboundConnection$ConnectionStatus": "<p>The <code> <a>OutboundConnectionStatus</a> </code> for the outbound connection. </p>" 1302 } 1303 }, 1304 "OutboundConnectionStatusCode": { 1305 "base": null, 1306 "refs": { 1307 "OutboundConnectionStatus$StatusCode": "<p>The state code for the outbound connection. Can be one of the following:</p> <ul> <li>VALIDATING: The outbound connection request is being validated.</li> <li>VALIDATION_FAILED: Validation failed for the connection request.</li> <li>PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner. </li> <li>APPROVED: Outbound connection has been approved by the remote domain owner for getting provisioned.</li> <li>PROVISIONING: Outbound connection request is in process.</li> <li>ACTIVE: Outbound connection is active and ready to use.</li> <li>REJECTING: Outbound connection rejection by remote domain owner is in progress.</li> <li>REJECTED: Outbound connection request is rejected by remote domain owner.</li> <li>DELETING: Outbound connection deletion is in progress.</li> <li>DELETED: Outbound connection is deleted and can no longer be used.</li> </ul>" 1308 } 1309 }, 1310 "OutboundConnections": { 1311 "base": null, 1312 "refs": { 1313 "DescribeOutboundConnectionsResponse$Connections": "<p>A list of <code> <a>OutboundConnection</a> </code> matching the specified filter criteria. </p>" 1314 } 1315 }, 1316 "OwnerId": { 1317 "base": null, 1318 "refs": { 1319 "AWSDomainInformation$OwnerId": null 1320 } 1321 }, 1322 "PackageDescription": { 1323 "base": null, 1324 "refs": { 1325 "CreatePackageRequest$PackageDescription": "<p>Description of the package.</p>", 1326 "PackageDetails$PackageDescription": "<p>User-specified description of the package.</p>", 1327 "UpdatePackageRequest$PackageDescription": "<p>A new description of the package.</p>" 1328 } 1329 }, 1330 "PackageDetails": { 1331 "base": "<p>Basic information about a package.</p>", 1332 "refs": { 1333 "CreatePackageResponse$PackageDetails": "<p>Information about the package. </p>", 1334 "DeletePackageResponse$PackageDetails": "<p> <code>PackageDetails</code> </p>", 1335 "PackageDetailsList$member": null, 1336 "UpdatePackageResponse$PackageDetails": "<p>Information about the package. </p>" 1337 } 1338 }, 1339 "PackageDetailsList": { 1340 "base": null, 1341 "refs": { 1342 "DescribePackagesResponse$PackageDetailsList": "<p>List of <code>PackageDetails</code> objects. </p>" 1343 } 1344 }, 1345 "PackageID": { 1346 "base": null, 1347 "refs": { 1348 "AssociatePackageRequest$PackageID": "<p>Internal ID of the package to associate with a domain. Use <code>DescribePackages</code> to find this value. </p>", 1349 "DeletePackageRequest$PackageID": "<p>The internal ID of the package you want to delete. Use <code>DescribePackages</code> to find this value. </p>", 1350 "DissociatePackageRequest$PackageID": "<p>The internal ID of the package to associate with a domain. Use <code>DescribePackages</code> to find this value. </p>", 1351 "DomainPackageDetails$PackageID": "<p>The internal ID of the package.</p>", 1352 "GetPackageVersionHistoryRequest$PackageID": "<p>Returns an audit history of package versions.</p>", 1353 "GetPackageVersionHistoryResponse$PackageID": null, 1354 "ListDomainsForPackageRequest$PackageID": "<p>The package for which to list associated domains.</p>", 1355 "PackageDetails$PackageID": "<p>Internal ID of the package.</p>", 1356 "UpdatePackageRequest$PackageID": "<p>The unique identifier for the package.</p>" 1357 } 1358 }, 1359 "PackageName": { 1360 "base": null, 1361 "refs": { 1362 "CreatePackageRequest$PackageName": "<p>Unique identifier for the package.</p>", 1363 "DomainPackageDetails$PackageName": "<p>User-specified name of the package.</p>", 1364 "PackageDetails$PackageName": "<p>User-specified name of the package.</p>" 1365 } 1366 }, 1367 "PackageSource": { 1368 "base": "<p>The Amazon S3 location for importing the package specified as <code>S3BucketName</code> and <code>S3Key</code> </p>", 1369 "refs": { 1370 "CreatePackageRequest$PackageSource": "<p>The Amazon S3 location from which to import the package. </p>", 1371 "UpdatePackageRequest$PackageSource": null 1372 } 1373 }, 1374 "PackageStatus": { 1375 "base": null, 1376 "refs": { 1377 "PackageDetails$PackageStatus": "<p>Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.</p>" 1378 } 1379 }, 1380 "PackageType": { 1381 "base": null, 1382 "refs": { 1383 "CreatePackageRequest$PackageType": "<p>Type of package. Currently supports only TXT-DICTIONARY.</p>", 1384 "DomainPackageDetails$PackageType": "<p>Currently supports only TXT-DICTIONARY.</p>", 1385 "PackageDetails$PackageType": "<p>Currently supports only TXT-DICTIONARY.</p>" 1386 } 1387 }, 1388 "PackageVersion": { 1389 "base": null, 1390 "refs": { 1391 "DomainPackageDetails$PackageVersion": null, 1392 "PackageDetails$AvailablePackageVersion": null, 1393 "PackageVersionHistory$PackageVersion": "<p>The package version.</p>" 1394 } 1395 }, 1396 "PackageVersionHistory": { 1397 "base": "<p>Details of a package version.</p>", 1398 "refs": { 1399 "PackageVersionHistoryList$member": null 1400 } 1401 }, 1402 "PackageVersionHistoryList": { 1403 "base": null, 1404 "refs": { 1405 "GetPackageVersionHistoryResponse$PackageVersionHistoryList": "<p>List of <code>PackageVersionHistory</code> objects. </p>" 1406 } 1407 }, 1408 "Password": { 1409 "base": null, 1410 "refs": { 1411 "MasterUserOptions$MasterUserPassword": "<p>The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.</p>" 1412 } 1413 }, 1414 "PolicyDocument": { 1415 "base": "<p>Access policy rules for a domain service endpoints. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-access-policies\" target=\"_blank\">Configuring access policies </a>. The maximum size of a policy document is 100 KB. </p>", 1416 "refs": { 1417 "AccessPoliciesStatus$Options": "<p>The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-access-policies\" target=\"_blank\"> Configuring access policies</a>for more information. </p>", 1418 "CreateDomainRequest$AccessPolicies": "<p>IAM access policy as a JSON-formatted string.</p>", 1419 "DomainStatus$AccessPolicies": "<p>IAM access policy as a JSON-formatted string.</p>", 1420 "UpdateDomainConfigRequest$AccessPolicies": "<p>IAM access policy as a JSON-formatted string.</p>" 1421 } 1422 }, 1423 "PurchaseReservedInstanceOfferingRequest": { 1424 "base": "<p>Container for parameters to <code>PurchaseReservedInstanceOffering</code> </p>", 1425 "refs": { 1426 } 1427 }, 1428 "PurchaseReservedInstanceOfferingResponse": { 1429 "base": "<p>Represents the output of a <code>PurchaseReservedInstanceOffering</code> operation. </p>", 1430 "refs": { 1431 } 1432 }, 1433 "RecurringCharge": { 1434 "base": "<p>Contains the specific price and frequency of a recurring charges for a reserved OpenSearch instance, or for a reserved OpenSearch instance offering. </p>", 1435 "refs": { 1436 "RecurringChargeList$member": null 1437 } 1438 }, 1439 "RecurringChargeList": { 1440 "base": null, 1441 "refs": { 1442 "ReservedInstance$RecurringCharges": "<p>The charge to your account regardless of whether you are creating any domains using the instance offering.</p>", 1443 "ReservedInstanceOffering$RecurringCharges": "<p>The charge to your account regardless of whether you are creating any domains using the instance offering.</p>" 1444 } 1445 }, 1446 "ReferencePath": { 1447 "base": null, 1448 "refs": { 1449 "DomainPackageDetails$ReferencePath": "<p>The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.</p>" 1450 } 1451 }, 1452 "Region": { 1453 "base": null, 1454 "refs": { 1455 "AWSDomainInformation$Region": null 1456 } 1457 }, 1458 "RejectInboundConnectionRequest": { 1459 "base": "<p>Container for the parameters to the <code> <a>RejectInboundConnection</a> </code> operation. </p>", 1460 "refs": { 1461 } 1462 }, 1463 "RejectInboundConnectionResponse": { 1464 "base": "<p>The result of a <code> <a>RejectInboundConnection</a> </code> operation. Contains details about the rejected inbound connection. </p>", 1465 "refs": { 1466 } 1467 }, 1468 "RemoveTagsRequest": { 1469 "base": "<p>Container for the parameters to the <code> <a>RemoveTags</a> </code> operation. Specify the <code>ARN</code> for the domain from which you want to remove the specified <code>TagKey</code>. </p>", 1470 "refs": { 1471 } 1472 }, 1473 "ReservationToken": { 1474 "base": null, 1475 "refs": { 1476 "PurchaseReservedInstanceOfferingRequest$ReservationName": "<p>A customer-specified identifier to track this reservation.</p>", 1477 "PurchaseReservedInstanceOfferingResponse$ReservationName": "<p>The customer-specified identifier used to track this reservation.</p>", 1478 "ReservedInstance$ReservationName": "<p>The customer-specified identifier to track this reservation.</p>" 1479 } 1480 }, 1481 "ReservedInstance": { 1482 "base": "<p>Details of a reserved OpenSearch instance.</p>", 1483 "refs": { 1484 "ReservedInstanceList$member": null 1485 } 1486 }, 1487 "ReservedInstanceList": { 1488 "base": null, 1489 "refs": { 1490 "DescribeReservedInstancesResponse$ReservedInstances": "<p>List of reserved OpenSearch instances.</p>" 1491 } 1492 }, 1493 "ReservedInstanceOffering": { 1494 "base": "<p>Details of a reserved OpenSearch instance offering.</p>", 1495 "refs": { 1496 "ReservedInstanceOfferingList$member": null 1497 } 1498 }, 1499 "ReservedInstanceOfferingList": { 1500 "base": null, 1501 "refs": { 1502 "DescribeReservedInstanceOfferingsResponse$ReservedInstanceOfferings": "<p>List of reserved OpenSearch instance offerings</p>" 1503 } 1504 }, 1505 "ReservedInstancePaymentOption": { 1506 "base": null, 1507 "refs": { 1508 "ReservedInstance$PaymentOption": "<p>The payment option as defined in the reserved OpenSearch instance offering.</p>", 1509 "ReservedInstanceOffering$PaymentOption": "<p>Payment option for the reserved OpenSearch instance offering</p>" 1510 } 1511 }, 1512 "ResourceAlreadyExistsException": { 1513 "base": "<p>An exception for creating a resource that already exists. Gives http status code of 400.</p>", 1514 "refs": { 1515 } 1516 }, 1517 "ResourceNotFoundException": { 1518 "base": "<p>An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.</p>", 1519 "refs": { 1520 } 1521 }, 1522 "RoleArn": { 1523 "base": null, 1524 "refs": { 1525 "CognitoOptions$RoleArn": "<p>The role ARN that provides OpenSearch permissions for accessing Cognito resources.</p>" 1526 } 1527 }, 1528 "RollbackOnDisable": { 1529 "base": "<p>The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK. </p>", 1530 "refs": { 1531 "AutoTuneOptions$RollbackOnDisable": "<p>The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK. </p>" 1532 } 1533 }, 1534 "S3BucketName": { 1535 "base": null, 1536 "refs": { 1537 "PackageSource$S3BucketName": "<p>The name of the Amazon S3 bucket containing the package.</p>" 1538 } 1539 }, 1540 "S3Key": { 1541 "base": null, 1542 "refs": { 1543 "PackageSource$S3Key": "<p>Key (file name) of the package.</p>" 1544 } 1545 }, 1546 "SAMLEntityId": { 1547 "base": null, 1548 "refs": { 1549 "SAMLIdp$EntityId": "<p>The unique entity ID of the application in SAML identity provider.</p>" 1550 } 1551 }, 1552 "SAMLIdp": { 1553 "base": "<p>The SAML identity povider's information.</p>", 1554 "refs": { 1555 "SAMLOptionsInput$Idp": "<p>The SAML Identity Provider's information.</p>", 1556 "SAMLOptionsOutput$Idp": "<p>Describes the SAML identity provider's information.</p>" 1557 } 1558 }, 1559 "SAMLMetadata": { 1560 "base": null, 1561 "refs": { 1562 "SAMLIdp$MetadataContent": "<p>The metadata of the SAML application in XML format.</p>" 1563 } 1564 }, 1565 "SAMLOptionsInput": { 1566 "base": "<p>The SAML application configuration for the domain.</p>", 1567 "refs": { 1568 "AdvancedSecurityOptionsInput$SAMLOptions": "<p>The SAML application configuration for the domain.</p>" 1569 } 1570 }, 1571 "SAMLOptionsOutput": { 1572 "base": "<p>Describes the SAML application configured for the domain.</p>", 1573 "refs": { 1574 "AdvancedSecurityOptions$SAMLOptions": "<p>Describes the SAML application configured for a domain.</p>" 1575 } 1576 }, 1577 "ScheduledAutoTuneActionType": { 1578 "base": "<p>The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING, and JVM_YOUNG_GEN_TUNING.</p>", 1579 "refs": { 1580 "ScheduledAutoTuneDetails$ActionType": "<p>The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.</p>" 1581 } 1582 }, 1583 "ScheduledAutoTuneDescription": { 1584 "base": "<p>The Auto-Tune action description.</p>", 1585 "refs": { 1586 "ScheduledAutoTuneDetails$Action": "<p>The Auto-Tune action description.</p>" 1587 } 1588 }, 1589 "ScheduledAutoTuneDetails": { 1590 "base": "<p>Specifies details about the scheduled Auto-Tune action. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>", 1591 "refs": { 1592 "AutoTuneDetails$ScheduledAutoTuneDetails": null 1593 } 1594 }, 1595 "ScheduledAutoTuneSeverityType": { 1596 "base": "<p>The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.</p>", 1597 "refs": { 1598 "ScheduledAutoTuneDetails$Severity": "<p>The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.</p>" 1599 } 1600 }, 1601 "ServiceSoftwareOptions": { 1602 "base": "<p>The current options of an domain service software options.</p>", 1603 "refs": { 1604 "CancelServiceSoftwareUpdateResponse$ServiceSoftwareOptions": "<p>The current status of the OpenSearch service software update.</p>", 1605 "DomainStatus$ServiceSoftwareOptions": "<p>The current status of the domain's service software.</p>", 1606 "StartServiceSoftwareUpdateResponse$ServiceSoftwareOptions": "<p>The current status of the OpenSearch service software update.</p>" 1607 } 1608 }, 1609 "ServiceUrl": { 1610 "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>", 1611 "refs": { 1612 "DomainStatus$Endpoint": "<p>The domain endpoint that you use to submit index and search requests.</p>", 1613 "EndpointsMap$value": null 1614 } 1615 }, 1616 "SnapshotOptions": { 1617 "base": "<p>The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is <code>0</code> hours. </p>", 1618 "refs": { 1619 "CreateDomainRequest$SnapshotOptions": "<p>Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.</p>", 1620 "DomainStatus$SnapshotOptions": "<p>The status of the <code>SnapshotOptions</code>. </p>", 1621 "SnapshotOptionsStatus$Options": "<p>The daily snapshot options specified for the domain.</p>", 1622 "UpdateDomainConfigRequest$SnapshotOptions": "<p>Option to set the time, in UTC format, for the daily automated snapshot. Default value is <code>0</code> hours. </p>" 1623 } 1624 }, 1625 "SnapshotOptionsStatus": { 1626 "base": "<p>Status of a daily automated snapshot.</p>", 1627 "refs": { 1628 "DomainConfig$SnapshotOptions": "<p>The <code>SnapshotOptions</code> for the domain. </p>" 1629 } 1630 }, 1631 "StartAt": { 1632 "base": null, 1633 "refs": { 1634 "AutoTuneMaintenanceSchedule$StartAt": "<p>The timestamp at which the Auto-Tune maintenance schedule starts.</p>" 1635 } 1636 }, 1637 "StartServiceSoftwareUpdateRequest": { 1638 "base": "<p>Container for the parameters to the <code> <a>StartServiceSoftwareUpdate</a> </code> operation. Specifies the name of the domain to schedule a service software update for. </p>", 1639 "refs": { 1640 } 1641 }, 1642 "StartServiceSoftwareUpdateResponse": { 1643 "base": "<p>The result of a <code>StartServiceSoftwareUpdate</code> operation. Contains the status of the update. </p>", 1644 "refs": { 1645 } 1646 }, 1647 "StartTimestamp": { 1648 "base": null, 1649 "refs": { 1650 "UpgradeHistory$StartTimestamp": "<p>UTC timestamp at which the upgrade API call was made in \"yyyy-MM-ddTHH:mm:ssZ\" format.</p>" 1651 } 1652 }, 1653 "StorageSubTypeName": { 1654 "base": "<p> 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: <ol> <li>standard</li> <li>gp2</li> <li>io1</li> </ol> See <code> <a>VolumeType</a> </code> for more information regarding each EBS storage option. </p>", 1655 "refs": { 1656 "StorageType$StorageSubTypeName": null 1657 } 1658 }, 1659 "StorageType": { 1660 "base": "<p>StorageTypes represents the list of storage-related types and their attributes that are available for a given InstanceType. </p>", 1661 "refs": { 1662 "StorageTypeList$member": null 1663 } 1664 }, 1665 "StorageTypeLimit": { 1666 "base": "<p>Limits that are applicable for the given storage type. </p>", 1667 "refs": { 1668 "StorageTypeLimitList$member": null 1669 } 1670 }, 1671 "StorageTypeLimitList": { 1672 "base": null, 1673 "refs": { 1674 "StorageType$StorageTypeLimits": "<p>Limits that are applicable for the given storage type. </p>" 1675 } 1676 }, 1677 "StorageTypeList": { 1678 "base": null, 1679 "refs": { 1680 "Limits$StorageTypes": "<p>Storage-related types and attributes that are available for a given InstanceType. </p>" 1681 } 1682 }, 1683 "StorageTypeName": { 1684 "base": "<p> Type of storage. List of available storage options: <ol> <li>instance</li> Built-in storage available for the instance <li>ebs</li> Elastic block storage attached to the instance </ol> </p>", 1685 "refs": { 1686 "StorageType$StorageTypeName": null 1687 } 1688 }, 1689 "String": { 1690 "base": null, 1691 "refs": { 1692 "AdvancedOptions$key": null, 1693 "AdvancedOptions$value": null, 1694 "AutoTuneMaintenanceSchedule$CronExpressionForRecurrence": "<p>A cron expression for a recurring maintenance schedule. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>", 1695 "AutoTuneOptionsOutput$ErrorMessage": "<p>The error message while enabling or disabling Auto-Tune.</p>", 1696 "AutoTuneStatus$ErrorMessage": "<p>The error message while enabling or disabling Auto-Tune.</p>", 1697 "DescribePackagesResponse$NextToken": null, 1698 "DescribeReservedInstancesResponse$NextToken": "<p>Provides an identifier to allow retrieval of paginated results.</p>", 1699 "EndpointsMap$key": null, 1700 "GetPackageVersionHistoryResponse$NextToken": null, 1701 "GetUpgradeHistoryResponse$NextToken": "<p>Pagination token that needs to be supplied to the next call to get the next page of results.</p>", 1702 "ListDomainsForPackageResponse$NextToken": null, 1703 "ListPackagesForDomainResponse$NextToken": "<p>Pagination token to supply to the next call to get the next page of results.</p>", 1704 "RecurringCharge$RecurringChargeFrequency": "<p>The frequency of the recurring charge.</p>", 1705 "ReservedInstance$ReservedInstanceOfferingId": "<p>The offering identifier.</p>", 1706 "ReservedInstance$CurrencyCode": "<p>The currency code for the reserved OpenSearch instance offering.</p>", 1707 "ReservedInstance$State": "<p>The state of the reserved OpenSearch instance.</p>", 1708 "ReservedInstanceOffering$CurrencyCode": "<p>The currency code for the reserved OpenSearch instance offering.</p>", 1709 "SAMLOptionsInput$SubjectKey": "<p>Element of the SAML assertion to use for username. Default is NameID.</p>", 1710 "SAMLOptionsInput$RolesKey": "<p>Element of the SAML assertion to use for backend roles. Default is roles.</p>", 1711 "SAMLOptionsOutput$SubjectKey": "<p>The key used for matching the SAML subject attribute.</p>", 1712 "SAMLOptionsOutput$RolesKey": "<p>The key used for matching the SAML roles attribute.</p>", 1713 "ServiceSoftwareOptions$CurrentVersion": "<p>The current service software version present on the domain.</p>", 1714 "ServiceSoftwareOptions$NewVersion": "<p>The new service software version if one is available.</p>", 1715 "ServiceSoftwareOptions$Description": "<p>The description of the <code>UpdateStatus</code>. </p>", 1716 "StringList$member": null, 1717 "UpgradeDomainResponse$UpgradeId": null, 1718 "VPCDerivedInfo$VPCId": "<p>The VPC ID for the domain. Exists only if the domain was created with <code>VPCOptions</code>.</p>" 1719 } 1720 }, 1721 "StringList": { 1722 "base": null, 1723 "refs": { 1724 "RemoveTagsRequest$TagKeys": "<p>The <code>TagKey</code> list you want to remove from the domain. </p>", 1725 "VPCDerivedInfo$SubnetIds": "<p>The subnets for the VPC endpoint.</p>", 1726 "VPCDerivedInfo$AvailabilityZones": "<p>The Availability Zones for the domain. Exists only if the domain was created with <code>VPCOptions</code>.</p>", 1727 "VPCDerivedInfo$SecurityGroupIds": "<p>The security groups for the VPC endpoint.</p>", 1728 "VPCOptions$SubnetIds": "<p>The subnets for the VPC endpoint.</p>", 1729 "VPCOptions$SecurityGroupIds": "<p>The security groups for the VPC endpoint.</p>" 1730 } 1731 }, 1732 "TLSSecurityPolicy": { 1733 "base": null, 1734 "refs": { 1735 "DomainEndpointOptions$TLSSecurityPolicy": "<p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. <br/> 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>" 1736 } 1737 }, 1738 "Tag": { 1739 "base": "<p>A key value pair for a resource tag.</p>", 1740 "refs": { 1741 "TagList$member": null 1742 } 1743 }, 1744 "TagKey": { 1745 "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 domain to which they're attached. </p>", 1746 "refs": { 1747 "Tag$Key": "<p>The <code>TagKey</code>, the name of the tag. Tag keys must be unique for the domain to which they are attached. </p>" 1748 } 1749 }, 1750 "TagList": { 1751 "base": "<p>A list of <code>Tag</code>. </p>", 1752 "refs": { 1753 "AddTagsRequest$TagList": "<p>List of <code>Tag</code> to add to the domain. </p>", 1754 "CreateDomainRequest$TagList": "<p>A list of <code>Tag</code> added during domain creation. </p>", 1755 "ListTagsResponse$TagList": "<p>List of <code>Tag</code> for the requested domain. </p>" 1756 } 1757 }, 1758 "TagValue": { 1759 "base": "<p>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. </p>", 1760 "refs": { 1761 "Tag$Value": "<p>The <code>TagValue</code>, 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 <code>project : Trinity</code> and <code>cost-center : Trinity</code> </p>" 1762 } 1763 }, 1764 "TimeUnit": { 1765 "base": "<p>The unit of a maintenance schedule duration. Valid value is HOUR. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>", 1766 "refs": { 1767 "Duration$Unit": "<p>The unit of a maintenance schedule duration. Valid value is HOURS. See <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\"> Auto-Tune for Amazon OpenSearch Service </a> for more information. </p>" 1768 } 1769 }, 1770 "UIntValue": { 1771 "base": null, 1772 "refs": { 1773 "AutoTuneStatus$UpdateVersion": "<p>The latest version of the Auto-Tune options.</p>", 1774 "OptionStatus$UpdateVersion": "<p>The latest version of the entity.</p>" 1775 } 1776 }, 1777 "UpdateDomainConfigRequest": { 1778 "base": "<p>Container for the parameters to the <code> <a>UpdateDomain</a> </code> operation. Specifies the type and number of instances in the domain cluster. </p>", 1779 "refs": { 1780 } 1781 }, 1782 "UpdateDomainConfigResponse": { 1783 "base": "<p>The result of an <code>UpdateDomain</code> request. Contains the status of the domain being updated. </p>", 1784 "refs": { 1785 } 1786 }, 1787 "UpdatePackageRequest": { 1788 "base": "<p> Container for request parameters to the <code> <a>UpdatePackage</a> </code> operation. </p>", 1789 "refs": { 1790 } 1791 }, 1792 "UpdatePackageResponse": { 1793 "base": "<p> Container for the response returned by the <code> <a>UpdatePackage</a> </code> operation. </p>", 1794 "refs": { 1795 } 1796 }, 1797 "UpdateTimestamp": { 1798 "base": null, 1799 "refs": { 1800 "AutoTuneStatus$CreationDate": "<p>The timestamp of the Auto-Tune options creation date.</p>", 1801 "AutoTuneStatus$UpdateDate": "<p>The timestamp of when the Auto-Tune options were last updated.</p>", 1802 "OptionStatus$CreationDate": "<p>The timestamp of when the entity was created.</p>", 1803 "OptionStatus$UpdateDate": "<p>The timestamp of the last time the entity was updated.</p>", 1804 "ReservedInstance$StartTime": "<p>The time the reservation started.</p>" 1805 } 1806 }, 1807 "UpgradeDomainRequest": { 1808 "base": "<p> Container for the request parameters to <code> <a>UpgradeDomain</a> </code> operation. </p>", 1809 "refs": { 1810 } 1811 }, 1812 "UpgradeDomainResponse": { 1813 "base": "<p> Container for response returned by <code> <a>UpgradeDomain</a> </code> operation. </p>", 1814 "refs": { 1815 } 1816 }, 1817 "UpgradeHistory": { 1818 "base": "<p>History of the last 10 upgrades and upgrade eligibility checks.</p>", 1819 "refs": { 1820 "UpgradeHistoryList$member": null 1821 } 1822 }, 1823 "UpgradeHistoryList": { 1824 "base": null, 1825 "refs": { 1826 "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 the <code> <a>GetUpgradeHistoryResponse</a> </code> object. </p>" 1827 } 1828 }, 1829 "UpgradeName": { 1830 "base": null, 1831 "refs": { 1832 "GetUpgradeStatusResponse$UpgradeName": "<p>A string that briefly describes the update.</p>", 1833 "UpgradeHistory$UpgradeName": "<p>A string that briefly describes the upgrade.</p>" 1834 } 1835 }, 1836 "UpgradeStatus": { 1837 "base": null, 1838 "refs": { 1839 "GetUpgradeStatusResponse$StepStatus": "<p> One of four statuses an upgrade have, 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>", 1840 "UpgradeHistory$UpgradeStatus": "<p> The current status of the 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>", 1841 "UpgradeStepItem$UpgradeStepStatus": "<p> The current status of the 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>" 1842 } 1843 }, 1844 "UpgradeStep": { 1845 "base": null, 1846 "refs": { 1847 "GetUpgradeStatusResponse$UpgradeStep": "<p> One of three steps an upgrade or upgrade eligibility check goes through: <ul> <li>PreUpgradeCheck</li> <li>Snapshot</li> <li>Upgrade</li> </ul> </p>", 1848 "UpgradeStepItem$UpgradeStep": "<p> One of three steps an upgrade or upgrade eligibility check goes through: <ul> <li>PreUpgradeCheck</li> <li>Snapshot</li> <li>Upgrade</li> </ul> </p>" 1849 } 1850 }, 1851 "UpgradeStepItem": { 1852 "base": "<p>Represents a single step of the upgrade or upgrade eligibility check workflow.</p>", 1853 "refs": { 1854 "UpgradeStepsList$member": null 1855 } 1856 }, 1857 "UpgradeStepsList": { 1858 "base": null, 1859 "refs": { 1860 "UpgradeHistory$StepsList": "<p> A list of <code> <a>UpgradeStepItem</a> </code> s representing information about each step performed as part of a specific upgrade or upgrade eligibility check. </p>" 1861 } 1862 }, 1863 "UserPoolId": { 1864 "base": null, 1865 "refs": { 1866 "CognitoOptions$UserPoolId": "<p>The Cognito user pool ID for OpenSearch Dashboards authentication.</p>" 1867 } 1868 }, 1869 "Username": { 1870 "base": null, 1871 "refs": { 1872 "MasterUserOptions$MasterUserName": "<p>The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.</p>", 1873 "SAMLOptionsInput$MasterUserName": "<p>The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.</p>" 1874 } 1875 }, 1876 "VPCDerivedInfo": { 1877 "base": "<p>Options to specify the subnets and security groups for the VPC endpoint. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html\" target=\"_blank\"> Launching your Amazon OpenSearch Service domains using a VPC</a>. </p>", 1878 "refs": { 1879 "DomainStatus$VPCOptions": "<p>The <code>VPCOptions</code> for the specified domain. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html\" target=\"_blank\"> Launching your Amazon OpenSearch Service domains using a VPC</a>. </p>", 1880 "VPCDerivedInfoStatus$Options": "<p>The VPC options for the specified domain.</p>" 1881 } 1882 }, 1883 "VPCDerivedInfoStatus": { 1884 "base": "<p>Status of the VPC options for the specified domain.</p>", 1885 "refs": { 1886 "DomainConfig$VPCOptions": "<p>The <code>VPCOptions</code> for the specified domain. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html\" target=\"_blank\"> Launching your Amazon OpenSearch Service domains using a VPC</a>. </p>" 1887 } 1888 }, 1889 "VPCOptions": { 1890 "base": "<p>Options to specify the subnets and security groups for the VPC endpoint. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html\" target=\"_blank\"> Launching your Amazon OpenSearch Service domains using a VPC</a>. </p>", 1891 "refs": { 1892 "CreateDomainRequest$VPCOptions": "<p>Options to specify the subnets and security groups for a VPC endpoint. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html\" target=\"_blank\">Launching your Amazon OpenSearch Service domains using a VPC </a>. </p>", 1893 "UpdateDomainConfigRequest$VPCOptions": "<p>Options to specify the subnets and security groups for the VPC endpoint. For more information, see <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html\" target=\"_blank\">Launching your Amazon OpenSearch Service domains using a VPC </a>. </p>" 1894 } 1895 }, 1896 "ValidationException": { 1897 "base": "<p>An exception for missing / invalid input fields. Gives http status code of 400.</p>", 1898 "refs": { 1899 } 1900 }, 1901 "ValueStringList": { 1902 "base": null, 1903 "refs": { 1904 "Filter$Values": "<p> Contains one or more values for the filter. </p>" 1905 } 1906 }, 1907 "VersionList": { 1908 "base": "<p>List of supported OpenSearch versions. </p>", 1909 "refs": { 1910 "CompatibleVersionsMap$TargetVersions": null, 1911 "ListVersionsResponse$Versions": null 1912 } 1913 }, 1914 "VersionStatus": { 1915 "base": "<p>The status of the OpenSearch version options for the specified OpenSearch domain.</p>", 1916 "refs": { 1917 "DomainConfig$EngineVersion": "<p>String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.</p>" 1918 } 1919 }, 1920 "VersionString": { 1921 "base": null, 1922 "refs": { 1923 "CompatibleVersionsMap$SourceVersion": "<p>The current version of OpenSearch a domain is on.</p>", 1924 "CreateDomainRequest$EngineVersion": "<p>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 <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains\" target=\"_blank\">Creating and managing Amazon OpenSearch Service domains </a>. </p>", 1925 "DescribeInstanceTypeLimitsRequest$EngineVersion": "<p> Version of OpenSearch for which <code> <a>Limits</a> </code> are needed. </p>", 1926 "DomainStatus$EngineVersion": null, 1927 "ListInstanceTypeDetailsRequest$EngineVersion": null, 1928 "UpgradeDomainRequest$TargetVersion": "<p>The version of OpenSearch you intend to upgrade the domain to.</p>", 1929 "UpgradeDomainResponse$TargetVersion": "<p>The version of OpenSearch that you intend to upgrade the domain to.</p>", 1930 "VersionList$member": null, 1931 "VersionStatus$Options": "<p>The OpenSearch version for the specified OpenSearch domain.</p>" 1932 } 1933 }, 1934 "VolumeType": { 1935 "base": "<p>The type of EBS volume, standard, gp2, or io1. See <a href=\"http://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-createupdatedomains.html#opensearch-createdomain-configure-ebs\" target=\"_blank\">Configuring EBS-based Storage</a> for more information. </p>", 1936 "refs": { 1937 "EBSOptions$VolumeType": "<p>The volume type for EBS-based storage.</p>" 1938 } 1939 }, 1940 "ZoneAwarenessConfig": { 1941 "base": "<p>The zone awareness configuration for the domain cluster, such as the number of availability zones.</p>", 1942 "refs": { 1943 "ClusterConfig$ZoneAwarenessConfig": "<p>The zone awareness configuration for a domain when zone awareness is enabled.</p>" 1944 } 1945 } 1946 } 1947 }