Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains.
For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide . The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.
', 'operations' => [ 'AcceptInboundConnection' => 'Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
', 'AddTags' => 'Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
', 'AssociatePackage' => 'Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
', 'AuthorizeVpcEndpointAccess' => 'Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
', 'CancelServiceSoftwareUpdate' => 'Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain\'s UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.
Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
', 'CreateOutboundConnection' => 'Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
', 'CreatePackage' => 'Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
', 'CreateVpcEndpoint' => 'Creates an Amazon OpenSearch Service-managed VPC endpoint.
', 'DeleteDomain' => 'Deletes an Amazon OpenSearch Service domain and all of its data. You can\'t recover a domain after you delete it.
', 'DeleteInboundConnection' => 'Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
', 'DeleteOutboundConnection' => 'Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
', 'DeletePackage' => 'Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
', 'DeleteVpcEndpoint' => 'Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
', 'DescribeDomain' => 'Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
', 'DescribeDomainAutoTunes' => 'Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
', 'DescribeDomainChangeProgress' => 'Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
', 'DescribeDomainConfig' => 'Returns the configuration of an Amazon OpenSearch Service domain.
', 'DescribeDomainHealth' => 'Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
', 'DescribeDomainNodes' => 'Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
', 'DescribeDomains' => 'Returns domain configuration information about the specified Amazon OpenSearch Service domains.
', 'DescribeDryRunProgress' => 'Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.
', 'DescribeInboundConnections' => 'Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
', 'DescribeInstanceTypeLimits' => 'Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
', 'DescribeOutboundConnections' => 'Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
', 'DescribePackages' => 'Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
', 'DescribeReservedInstanceOfferings' => 'Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
', 'DescribeReservedInstances' => 'Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
', 'DescribeVpcEndpoints' => 'Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
', 'DissociatePackage' => 'Removes a package from the specified Amazon OpenSearch Service domain. The package can\'t be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
', 'GetCompatibleVersions' => 'Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
', 'GetPackageVersionHistory' => 'Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.
', 'GetUpgradeHistory' => 'Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
', 'GetUpgradeStatus' => 'Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
', 'ListDomainNames' => 'Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
', 'ListDomainsForPackage' => 'Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
', 'ListInstanceTypeDetails' => 'Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
', 'ListPackagesForDomain' => 'Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
', 'ListScheduledActions' => 'Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.
', 'ListTags' => 'Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
', 'ListVersions' => 'Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
', 'ListVpcEndpointAccess' => 'Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
', 'ListVpcEndpoints' => 'Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
', 'ListVpcEndpointsForDomain' => 'Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
', 'PurchaseReservedInstanceOffering' => 'Allows you to purchase Amazon OpenSearch Service Reserved Instances.
', 'RejectInboundConnection' => 'Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
', 'RemoveTags' => 'Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
', 'RevokeVpcEndpointAccess' => 'Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
', 'StartServiceSoftwareUpdate' => 'Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
', 'UpdateDomainConfig' => 'Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.sl
', 'UpdatePackage' => 'Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
', 'UpdateScheduledAction' => 'Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.
', 'UpdateVpcEndpoint' => 'Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
', 'UpgradeDomain' => 'Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
', ], 'shapes' => [ 'ARN' => [ 'base' => 'The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
', 'refs' => [ 'AddTagsRequest$ARN' => 'Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.
', 'DomainEndpointOptions$CustomEndpointCertificateArn' => 'The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
', 'DomainStatus$ARN' => 'The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
', 'ListTagsRequest$ARN' => 'Amazon Resource Name (ARN) for the domain to view tags for.
', 'MasterUserOptions$MasterUserARN' => 'Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.
The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.
', ], ], 'AWSAccount' => [ 'base' => NULL, 'refs' => [ 'AuthorizeVpcEndpointAccessRequest$Account' => 'The Amazon Web Services account ID to grant access to.
', 'RevokeVpcEndpointAccessRequest$Account' => 'The account ID to revoke access from.
', 'VpcEndpoint$VpcEndpointOwner' => 'The creator of the endpoint.
', ], ], 'AWSDomainInformation' => [ 'base' => 'Information about an Amazon OpenSearch Service domain.
', 'refs' => [ 'DomainInformationContainer$AWSDomainInformation' => 'Information about an Amazon OpenSearch Service domain.
', ], ], 'AcceptInboundConnectionRequest' => [ 'base' => 'Container for the parameters to the AcceptInboundConnection operation.
Contains details about the accepted inbound connection.
', 'refs' => [], ], 'AccessDeniedException' => [ 'base' => 'An error occurred because you don\'t have permissions to access the resource.
', 'refs' => [], ], 'AccessPoliciesStatus' => [ 'base' => 'The configured access rules for the domain\'s search endpoint, and the current status of those rules.
', 'refs' => [ 'DomainConfig$AccessPolicies' => 'Specifies the access policies for the domain.
', ], ], 'ActionSeverity' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Severity' => 'The severity of the action.
', ], ], 'ActionStatus' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Status' => 'The current status of the scheduled action.
', ], ], 'ActionType' => [ 'base' => NULL, 'refs' => [ 'ScheduledAction$Type' => 'The type of action that will be taken on the domain.
', 'UpdateScheduledActionRequest$ActionType' => 'The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.
Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.
List of limits that are specific to a given instance type.
', 'refs' => [ 'AdditionalLimitList$member' => NULL, ], ], 'AdditionalLimitList' => [ 'base' => NULL, 'refs' => [ 'Limits$AdditionalLimits' => 'List of additional limits that are specific to a given instance type for each of its instance roles.
', ], ], 'AdvancedOptions' => [ 'base' => 'Exposes native OpenSearch configuration values from opensearch.yml. The following advanced options are available:
Allows references to indexes in an HTTP request body. Must be false when configuring access to individual sub-resources. Default is true.
Specifies the percentage of heap space allocated to field data. Default is unbounded.
For more information, see Advanced cluster parameters.
', 'refs' => [ 'AdvancedOptionsStatus$Options' => 'The status of advanced options for the specified domain.
', 'CreateDomainRequest$AdvancedOptions' => 'Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
"override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
', 'DomainStatus$AdvancedOptions' => 'Key-value pairs that specify advanced configuration options.
', 'UpdateDomainConfigRequest$AdvancedOptions' => 'Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
For more information, see Advanced cluster parameters.
', 'UpgradeDomainRequest$AdvancedOptions' => 'Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.
The advanced options configuration for the domain.
', ], ], 'AdvancedOptionsStatus' => [ 'base' => 'Status of the advanced options for the specified domain. The following options are available:
"rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.
"indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.
"override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
', 'refs' => [ 'DomainConfig$AdvancedOptions' => 'Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
', ], ], 'AdvancedSecurityOptions' => [ 'base' => 'Container for fine-grained access control settings.
', 'refs' => [ 'AdvancedSecurityOptionsStatus$Options' => 'Container for fine-grained access control settings.
', 'DomainStatus$AdvancedSecurityOptions' => 'Settings for fine-grained access control.
', ], ], 'AdvancedSecurityOptionsInput' => [ 'base' => 'Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service.
', 'refs' => [ 'CreateDomainRequest$AdvancedSecurityOptions' => 'Options for fine-grained access control.
', 'UpdateDomainConfigRequest$AdvancedSecurityOptions' => 'Options for fine-grained access control.
', ], ], 'AdvancedSecurityOptionsStatus' => [ 'base' => 'The status of fine-grained access control settings for a domain.
', 'refs' => [ 'DomainConfig$AdvancedSecurityOptions' => 'Container for fine-grained access control settings for the domain.
', ], ], 'AssociatePackageRequest' => [ 'base' => 'Container for the request parameters to the AssociatePackage operation.
Container for the response returned by the AssociatePackage operation.
Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
', 'refs' => [ 'AuthorizeVpcEndpointAccessResponse$AuthorizedPrincipal' => 'Information about the Amazon Web Services account or service that was provided access to the domain.
', 'AuthorizedPrincipalList$member' => NULL, ], ], 'AuthorizedPrincipalList' => [ 'base' => NULL, 'refs' => [ 'ListVpcEndpointAccessResponse$AuthorizedPrincipalList' => 'A list of IAM principals that can currently access the domain.
', ], ], 'AutoTune' => [ 'base' => 'Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
', 'refs' => [ 'AutoTuneList$member' => NULL, ], ], 'AutoTuneDate' => [ 'base' => 'The timestamp of the Auto-Tune action scheduled for the domain.
', 'refs' => [ 'ScheduledAutoTuneDetails$Date' => 'The date and time when the Auto-Tune action is scheduled for the domain.
', ], ], 'AutoTuneDesiredState' => [ 'base' => 'The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
', 'refs' => [ 'AutoTuneOptions$DesiredState' => 'Whether Auto-Tune is enabled or disabled.
', 'AutoTuneOptionsInput$DesiredState' => 'Whether Auto-Tune is enabled or disabled.
', ], ], 'AutoTuneDetails' => [ 'base' => 'Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
', 'refs' => [ 'AutoTune$AutoTuneDetails' => 'Details about an Auto-Tune action.
', ], ], 'AutoTuneList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainAutoTunesResponse$AutoTunes' => 'The list of setting adjustments that Auto-Tune has made to the domain.
', ], ], 'AutoTuneMaintenanceSchedule' => [ 'base' => 'This object is deprecated. Use the domain\'s off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows.
The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.
', 'refs' => [ 'AutoTuneMaintenanceScheduleList$member' => NULL, ], ], 'AutoTuneMaintenanceScheduleList' => [ 'base' => NULL, 'refs' => [ 'AutoTuneOptions$MaintenanceSchedules' => 'DEPRECATED. Use off-peak window instead.
A list of maintenance schedules during which Auto-Tune can deploy changes.
', 'AutoTuneOptionsInput$MaintenanceSchedules' => 'A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.
', ], ], 'AutoTuneOptions' => [ 'base' => 'Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
', 'refs' => [ 'AutoTuneOptionsStatus$Options' => 'Auto-Tune settings for updating a domain.
', 'UpdateDomainConfigRequest$AutoTuneOptions' => 'Options for Auto-Tune.
', ], ], 'AutoTuneOptionsInput' => [ 'base' => 'Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service
', 'refs' => [ 'CreateDomainRequest$AutoTuneOptions' => 'Options for Auto-Tune.
', ], ], 'AutoTuneOptionsOutput' => [ 'base' => 'The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.
', 'refs' => [ 'DomainStatus$AutoTuneOptions' => 'Auto-Tune settings for the domain.
', ], ], 'AutoTuneOptionsStatus' => [ 'base' => 'The Auto-Tune status for the domain.
', 'refs' => [ 'DomainConfig$AutoTuneOptions' => 'Container for Auto-Tune settings for the domain.
', ], ], 'AutoTuneState' => [ 'base' => 'The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.
', 'refs' => [ 'AutoTuneOptionsOutput$State' => 'The current state of Auto-Tune on the domain.
', 'AutoTuneStatus$State' => 'The current state of Auto-Tune on the domain.
', ], ], 'AutoTuneStatus' => [ 'base' => 'The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
', 'refs' => [ 'AutoTuneOptionsStatus$Status' => 'The current status of Auto-Tune for a domain.
', ], ], 'AutoTuneType' => [ 'base' => 'Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
', 'refs' => [ 'AutoTune$AutoTuneType' => 'The type of Auto-Tune action.
', ], ], 'AvailabilityZone' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$AvailabilityZoneName' => 'The name of the Availability Zone.
', 'AvailabilityZoneList$member' => NULL, 'DomainNodesStatus$AvailabilityZone' => 'The Availability Zone of the node.
', ], ], 'AvailabilityZoneInfo' => [ 'base' => 'Information about an Availability Zone on a domain.
', 'refs' => [ 'AvailabilityZoneInfoList$member' => NULL, ], ], 'AvailabilityZoneInfoList' => [ 'base' => NULL, 'refs' => [ 'EnvironmentInfo$AvailabilityZoneInformation' => ' A list of AvailabilityZoneInfo for the domain.
The supported Availability Zones for the instance type.
', ], ], 'BackendRole' => [ 'base' => NULL, 'refs' => [ 'SAMLOptionsInput$MasterBackendRole' => 'The backend role that the SAML master user is mapped to.
', ], ], 'BaseException' => [ 'base' => 'An error occurred while processing the request.
', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$Enabled' => 'True if fine-grained access control is enabled.
', 'AdvancedSecurityOptions$InternalUserDatabaseEnabled' => 'True if the internal user database is enabled.
', 'AdvancedSecurityOptions$AnonymousAuthEnabled' => 'True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
', 'AdvancedSecurityOptionsInput$Enabled' => 'True to enable fine-grained access control.
', 'AdvancedSecurityOptionsInput$InternalUserDatabaseEnabled' => 'True to enable the internal user database.
', 'AdvancedSecurityOptionsInput$AnonymousAuthEnabled' => 'True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
', 'AutoTuneOptions$UseOffPeakWindow' => 'Whether to use the domain\'s off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.
', 'AutoTuneOptionsInput$UseOffPeakWindow' => 'Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain\'s configured daily off-peak window.
', 'AutoTuneOptionsOutput$UseOffPeakWindow' => 'Whether the domain\'s off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.
', 'AutoTuneStatus$PendingDeletion' => 'Indicates whether the domain is being deleted.
', 'ClusterConfig$DedicatedMasterEnabled' => 'Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.
Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
', 'ClusterConfig$WarmEnabled' => 'Whether to enable warm storage for the cluster.
', 'ClusterConfig$MultiAZWithStandbyEnabled' => 'A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
', 'CognitoOptions$Enabled' => 'Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
', 'ColdStorageOptions$Enabled' => 'Whether to enable or disable cold storage on the domain.
', 'DescribeDomainHealthResponse$DedicatedMaster' => 'A boolean that indicates if dedicated master nodes are activated for the domain.
', 'DescribeDryRunProgressRequest$LoadDryRunConfig' => 'Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you\'re planning to make on the domain.
', 'DomainEndpointOptions$EnforceHTTPS' => 'True to require that all traffic to the domain arrive over HTTPS.
', 'DomainEndpointOptions$CustomEndpointEnabled' => 'Whether to enable a custom endpoint for the domain.
', 'DomainStatus$Created' => 'Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
', 'DomainStatus$Deleted' => 'Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
', 'DomainStatus$Processing' => 'The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
', 'DomainStatus$UpgradeProcessing' => 'The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
', 'EBSOptions$EBSEnabled' => 'Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
', 'EncryptionAtRestOptions$Enabled' => 'True to enable encryption at rest.
', 'InstanceTypeDetails$EncryptionEnabled' => 'Whether encryption at rest and node-to-node encryption are supported for the instance type.
', 'InstanceTypeDetails$CognitoEnabled' => 'Whether Amazon Cognito access is supported for the instance type.
', 'InstanceTypeDetails$AppLogsEnabled' => 'Whether logging is supported for the instance type.
', 'InstanceTypeDetails$AdvancedSecurityEnabled' => 'Whether fine-grained access control is supported for the instance type.
', 'InstanceTypeDetails$WarmEnabled' => 'Whether UltraWarm is supported for the instance type.
', 'ListInstanceTypeDetailsRequest$RetrieveAZs' => 'An optional parameter that specifies the Availability Zones for the domain.
', 'LogPublishingOption$Enabled' => 'Whether the log should be published.
', 'NodeToNodeEncryptionOptions$Enabled' => 'True to enable node-to-node encryption.
', 'OffPeakWindowOptions$Enabled' => 'Whether to enable an off-peak window.
This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can\'t disable the off-peak window after it\'s enabled for a domain.
', 'OptionStatus$PendingDeletion' => 'Indicates whether the entity is being deleted.
', 'SAMLOptionsInput$Enabled' => 'True to enable SAML authentication for a domain.
', 'SAMLOptionsOutput$Enabled' => 'True if SAML is enabled.
', 'ScheduledAction$Mandatory' => 'Whether the action is required or optional.
', 'ScheduledAction$Cancellable' => 'Whether or not the scheduled action is cancellable.
', 'ServiceSoftwareOptions$UpdateAvailable' => 'True if you\'re able to update your service software version. False if you can\'t update your service software version.
', 'ServiceSoftwareOptions$Cancellable' => 'True if you\'re able to cancel your service software version update. False if you can\'t cancel your service software update.
', 'ServiceSoftwareOptions$OptionalDeployment' => 'True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
', 'SoftwareUpdateOptions$AutoSoftwareUpdateEnabled' => 'Whether automatic service software updates are enabled for the domain.
', 'UpgradeDomainRequest$PerformCheckOnly' => 'When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
', 'UpgradeDomainResponse$PerformCheckOnly' => 'When true, indicates that an upgrade eligibility check was performed.
', ], ], 'CancelServiceSoftwareUpdateRequest' => [ 'base' => 'Container for the request parameters to cancel a service software update.
', 'refs' => [], ], 'CancelServiceSoftwareUpdateResponse' => [ 'base' => 'Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.
Container for information about a configuration change happening on a domain.
', 'refs' => [ 'DomainConfig$ChangeProgressDetails' => 'Container for information about the progress of an existing configuration change.
', 'DomainStatus$ChangeProgressDetails' => 'Information about a configuration change happening on the domain.
', 'UpgradeDomainResponse$ChangeProgressDetails' => 'Container for information about a configuration change happening on a domain.
', ], ], 'ChangeProgressStage' => [ 'base' => 'Progress details for each stage of a domain update.
', 'refs' => [ 'ChangeProgressStageList$member' => NULL, ], ], 'ChangeProgressStageList' => [ 'base' => 'The list of progress stages of a specific domain configuration change.
', 'refs' => [ 'ChangeProgressStatusDetails$ChangeProgressStages' => 'The specific stages that the domain is going through to perform the configuration change.
', ], ], 'ChangeProgressStageName' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Name' => 'The name of the stage.
', ], ], 'ChangeProgressStageStatus' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => 'The status of the stage.
', ], ], 'ChangeProgressStatusDetails' => [ 'base' => 'The progress details of a specific domain configuration change.
', 'refs' => [ 'DescribeDomainChangeProgressResponse$ChangeProgressStatus' => 'Container for information about the stages of a configuration change happening on a domain.
', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateVpcEndpointRequest$ClientToken' => 'Unique, case-sensitive identifier to ensure idempotency of the request.
', ], ], 'CloudWatchLogsLogGroupArn' => [ 'base' => 'ARN of the Cloudwatch log group to publish logs to.
', 'refs' => [ 'LogPublishingOption$CloudWatchLogsLogGroupArn' => 'The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
', ], ], 'ClusterConfig' => [ 'base' => 'Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
', 'refs' => [ 'ClusterConfigStatus$Options' => 'Cluster configuration options for the specified domain.
', 'CreateDomainRequest$ClusterConfig' => 'Container for the cluster configuration of a domain.
', 'DomainStatus$ClusterConfig' => 'Container for the cluster configuration of the domain.
', 'UpdateDomainConfigRequest$ClusterConfig' => 'Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
', ], ], 'ClusterConfigStatus' => [ 'base' => 'The cluster configuration status for a domain.
', 'refs' => [ 'DomainConfig$ClusterConfig' => 'Container for the cluster configuration of a the domain.
', ], ], 'CognitoOptions' => [ 'base' => 'Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
', 'refs' => [ 'CognitoOptionsStatus$Options' => 'Cognito options for the specified domain.
', 'CreateDomainRequest$CognitoOptions' => 'Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
', 'DomainStatus$CognitoOptions' => 'Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
', 'UpdateDomainConfigRequest$CognitoOptions' => 'Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
', ], ], 'CognitoOptionsStatus' => [ 'base' => 'The status of the Cognito options for the specified domain.
', 'refs' => [ 'DomainConfig$CognitoOptions' => 'Container for Amazon Cognito options for the domain.
', ], ], 'ColdStorageOptions' => [ 'base' => 'Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.
', 'refs' => [ 'ClusterConfig$ColdStorageOptions' => 'Container for cold storage configuration options.
', ], ], 'CommitMessage' => [ 'base' => NULL, 'refs' => [ 'PackageVersionHistory$CommitMessage' => 'A message associated with the package version when it was uploaded.
', 'UpdatePackageRequest$CommitMessage' => 'Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.
A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
', ], ], 'CompatibleVersionsMap' => [ 'base' => 'A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
', 'refs' => [ 'CompatibleVersionsList$member' => NULL, ], ], 'ConflictException' => [ 'base' => 'An error occurred because the client attempts to remove a resource that is currently in use.
', 'refs' => [], ], 'ConnectionAlias' => [ 'base' => NULL, 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionAlias' => 'Name of the connection.
', 'CreateOutboundConnectionResponse$ConnectionAlias' => 'Name of the connection.
', 'OutboundConnection$ConnectionAlias' => 'Name of the connection.
', ], ], 'ConnectionId' => [ 'base' => NULL, 'refs' => [ 'AcceptInboundConnectionRequest$ConnectionId' => 'The ID of the inbound connection to accept.
', 'CreateOutboundConnectionResponse$ConnectionId' => 'The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.
', 'DeleteInboundConnectionRequest$ConnectionId' => 'The ID of the inbound connection to permanently delete.
', 'DeleteOutboundConnectionRequest$ConnectionId' => 'The ID of the outbound connection you want to permanently delete.
', 'InboundConnection$ConnectionId' => 'The unique identifier of the connection.
', 'OutboundConnection$ConnectionId' => 'Unique identifier of the connection.
', 'RejectInboundConnectionRequest$ConnectionId' => 'The unique identifier of the inbound connection to reject.
', ], ], 'ConnectionMode' => [ 'base' => 'The connection mode for the cross-cluster connection.
DIRECT - Used for cross-cluster search or cross-cluster replication.
VPC_ENDPOINT - Used for remote reindex between Amazon OpenSearch Service VPC domains.
The connection mode.
', 'CreateOutboundConnectionResponse$ConnectionMode' => 'The connection mode.
', 'InboundConnection$ConnectionMode' => 'The connection mode.
', 'OutboundConnection$ConnectionMode' => 'The connection mode.
', ], ], 'ConnectionProperties' => [ 'base' => 'The connection properties of an outbound connection.
', 'refs' => [ 'CreateOutboundConnectionRequest$ConnectionProperties' => 'The ConnectionProperties for the outbound connection.
The ConnectionProperties for the newly created connection.
Properties for the outbound connection.
', ], ], 'ConnectionStatusMessage' => [ 'base' => NULL, 'refs' => [ 'InboundConnectionStatus$Message' => 'Information about the connection.
', 'OutboundConnectionStatus$Message' => 'Verbose information for the outbound connection.
', ], ], 'CreateDomainRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDomainResponse' => [ 'base' => 'The result of a CreateDomain operation. Contains the status of the newly created domain.
Container for the parameters to the CreateOutboundConnection operation.
The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.
Container for request parameters to the CreatePackage operation.
Container for the response returned by the CreatePackage operation.
The timestamp when the package was created.
', 'PackageVersionHistory$CreatedAt' => 'The date and time when the package was created.
', ], ], 'CrossClusterSearchConnectionProperties' => [ 'base' => 'Cross cluster search specific connection properties.
', 'refs' => [ 'ConnectionProperties$CrossClusterSearch' => 'The connection properties for cross cluster search.
', ], ], 'DeleteDomainRequest' => [ 'base' => 'Container for the parameters to the DeleteDomain operation.
The results of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.
Container for the parameters to the DeleteInboundConnection operation.
The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.
Container for the parameters to the DeleteOutboundConnection operation.
Details about the deleted outbound connection.
', 'refs' => [], ], 'DeletePackageRequest' => [ 'base' => 'Deletes a package from OpenSearch Service. The package can\'t be associated with any OpenSearch Service domain.
', 'refs' => [], ], 'DeletePackageResponse' => [ 'base' => 'Container for the response parameters to the DeletePackage operation.
An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
', 'refs' => [], ], 'DeploymentCloseDateTimeStamp' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$AutomatedUpdateDate' => 'The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
', ], ], 'DeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'ServiceSoftwareOptions$UpdateStatus' => 'The status of your service software update.
', ], ], 'DeploymentType' => [ 'base' => NULL, 'refs' => [ 'DryRunResults$DeploymentType' => 'Specifies the way in which OpenSearch Service will apply an update. Possible values are:
Blue/Green - The update requires a blue/green deployment.
DynamicUpdate - No blue/green deployment required
Undetermined - The domain is in the middle of an update and can\'t predict the deployment type. Try again after the update is complete.
None - The request doesn\'t include any configuration changes.
Container for the parameters to the DescribeDomainAutoTunes operation.
The result of a DescribeDomainAutoTunes request.
Container for the parameters to the DescribeDomainChangeProgress operation.
The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.
Container for the parameters to the DescribeDomainConfig operation.
Contains the configuration information of the requested domain.
', 'refs' => [], ], 'DescribeDomainHealthRequest' => [ 'base' => 'Container for the parameters to the DescribeDomainHealth operation.
The result of a DescribeDomainHealth request. Contains health information for the requested domain.
Container for the parameters to the DescribeDomainNodes operation.
The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.
Container for the parameters to the DescribeDomain operation.
Contains the status of the domain specified in the request.
', 'refs' => [], ], 'DescribeDomainsRequest' => [ 'base' => 'Container for the parameters to the DescribeDomains operation.
Contains the status of the specified domains or all domains owned by the account.
', 'refs' => [], ], 'DescribeDryRunProgressRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDryRunProgressResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInboundConnectionsRequest' => [ 'base' => 'Container for the parameters to the DescribeInboundConnections operation.
Contains a list of connections matching the filter criteria.
', 'refs' => [], ], 'DescribeInstanceTypeLimitsRequest' => [ 'base' => 'Container for the parameters to the DescribeInstanceTypeLimits operation.
Container for the parameters received from the DescribeInstanceTypeLimits operation.
Container for the parameters to the DescribeOutboundConnections operation.
Contains a list of connections matching the filter criteria.
', 'refs' => [], ], 'DescribePackagesFilter' => [ 'base' => 'A filter to apply to the DescribePackage response.
A list of DescribePackagesFilter to filter the packages included in a DescribePackages response.
Only returns packages that match the DescribePackagesFilterList values.
Any field from PackageDetails.
A non-empty list of values for the specified filter field.
', ], ], 'DescribePackagesRequest' => [ 'base' => 'Container for the request parameters to the DescribePackage operation.
Container for the response returned by the DescribePackages operation.
Container for the request parameters to a DescribeReservedInstanceOfferings operation.
Container for results of a DescribeReservedInstanceOfferings request.
Container for the request parameters to the DescribeReservedInstances operation.
Container for results from DescribeReservedInstances
The description of the stage.
', ], ], 'DisableTimestamp' => [ 'base' => NULL, 'refs' => [ 'AdvancedSecurityOptions$AnonymousAuthDisableDate' => 'Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
', ], ], 'DisabledOperationException' => [ 'base' => 'An error occured because the client wanted to access an unsupported operation.
', 'refs' => [], ], 'DissociatePackageRequest' => [ 'base' => 'Container for the request parameters to the DissociatePackage operation.
Container for the response returned by an DissociatePackage operation.
The Amazon Resource Name (ARN) of the domain to create the endpoint for.
', 'VpcEndpoint$DomainArn' => 'The Amazon Resource Name (ARN) of the domain associated with the endpoint.
', 'VpcEndpointSummary$DomainArn' => 'The Amazon Resource Name (ARN) of the domain associated with the endpoint.
', ], ], 'DomainConfig' => [ 'base' => 'Container for the configuration of an OpenSearch Service domain.
', 'refs' => [ 'DescribeDomainConfigResponse$DomainConfig' => 'Container for the configuration of the OpenSearch Service domain.
', 'UpdateDomainConfigResponse$DomainConfig' => 'The status of the updated domain.
', ], ], 'DomainEndpointOptions' => [ 'base' => 'Options to configure a custom endpoint for an OpenSearch Service domain.
', 'refs' => [ 'CreateDomainRequest$DomainEndpointOptions' => 'Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
', 'DomainEndpointOptionsStatus$Options' => 'Options to configure the endpoint for a domain.
', 'DomainStatus$DomainEndpointOptions' => 'Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
', 'UpdateDomainConfigRequest$DomainEndpointOptions' => 'Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
', ], ], 'DomainEndpointOptionsStatus' => [ 'base' => 'The configured endpoint options for a domain and their current status.
', 'refs' => [ 'DomainConfig$DomainEndpointOptions' => 'Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
', ], ], 'DomainHealth' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$ClusterHealth' => 'The current health status of your cluster.
Red - At least one primary shard is not allocated to any node.
Yellow - All primary shards are allocated to nodes, but some replicas aren’t.
Green - All primary shards and their replicas are allocated to nodes.
NotAvailable - Unable to retrieve cluster health.
Unique identifier for an OpenSearch Service domain.
', 'refs' => [ 'DomainStatus$DomainId' => 'Unique identifier for the domain.
', ], ], 'DomainInfo' => [ 'base' => 'Information about an OpenSearch Service domain.
', 'refs' => [ 'DomainInfoList$member' => NULL, ], ], 'DomainInfoList' => [ 'base' => 'Contains a list of information about a domain.
', 'refs' => [ 'ListDomainNamesResponse$DomainNames' => 'The names of all OpenSearch Service domains owned by the current user and their respective engine types.
', ], ], 'DomainInformationContainer' => [ 'base' => 'Container for information about an OpenSearch Service domain.
', 'refs' => [ 'CreateOutboundConnectionRequest$LocalDomainInfo' => 'Name and Region of the source (local) domain.
', 'CreateOutboundConnectionRequest$RemoteDomainInfo' => 'Name and Region of the destination (remote) domain.
', 'CreateOutboundConnectionResponse$LocalDomainInfo' => 'Information about the source (local) domain.
', 'CreateOutboundConnectionResponse$RemoteDomainInfo' => 'Information about the destination (remote) domain.
', 'InboundConnection$LocalDomainInfo' => 'Information about the source (local) domain.
', 'InboundConnection$RemoteDomainInfo' => 'Information about the destination (remote) domain.
', 'OutboundConnection$LocalDomainInfo' => 'Information about the source (local) domain.
', 'OutboundConnection$RemoteDomainInfo' => 'Information about the destination (remote) domain.
', ], ], 'DomainName' => [ 'base' => 'The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.
', 'refs' => [ 'AWSDomainInformation$DomainName' => 'Name of the domain.
', 'AssociatePackageRequest$DomainName' => 'Name of the domain to associate the package with.
', 'AuthorizeVpcEndpointAccessRequest$DomainName' => 'The name of the OpenSearch Service domain to provide access to.
', 'CancelServiceSoftwareUpdateRequest$DomainName' => 'Name of the OpenSearch Service domain that you want to cancel the service software update on.
', 'CreateDomainRequest$DomainName' => 'Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.
', 'DeleteDomainRequest$DomainName' => 'The name of the domain you want to permanently delete.
', 'DescribeDomainAutoTunesRequest$DomainName' => 'Name of the domain that you want Auto-Tune details about.
', 'DescribeDomainChangeProgressRequest$DomainName' => 'The name of the domain to get progress information for.
', 'DescribeDomainConfigRequest$DomainName' => 'Name of the OpenSearch Service domain configuration that you want to describe.
', 'DescribeDomainHealthRequest$DomainName' => 'The name of the domain.
', 'DescribeDomainNodesRequest$DomainName' => 'The name of the domain.
', 'DescribeDomainRequest$DomainName' => 'The name of the domain that you want information about.
', 'DescribeDryRunProgressRequest$DomainName' => 'The name of the domain.
', 'DescribeInstanceTypeLimitsRequest$DomainName' => 'The name of the domain. Only specify if you need the limits for an existing domain.
', 'DissociatePackageRequest$DomainName' => 'Name of the domain to dissociate the package from.
', 'DomainInfo$DomainName' => 'Name of the domain.
', 'DomainNameList$member' => NULL, 'DomainPackageDetails$DomainName' => 'Name of the domain that the package is associated with.
', 'DomainStatus$DomainName' => 'Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
', 'GetCompatibleVersionsRequest$DomainName' => 'The name of an existing domain. Provide this parameter to limit the results to a single domain.
', 'GetUpgradeHistoryRequest$DomainName' => 'The name of an existing domain.
', 'GetUpgradeStatusRequest$DomainName' => 'The domain of the domain to get upgrade status information for.
', 'ListInstanceTypeDetailsRequest$DomainName' => 'The name of the domain.
', 'ListPackagesForDomainRequest$DomainName' => 'The name of the domain for which you want to list associated packages.
', 'ListScheduledActionsRequest$DomainName' => 'The name of the domain.
', 'ListVpcEndpointAccessRequest$DomainName' => 'The name of the OpenSearch Service domain to retrieve access information for.
', 'ListVpcEndpointsForDomainRequest$DomainName' => 'The name of the domain to list associated VPC endpoints for.
', 'RevokeVpcEndpointAccessRequest$DomainName' => 'The name of the OpenSearch Service domain.
', 'StartServiceSoftwareUpdateRequest$DomainName' => 'The name of the domain that you want to update to the latest service software.
', 'UpdateDomainConfigRequest$DomainName' => 'The name of the domain that you\'re updating.
', 'UpdateScheduledActionRequest$DomainName' => 'The name of the domain to reschedule an action for.
', 'UpgradeDomainRequest$DomainName' => 'Name of the OpenSearch Service domain that you want to upgrade.
', 'UpgradeDomainResponse$DomainName' => 'The name of the domain that was upgraded.
', ], ], 'DomainNameFqdn' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$CustomEndpoint' => 'The fully qualified URL for the custom endpoint.
', ], ], 'DomainNameList' => [ 'base' => 'A list of OpenSearch Service domain names.
', 'refs' => [ 'DescribeDomainsRequest$DomainNames' => 'Array of OpenSearch Service domain names that you want information about. If you don\'t specify any domains, OpenSearch Service returns information about all domains owned by the account.
', ], ], 'DomainNodesStatus' => [ 'base' => 'Container for information about nodes on the domain.
', 'refs' => [ 'DomainNodesStatusList$member' => NULL, ], ], 'DomainNodesStatusList' => [ 'base' => 'List of DomainNodesStatus with details about nodes on the requested domain.
Contains nodes information list DomainNodesStatusList with details about the all nodes on the requested domain.
Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
', 'refs' => [ 'AssociatePackageResponse$DomainPackageDetails' => 'Information about a package that is associated with a domain.
', 'DissociatePackageResponse$DomainPackageDetails' => 'Information about a package that has been dissociated from the domain.
', 'DomainPackageDetailsList$member' => NULL, ], ], 'DomainPackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListDomainsForPackageResponse$DomainPackageDetailsList' => 'Information about all domains associated with a package.
', 'ListPackagesForDomainResponse$DomainPackageDetailsList' => 'List of all packages associated with a domain.
', ], ], 'DomainPackageStatus' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$DomainPackageStatus' => 'State of the association.
', ], ], 'DomainState' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$DomainState' => 'The current state of the domain.
Processing - The domain has updates in progress.
Active - Requested changes have been processed and deployed to the domain.
The current status of an OpenSearch Service domain.
', 'refs' => [ 'CreateDomainResponse$DomainStatus' => 'The status of the newly created domain.
', 'DeleteDomainResponse$DomainStatus' => 'The status of the domain being deleted.
', 'DescribeDomainResponse$DomainStatus' => 'List that contains the status of each specified OpenSearch Service domain.
', 'DescribeDryRunProgressResponse$DryRunConfig' => 'Details about the changes you\'re planning to make on the domain.
', 'DomainStatusList$member' => NULL, ], ], 'DomainStatusList' => [ 'base' => 'List that contains the status of each specified OpenSearch Service domain.
', 'refs' => [ 'DescribeDomainsResponse$DomainStatusList' => 'The status of the requested domains.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$RecurringChargeAmount' => 'The monetary amount of the recurring charge.
', 'ReservedInstance$FixedPrice' => 'The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.
', 'ReservedInstance$UsagePrice' => 'The hourly rate at which you\'re charged for the domain using this Reserved Instance.
', 'ReservedInstanceOffering$FixedPrice' => 'The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.
', 'ReservedInstanceOffering$UsagePrice' => 'The hourly rate at which you\'re charged for the domain using this Reserved Instance.
', 'UpgradeStepItem$ProgressPercent' => 'The floating point value representing the progress percentage of a particular step.
', ], ], 'DryRun' => [ 'base' => NULL, 'refs' => [ 'UpdateDomainConfigRequest$DryRun' => 'This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.
The type of dry run to perform.
Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.
Verbose runs an additional check to validate the changes you\'re making. For more information, see Validating a domain update.
Information about the progress of a pre-upgrade dry run analysis.
', 'refs' => [ 'DescribeDryRunProgressResponse$DryRunProgressStatus' => 'The current status of the dry run, including any validation errors.
', 'UpdateDomainConfigResponse$DryRunProgressStatus' => 'The status of the dry run being performed on the domain, if any.
', ], ], 'DryRunResults' => [ 'base' => 'Results of a dry run performed in an update domain request.
', 'refs' => [ 'DescribeDryRunProgressResponse$DryRunResults' => 'The results of the dry run.
', 'UpdateDomainConfigResponse$DryRunResults' => 'Results of the dry run performed in the update domain request.
', ], ], 'Duration' => [ 'base' => 'The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.
', 'refs' => [ 'AutoTuneMaintenanceSchedule$Duration' => 'The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.
Integer that specifies the value of a maintenance schedule duration.
', 'refs' => [ 'Duration$Value' => 'Integer to specify the value of a maintenance schedule duration.
', ], ], 'EBSOptions' => [ 'base' => 'Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
', 'refs' => [ 'CreateDomainRequest$EBSOptions' => 'Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
', 'DomainStatus$EBSOptions' => 'Container for EBS-based storage settings for the domain.
', 'EBSOptionsStatus$Options' => 'The configured EBS options for the specified domain.
', 'UpdateDomainConfigRequest$EBSOptions' => 'The type and size of the EBS volume to attach to instances in the domain.
', ], ], 'EBSOptionsStatus' => [ 'base' => 'The status of the EBS options for the specified OpenSearch Service domain.
', 'refs' => [ 'DomainConfig$EBSOptions' => 'Container for EBS options configured for the domain.
', ], ], 'EncryptionAtRestOptions' => [ 'base' => 'Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can be used only to create a new domain, not update an existing one.
', 'refs' => [ 'CreateDomainRequest$EncryptionAtRestOptions' => 'Key-value pairs to enable encryption at rest.
', 'DomainStatus$EncryptionAtRestOptions' => 'Encryption at rest settings for the domain.
', 'EncryptionAtRestOptionsStatus$Options' => 'Encryption at rest options for the specified domain.
', 'UpdateDomainConfigRequest$EncryptionAtRestOptions' => 'Encryption at rest options for the domain.
', ], ], 'EncryptionAtRestOptionsStatus' => [ 'base' => 'Status of the encryption at rest options for the specified OpenSearch Service domain.
', 'refs' => [ 'DomainConfig$EncryptionAtRestOptions' => 'Key-value pairs to enable encryption at rest.
', ], ], 'Endpoint' => [ 'base' => NULL, 'refs' => [ 'ConnectionProperties$Endpoint' => 'The Endpoint attribute cannot be modified.
The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.
', 'VpcEndpoint$Endpoint' => 'The connection endpoint ID for connecting to the domain.
', ], ], 'EndpointsMap' => [ 'base' => NULL, 'refs' => [ 'DomainStatus$Endpoints' => 'The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: \'vpc\',\'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com\'.
The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.
Filters the output by domain engine type.
', ], ], 'EnvironmentInfo' => [ 'base' => 'Information about the active domain environment.
', 'refs' => [ 'EnvironmentInfoList$member' => NULL, ], ], 'EnvironmentInfoList' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$EnvironmentInformation' => 'A list of EnvironmentInfo for the domain.
Additional information if the package is in an error state. Null otherwise.
', 'refs' => [ 'DomainPackageDetails$ErrorDetails' => 'Additional information if the package is in an error state. Null otherwise.
', 'PackageDetails$ErrorDetails' => 'Additional information if the package is in an error state. Null otherwise.
', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'BaseException$message' => 'A description of the error.
', 'ErrorDetails$ErrorMessage' => 'A message describing the error.
', ], ], 'ErrorType' => [ 'base' => NULL, 'refs' => [ 'ErrorDetails$ErrorType' => 'The type of error that occurred.
', ], ], 'Filter' => [ 'base' => 'A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
', 'refs' => [ 'FilterList$member' => NULL, ], ], 'FilterList' => [ 'base' => NULL, 'refs' => [ 'DescribeInboundConnectionsRequest$Filters' => 'A list of filters used to match properties for inbound cross-cluster connections.
', 'DescribeOutboundConnectionsRequest$Filters' => 'List of filter names and values that you can use for requests.
', ], ], 'GUID' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$ChangeId' => 'The ID of the configuration change.
', 'ChangeProgressStatusDetails$ChangeId' => 'The unique change identifier associated with a specific domain configuration change.
', 'DescribeDomainChangeProgressRequest$ChangeId' => 'The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.
', 'DescribeDryRunProgressRequest$DryRunId' => 'The unique identifier of the dry run.
', 'DescribeReservedInstanceOfferingsRequest$ReservedInstanceOfferingId' => 'The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.
', 'DescribeReservedInstancesRequest$ReservedInstanceId' => 'The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
', 'DryRunProgressStatus$DryRunId' => 'The unique identifier of the dry run.
', 'PurchaseReservedInstanceOfferingRequest$ReservedInstanceOfferingId' => 'The ID of the Reserved Instance offering to purchase.
', 'PurchaseReservedInstanceOfferingResponse$ReservedInstanceId' => 'The ID of the Reserved Instance offering that was purchased.
', 'ReservedInstance$ReservedInstanceId' => 'The unique identifier for the reservation.
', 'ReservedInstanceOffering$ReservedInstanceOfferingId' => 'The unique identifier of the Reserved Instance offering.
', ], ], 'GetCompatibleVersionsRequest' => [ 'base' => 'Container for the request parameters to GetCompatibleVersions operation.
Container for the response returned by the GetCompatibleVersions operation.
Container for the request parameters to the GetPackageVersionHistory operation.
Container for response returned by GetPackageVersionHistory operation.
Container for the request parameters to the GetUpgradeHistory operation.
Container for the response returned by the GetUpgradeHistory operation.
Container for the request parameters to the GetUpgradeStatus operation.
Container for the response returned by the GetUpgradeStatus operation.
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
', ], ], 'InboundConnection' => [ 'base' => 'Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.
', 'refs' => [ 'AcceptInboundConnectionResponse$Connection' => 'Information about the accepted inbound connection.
', 'DeleteInboundConnectionResponse$Connection' => 'The deleted inbound connection.
', 'InboundConnections$member' => NULL, 'RejectInboundConnectionResponse$Connection' => 'Contains details about the rejected inbound connection.
', ], ], 'InboundConnectionStatus' => [ 'base' => 'The status of an inbound cross-cluster connection for OpenSearch Service.
', 'refs' => [ 'InboundConnection$ConnectionStatus' => 'The current status of the connection.
', ], ], 'InboundConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'InboundConnectionStatus$StatusCode' => 'The status code for the connection. Can be one of the following:
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
PROVISIONING: Inbound connection is being provisioned.
ACTIVE: Inbound connection is active and ready to use.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and can no longer be used.
List of inbound connections.
', ], ], 'InstanceCount' => [ 'base' => 'Number of instances in an OpenSearch Service cluster.
', 'refs' => [ 'PurchaseReservedInstanceOfferingRequest$InstanceCount' => 'The number of OpenSearch instances to reserve.
', ], ], 'InstanceCountLimits' => [ 'base' => 'Limits on the number of instances that can be created in OpenSearch Service for a given instance type.
', 'refs' => [ 'InstanceLimits$InstanceCountLimits' => 'Limits on the number of instances that can be created for a given instance type.
', ], ], 'InstanceLimits' => [ 'base' => 'Instance-related attributes that are available for a given instance type.
', 'refs' => [ 'Limits$InstanceLimits' => 'The limits for a given instance type.
', ], ], 'InstanceRole' => [ 'base' => NULL, 'refs' => [ 'InstanceRoleList$member' => NULL, 'LimitsByRole$key' => NULL, ], ], 'InstanceRoleList' => [ 'base' => NULL, 'refs' => [ 'InstanceTypeDetails$InstanceRole' => 'Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.
', ], ], 'InstanceTypeDetails' => [ 'base' => 'Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
', 'refs' => [ 'InstanceTypeDetailsList$member' => NULL, ], ], 'InstanceTypeDetailsList' => [ 'base' => NULL, 'refs' => [ 'ListInstanceTypeDetailsResponse$InstanceTypeDetails' => 'Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.
', ], ], 'InstanceTypeString' => [ 'base' => NULL, 'refs' => [ 'ListInstanceTypeDetailsRequest$InstanceType' => 'An optional parameter that lists information for a given instance type.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$Duration' => 'The duration, in seconds, for which the OpenSearch instance is reserved.
', 'ReservedInstance$InstanceCount' => 'The number of OpenSearch instances that have been reserved.
', 'ReservedInstanceOffering$Duration' => 'The duration, in seconds, for which the offering will reserve the OpenSearch instance.
', ], ], 'IntegerClass' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$InstanceCount' => 'Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
', 'ClusterConfig$DedicatedMasterCount' => 'Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.
', 'ClusterConfig$WarmCount' => 'The number of warm nodes in the cluster.
', 'EBSOptions$VolumeSize' => 'Specifies the size (in GiB) of EBS volumes attached to data nodes.
', 'EBSOptions$Iops' => 'Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
', 'SAMLOptionsOutput$SessionTimeoutMinutes' => 'The duration, in minutes, after which a user session becomes inactive.
', 'SnapshotOptions$AutomatedSnapshotStartHour' => 'The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.
Request processing failed because of an unknown error, exception, or internal failure.
', 'refs' => [], ], 'InvalidPaginationTokenException' => [ 'base' => 'Request processing failed because you provided an invalid pagination token.
', 'refs' => [], ], 'InvalidTypeException' => [ 'base' => 'An exception for trying to create or access a sub-resource that\'s either invalid or not supported.
', 'refs' => [], ], 'Issue' => [ 'base' => NULL, 'refs' => [ 'Issues$member' => NULL, ], ], 'Issues' => [ 'base' => NULL, 'refs' => [ 'UpgradeStepItem$Issues' => 'A list of strings containing detailed information about the errors encountered in a particular step.
', ], ], 'KmsKeyId' => [ 'base' => NULL, 'refs' => [ 'EncryptionAtRestOptions$KmsKeyId' => 'The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.
The most recent updated timestamp of the stage.
', 'DomainPackageDetails$LastUpdated' => 'Timestamp of the most recent update to the package association status.
', 'PackageDetails$LastUpdatedAt' => 'Date and time when the package was last updated.
', ], ], 'LimitExceededException' => [ 'base' => 'An exception for trying to create more than the allowed number of resources or sub-resources.
', 'refs' => [], ], 'LimitName' => [ 'base' => NULL, 'refs' => [ 'AdditionalLimit$LimitName' => ' MaximumNumberOfDataNodesSupported - This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support.
MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.
Name of storage limits that are applicable for the given storage type. If StorageType is ebs, the following options are available:
MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
The values of the additional instance type limits.
', 'StorageTypeLimit$LimitValues' => 'The limit values.
', ], ], 'Limits' => [ 'base' => 'Limits for a given instance type and for each of its roles.
', 'refs' => [ 'LimitsByRole$value' => NULL, ], ], 'LimitsByRole' => [ 'base' => 'The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:
data - A data node.
master - A dedicated master node.
ultra_warm - An UltraWarm node.
Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.
Container for the parameters to the ListDomainNames operation.
The results of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.
Container for the request parameters to the ListDomainsForPackage operation.
Container for the response parameters to the ListDomainsForPackage operation.
Container for the request parameters to the ListPackagesForDomain operation.
Container for the response parameters to the ListPackagesForDomain operation.
Container for the parameters to the ListTags operation.
The results of a ListTags operation.
Container for the request parameters to the ListVersions operation.
Container for the parameters for response received from the ListVersions operation.
Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs.
After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.
Key-value pairs to configure log publishing.
', 'DomainStatus$LogPublishingOptions' => 'Log publishing options for the domain.
', 'LogPublishingOptionsStatus$Options' => 'The log publishing options configured for the domain.
', 'UpdateDomainConfigRequest$LogPublishingOptions' => 'Options to publish OpenSearch logs to Amazon CloudWatch Logs.
', ], ], 'LogPublishingOptionsStatus' => [ 'base' => 'The configured log publishing options for the domain and their current status.
', 'refs' => [ 'DomainConfig$LogPublishingOptions' => 'Key-value pairs to configure log publishing.
', ], ], 'LogType' => [ 'base' => 'The type of log file. Can be one of the following:
INDEX_SLOW_LOGS - Index slow logs contain insert requests that took more time than the configured index query log threshold to execute.
SEARCH_SLOW_LOGS - Search slow logs contain search queries that took more time than the configured search query log threshold to execute.
ES_APPLICATION_LOGS - OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
AUDIT_LOGS - Audit logs contain records of user requests for access to the domain.
The unique identifier of the billing subscription.
', 'ScheduledAction$ScheduledTime' => 'The time when the change is scheduled to happen.
', 'SlotList$member' => NULL, 'StartServiceSoftwareUpdateRequest$DesiredStartTime' => 'The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.
The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.
Indicates whether the domain has an elected master node.
Available - The domain has an elected master node.
UnAvailable - The master node hasn\'t yet been elected, and a quorum to elect a new master node hasn\'t been reached.
Credentials for the master user for a domain.
', 'refs' => [ 'AdvancedSecurityOptionsInput$MasterUserOptions' => 'Container for information about the master user.
', ], ], 'MaxResults' => [ 'base' => 'An optional parameter that specifies the maximum number of results to return for a given request.
', 'refs' => [ 'DescribeDomainAutoTunesRequest$MaxResults' => 'An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
Maximum number of instances that can be instantiated for a given instance type.
', 'refs' => [ 'InstanceCountLimits$MaximumInstanceCount' => 'The minimum allowed number of instances.
', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressDetails$Message' => 'A message corresponding to the status of the configuration change.
', 'DryRunResults$Message' => 'A message corresponding to the deployment type.
', ], ], 'MinimumInstanceCount' => [ 'base' => 'Minimum number of instances that can be instantiated for a given instance type.
', 'refs' => [ 'InstanceCountLimits$MinimumInstanceCount' => 'The maximum allowed number of instances.
', ], ], 'NextToken' => [ 'base' => 'When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.
If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.
If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.
If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.
If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.
If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.
If your initial ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The ID of the node.
', ], ], 'NodeStatus' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$NodeStatus' => 'Indicates if the node is active or in standby.
', ], ], 'NodeToNodeEncryptionOptions' => [ 'base' => 'Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.
', 'refs' => [ 'CreateDomainRequest$NodeToNodeEncryptionOptions' => 'Enables node-to-node encryption.
', 'DomainStatus$NodeToNodeEncryptionOptions' => 'Whether node-to-node encryption is enabled or disabled.
', 'NodeToNodeEncryptionOptionsStatus$Options' => 'The node-to-node encryption options for the specified domain.
', 'UpdateDomainConfigRequest$NodeToNodeEncryptionOptions' => 'Node-to-node encryption options for the domain.
', ], ], 'NodeToNodeEncryptionOptionsStatus' => [ 'base' => 'Status of the node-to-node encryption options for the specified domain.
', 'refs' => [ 'DomainConfig$NodeToNodeEncryptionOptions' => 'Whether node-to-node encryption is enabled or disabled.
', ], ], 'NodeType' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$NodeType' => 'Indicates whether the nodes is a data, master, or ultrawarm node.
', ], ], 'NonEmptyString' => [ 'base' => NULL, 'refs' => [ 'Filter$Name' => 'The name of the filter.
', 'ValueStringList$member' => NULL, ], ], 'NumberOfAZs' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainHealthResponse$AvailabilityZoneCount' => 'The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.
The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.
The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.
The total number of data nodes configured in the Availability Zone.
', 'AvailabilityZoneInfo$AvailableDataNodeCount' => 'The number of data nodes active in the Availability Zone.
', 'DescribeDomainHealthResponse$DataNodeCount' => 'The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.
The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return NotAvailable.
The number of warm nodes configured for the domain.
', ], ], 'NumberOfShards' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZoneInfo$TotalShards' => 'The total number of primary and replica shards in the Availability Zone.
', 'AvailabilityZoneInfo$TotalUnAssignedShards' => 'The total number of primary and replica shards that aren\'t allocated to any of the nodes in the Availability Zone.
', 'DescribeDomainHealthResponse$TotalShards' => 'The total number of primary and replica shards for the domain.
', 'DescribeDomainHealthResponse$TotalUnAssignedShards' => 'The total number of primary and replica shards not allocated to any of the nodes for the cluster.
', ], ], 'OffPeakWindow' => [ 'base' => 'A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify.
If you don\'t specify a window start time, it defaults to 10:00 P.M. local time.
For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service.
', 'refs' => [ 'OffPeakWindowOptions$OffPeakWindow' => 'Off-peak window settings for the domain.
', ], ], 'OffPeakWindowOptions' => [ 'base' => 'Options for a domain\'s off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
', 'refs' => [ 'CreateDomainRequest$OffPeakWindowOptions' => 'Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.
', 'DomainStatus$OffPeakWindowOptions' => 'Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
', 'OffPeakWindowOptionsStatus$Options' => 'The domain\'s off-peak window configuration.
', 'UpdateDomainConfigRequest$OffPeakWindowOptions' => 'Off-peak window options for the domain.
', ], ], 'OffPeakWindowOptionsStatus' => [ 'base' => 'The status of off-peak window options for a domain.
', 'refs' => [ 'DomainConfig$OffPeakWindowOptions' => 'Container for off-peak window options for the domain.
', ], ], 'OpenSearchPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$InstanceType' => 'Instance type of data nodes in the cluster.
', 'ClusterConfig$DedicatedMasterType' => 'OpenSearch Service instance type of the dedicated master nodes in the cluster.
', 'DescribeInstanceTypeLimitsRequest$InstanceType' => 'The OpenSearch Service instance type for which you need limit information.
', 'DomainNodesStatus$InstanceType' => 'The instance type information of the node.
', 'InstanceTypeDetails$InstanceType' => 'The instance type.
', 'ReservedInstance$InstanceType' => 'The OpenSearch instance type offered by theReserved Instance offering.
', 'ReservedInstanceOffering$InstanceType' => 'The OpenSearch instance type offered by the Reserved Instance offering.
', ], ], 'OpenSearchWarmPartitionInstanceType' => [ 'base' => NULL, 'refs' => [ 'ClusterConfig$WarmType' => 'The instance type for the cluster\'s warm nodes.
', ], ], 'OptionState' => [ 'base' => 'The state of a requested domain configuration change. Can be one of the following:
Processing - The requested change is still in progress.
Active - The requested change is processed and deployed to the domain.
The state of the entity.
', ], ], 'OptionStatus' => [ 'base' => 'Provides the current status of an entity.
', 'refs' => [ 'AccessPoliciesStatus$Status' => 'The status of the access policy for the domain.
', 'AdvancedOptionsStatus$Status' => 'The status of advanced options for the specified domain.
', 'AdvancedSecurityOptionsStatus$Status' => 'Status of the fine-grained access control settings for a domain.
', 'ClusterConfigStatus$Status' => 'The status of cluster configuration options for the specified domain.
', 'CognitoOptionsStatus$Status' => 'The status of the Cognito options for the specified domain.
', 'DomainEndpointOptionsStatus$Status' => 'The status of the endpoint options for a domain.
', 'EBSOptionsStatus$Status' => 'The status of the EBS options for the specified domain.
', 'EncryptionAtRestOptionsStatus$Status' => 'The status of the encryption at rest options for the specified domain.
', 'LogPublishingOptionsStatus$Status' => 'The status of the log publishing options for the domain.
', 'NodeToNodeEncryptionOptionsStatus$Status' => 'The status of the node-to-node encryption options for the specified domain.
', 'OffPeakWindowOptionsStatus$Status' => 'The current status of off-peak window options.
', 'SnapshotOptionsStatus$Status' => 'The status of a daily automated snapshot.
', 'SoftwareUpdateOptionsStatus$Status' => 'The status of service software update options, including creation date and last updated date.
', 'VPCDerivedInfoStatus$Status' => 'The status of the VPC options for the specified domain.
', 'VersionStatus$Status' => 'The status of the version options for the specified domain.
', ], ], 'OutboundConnection' => [ 'base' => 'Specifies details about an outbound cross-cluster connection.
', 'refs' => [ 'DeleteOutboundConnectionResponse$Connection' => 'The deleted inbound connection.
', 'OutboundConnections$member' => NULL, ], ], 'OutboundConnectionStatus' => [ 'base' => 'The status of an outbound cross-cluster connection.
', 'refs' => [ 'CreateOutboundConnectionResponse$ConnectionStatus' => 'The status of the connection.
', 'OutboundConnection$ConnectionStatus' => 'Status of the connection.
', ], ], 'OutboundConnectionStatusCode' => [ 'base' => NULL, 'refs' => [ 'OutboundConnectionStatus$StatusCode' => 'The status code for the outbound connection. Can be one of the following:
VALIDATING - The outbound connection request is being validated.
VALIDATION_FAILED - Validation failed for the connection request.
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
PROVISIONING - Outbound connection request is in process.
ACTIVE - Outbound connection is active and ready to use.
REJECTING - Outbound connection rejection by remote domain owner is in progress.
REJECTED - Outbound connection request is rejected by remote domain owner.
DELETING - Outbound connection deletion is in progress.
DELETED - Outbound connection is deleted and can no longer be used.
List of outbound connections that match the filter criteria.
', ], ], 'OverallChangeStatus' => [ 'base' => 'The overall status value of the domain configuration change.
', 'refs' => [ 'ChangeProgressStatusDetails$Status' => 'The overall status of the domain configuration change.
', ], ], 'OwnerId' => [ 'base' => NULL, 'refs' => [ 'AWSDomainInformation$OwnerId' => 'The Amazon Web Services account ID of the domain owner.
', ], ], 'PackageDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageDescription' => 'Description of the package.
', 'PackageDetails$PackageDescription' => 'User-specified description of the package.
', 'UpdatePackageRequest$PackageDescription' => 'A new description of the package.
', ], ], 'PackageDetails' => [ 'base' => 'Basic information about a package.
', 'refs' => [ 'CreatePackageResponse$PackageDetails' => 'Basic information about an OpenSearch Service package.
', 'DeletePackageResponse$PackageDetails' => 'Information about the deleted package.
', 'PackageDetailsList$member' => NULL, 'UpdatePackageResponse$PackageDetails' => 'Information about a package.
', ], ], 'PackageDetailsList' => [ 'base' => NULL, 'refs' => [ 'DescribePackagesResponse$PackageDetailsList' => 'Basic information about a package.
', ], ], 'PackageID' => [ 'base' => NULL, 'refs' => [ 'AssociatePackageRequest$PackageID' => 'Internal ID of the package to associate with a domain. Use DescribePackages to find this value.
The internal ID of the package you want to delete. Use DescribePackages to find this value.
Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.
Internal ID of the package.
', 'GetPackageVersionHistoryRequest$PackageID' => 'The unique identifier of the package.
', 'GetPackageVersionHistoryResponse$PackageID' => 'The unique identifier of the package.
', 'ListDomainsForPackageRequest$PackageID' => 'The unique identifier of the package for which to list associated domains.
', 'PackageDetails$PackageID' => 'The unique identifier of the package.
', 'UpdatePackageRequest$PackageID' => 'The unique identifier for the package.
', ], ], 'PackageName' => [ 'base' => NULL, 'refs' => [ 'CreatePackageRequest$PackageName' => 'Unique name for the package.
', 'DomainPackageDetails$PackageName' => 'User-specified name of the package.
', 'PackageDetails$PackageName' => 'The user-specified name of the package.
', ], ], 'PackageSource' => [ 'base' => 'The Amazon S3 location to import the package from.
', 'refs' => [ 'CreatePackageRequest$PackageSource' => 'The Amazon S3 location from which to import the package.
', 'UpdatePackageRequest$PackageSource' => 'Amazon S3 bucket and key for the package.
', ], ], 'PackageStatus' => [ 'base' => NULL, 'refs' => [ 'PackageDetails$PackageStatus' => 'The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.
The type of package.
', 'DomainPackageDetails$PackageType' => 'The type of package.
', 'PackageDetails$PackageType' => 'The type of package.
', ], ], 'PackageVersion' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$PackageVersion' => 'The current version of the package.
', 'PackageDetails$AvailablePackageVersion' => 'The package version.
', 'PackageVersionHistory$PackageVersion' => 'The package version.
', ], ], 'PackageVersionHistory' => [ 'base' => 'Details about a package version.
', 'refs' => [ 'PackageVersionHistoryList$member' => NULL, ], ], 'PackageVersionHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetPackageVersionHistoryResponse$PackageVersionHistoryList' => 'A list of package versions, along with their creation time and commit message.
', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserPassword' => 'Password for the master user. Only specify if InternalUserDatabaseEnabled is true.
Access policy rules for an Amazon OpenSearch Service domain endpoint. For more information, see Configuring access policies. The maximum size of a policy document is 100 KB.
', 'refs' => [ 'AccessPoliciesStatus$Options' => 'The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.
', 'CreateDomainRequest$AccessPolicies' => 'Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
', 'DomainStatus$AccessPolicies' => 'Identity and Access Management (IAM) policy document specifying the access policies for the domain.
', 'UpdateDomainConfigRequest$AccessPolicies' => 'Identity and Access Management (IAM) access policy as a JSON-formatted string.
', ], ], 'PrincipalType' => [ 'base' => NULL, 'refs' => [ 'AuthorizedPrincipal$PrincipalType' => 'The type of principal.
', ], ], 'PurchaseReservedInstanceOfferingRequest' => [ 'base' => 'Container for request parameters to the PurchaseReservedInstanceOffering operation.
Represents the output of a PurchaseReservedInstanceOffering operation.
Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.
', 'refs' => [ 'RecurringChargeList$member' => NULL, ], ], 'RecurringChargeList' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$RecurringCharges' => 'The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.
', 'ReservedInstanceOffering$RecurringCharges' => 'The recurring charge to your account, regardless of whether you creates any domains using the offering.
', ], ], 'ReferencePath' => [ 'base' => NULL, 'refs' => [ 'DomainPackageDetails$ReferencePath' => 'The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
The Amazon Web Services Region in which the domain is located.
', ], ], 'RejectInboundConnectionRequest' => [ 'base' => 'Container for the request parameters to the RejectInboundConnection operation.
Represents the output of a RejectInboundConnection operation.
Container for the request parameters to the RemoveTags operation.
A customer-specified identifier to track this reservation.
', 'PurchaseReservedInstanceOfferingResponse$ReservationName' => 'The customer-specified identifier used to track this reservation.
', 'ReservedInstance$ReservationName' => 'The customer-specified identifier to track this reservation.
', ], ], 'ReservedInstance' => [ 'base' => 'Details of an OpenSearch Reserved Instance.
', 'refs' => [ 'ReservedInstanceList$member' => NULL, ], ], 'ReservedInstanceList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedInstancesResponse$ReservedInstances' => 'List of Reserved Instances in the current Region.
', ], ], 'ReservedInstanceOffering' => [ 'base' => 'Details of an OpenSearch Reserved Instance offering.
', 'refs' => [ 'ReservedInstanceOfferingList$member' => NULL, ], ], 'ReservedInstanceOfferingList' => [ 'base' => NULL, 'refs' => [ 'DescribeReservedInstanceOfferingsResponse$ReservedInstanceOfferings' => 'List of Reserved Instance offerings.
', ], ], 'ReservedInstancePaymentOption' => [ 'base' => NULL, 'refs' => [ 'ReservedInstance$PaymentOption' => 'The payment option as defined in the Reserved Instance offering.
', 'ReservedInstanceOffering$PaymentOption' => 'Payment option for the Reserved Instance offering
', ], ], 'ResourceAlreadyExistsException' => [ 'base' => 'An exception for creating a resource that already exists.
', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'An exception for accessing or deleting a resource that doesn\'t exist.
', 'refs' => [], ], 'RevokeVpcEndpointAccessRequest' => [ 'base' => NULL, 'refs' => [], ], 'RevokeVpcEndpointAccessResponse' => [ 'base' => NULL, 'refs' => [], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$RoleArn' => 'The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.
The rollback state while disabling Auto-Tune for the domain.
', 'refs' => [ 'AutoTuneOptions$RollbackOnDisable' => 'When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.
The name of the Amazon S3 bucket containing the package.
', ], ], 'S3Key' => [ 'base' => NULL, 'refs' => [ 'PackageSource$S3Key' => 'Key (file name) of the package.
', ], ], 'SAMLEntityId' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$EntityId' => 'The unique entity ID of the application in the SAML identity provider.
', ], ], 'SAMLIdp' => [ 'base' => 'The SAML identity povider information.
', 'refs' => [ 'SAMLOptionsInput$Idp' => 'The SAML Identity Provider\'s information.
', 'SAMLOptionsOutput$Idp' => 'Describes the SAML identity provider\'s information.
', ], ], 'SAMLMetadata' => [ 'base' => NULL, 'refs' => [ 'SAMLIdp$MetadataContent' => 'The metadata of the SAML application, in XML format.
', ], ], 'SAMLOptionsInput' => [ 'base' => 'The SAML authentication configuration for an Amazon OpenSearch Service domain.
', 'refs' => [ 'AdvancedSecurityOptionsInput$SAMLOptions' => 'Container for information about the SAML configuration for OpenSearch Dashboards.
', ], ], 'SAMLOptionsOutput' => [ 'base' => 'Describes the SAML application configured for the domain.
', 'refs' => [ 'AdvancedSecurityOptions$SAMLOptions' => 'Container for information about the SAML configuration for OpenSearch Dashboards.
', ], ], 'ScheduleAt' => [ 'base' => NULL, 'refs' => [ 'StartServiceSoftwareUpdateRequest$ScheduleAt' => 'When to start the service software update.
NOW - Immediately schedules the update to happen in the current hour if there\'s capacity available.
TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.
OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There\'s no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.
Default: NOW if you don\'t specify a value for DesiredStartTime, and TIMESTAMP if you do.
When to schedule the action.
NOW - Immediately schedules the update to happen in the current hour if there\'s capacity available.
TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.
OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There\'s no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.
Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.
', 'refs' => [ 'ScheduledActionsList$member' => NULL, 'UpdateScheduledActionResponse$ScheduledAction' => 'Information about the rescheduled action.
', ], ], 'ScheduledActionsList' => [ 'base' => NULL, 'refs' => [ 'ListScheduledActionsResponse$ScheduledActions' => 'A list of actions that are scheduled for the domain.
', ], ], 'ScheduledAutoTuneActionType' => [ 'base' => 'The Auto-Tune action type.
', 'refs' => [ 'ScheduledAutoTuneDetails$ActionType' => 'The type of Auto-Tune action.
', ], ], 'ScheduledAutoTuneDescription' => [ 'base' => 'The description of an Auto-Tune maintenance action that occurs on a domain.
', 'refs' => [ 'ScheduledAutoTuneDetails$Action' => 'A description of the Auto-Tune action.
', ], ], 'ScheduledAutoTuneDetails' => [ 'base' => 'Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
', 'refs' => [ 'AutoTuneDetails$ScheduledAutoTuneDetails' => 'Container for details about a scheduled Auto-Tune action.
', ], ], 'ScheduledAutoTuneSeverityType' => [ 'base' => 'The Auto-Tune action severity.
', 'refs' => [ 'ScheduledAutoTuneDetails$Severity' => 'The severity of the Auto-Tune action. Valid values are LOW, MEDIUM, and HIGH.
Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).
The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
', 'refs' => [ 'CancelServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => 'Container for the state of your domain relative to the latest service software.
', 'DomainStatus$ServiceSoftwareOptions' => 'The current status of the domain\'s service software.
', 'StartServiceSoftwareUpdateResponse$ServiceSoftwareOptions' => 'The current status of the OpenSearch Service software update.
', ], ], 'ServiceUrl' => [ 'base' => 'The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.
Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
', 'EndpointsMap$value' => NULL, ], ], 'SkipUnavailableStatus' => [ 'base' => 'Status of SkipUnavailable param for outbound connection.
ENABLED - The SkipUnavailable param is enabled for the connection.
DISABLED - The SkipUnavailable param is disabled for the connection.
Status of SkipUnavailable param for outbound connection.
', ], ], 'SlotList' => [ 'base' => NULL, 'refs' => [ 'SlotNotAvailableException$SlotSuggestions' => 'Alternate time slots during which OpenSearch Service has available capacity to schedule a domain action.
', ], ], 'SlotNotAvailableException' => [ 'base' => 'An exception for attempting to schedule a domain action during an unavailable time slot.
', 'refs' => [], ], 'SnapshotOptions' => [ 'base' => 'The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
', 'DomainStatus$SnapshotOptions' => 'DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
', 'SnapshotOptionsStatus$Options' => 'The daily snapshot options specified for the domain.
', 'UpdateDomainConfigRequest$SnapshotOptions' => 'Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
Container for information about a daily automated snapshot for an OpenSearch Service domain.
', 'refs' => [ 'DomainConfig$SnapshotOptions' => 'DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
', ], ], 'SoftwareUpdateOptions' => [ 'base' => 'Options for configuring service software updates for a domain.
', 'refs' => [ 'CreateDomainRequest$SoftwareUpdateOptions' => 'Software update options for the domain.
', 'DomainStatus$SoftwareUpdateOptions' => 'Service software update options for the domain.
', 'SoftwareUpdateOptionsStatus$Options' => 'The service software update options for a domain.
', 'UpdateDomainConfigRequest$SoftwareUpdateOptions' => 'Service software update options for the domain.
', ], ], 'SoftwareUpdateOptionsStatus' => [ 'base' => 'The status of the service software options for a domain.
', 'refs' => [ 'DomainConfig$SoftwareUpdateOptions' => 'Software update options for the domain.
', ], ], 'StartAt' => [ 'base' => NULL, 'refs' => [ 'AutoTuneMaintenanceSchedule$StartAt' => 'The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
', ], ], 'StartServiceSoftwareUpdateRequest' => [ 'base' => 'Container for the request parameters to the StartServiceSoftwareUpdate operation.
Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.
The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.
The start minute of the window, in UTC.
', ], ], 'StartTimestamp' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StartTimestamp' => 'UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.
Sub-type of the given EBS storage type. List of available sub-storage options. The instance storage type has no storage sub-type. The ebs storage type has the following valid sub-types:
standard
gp2
gp3
io1
The storage sub-type, such as gp3 or io1.
A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.
', 'refs' => [ 'StorageTypeList$member' => NULL, ], ], 'StorageTypeLimit' => [ 'base' => 'Limits that are applicable for the given Amazon OpenSearch Service storage type.
', 'refs' => [ 'StorageTypeLimitList$member' => NULL, ], ], 'StorageTypeLimitList' => [ 'base' => NULL, 'refs' => [ 'StorageType$StorageTypeLimits' => 'Limits that are applicable for the given storage type.
', ], ], 'StorageTypeList' => [ 'base' => NULL, 'refs' => [ 'Limits$StorageTypes' => 'Storage-related attributes that are available for a given instance type.
', ], ], 'StorageTypeName' => [ 'base' => 'The type of storage that the domain uses. Can be one of the following:
Built-in storage available for the instance.
Elastic Block Storage (EBS) attached to the instance.
Indicates if the node has EBS or instance storage.
', 'StorageType$StorageTypeName' => 'The name of the storage type.
', ], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AdvancedOptions$key' => NULL, 'AdvancedOptions$value' => NULL, 'AuthorizedPrincipal$Principal' => 'The IAM principal that is allowed access to the domain.
', 'AutoTuneMaintenanceSchedule$CronExpressionForRecurrence' => 'A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
', 'AutoTuneOptionsOutput$ErrorMessage' => 'Any errors that occurred while enabling or disabling Auto-Tune.
', 'AutoTuneStatus$ErrorMessage' => 'Any errors that occurred while enabling or disabling Auto-Tune.
', 'DescribePackagesResponse$NextToken' => 'When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The current status of the dry run.
', 'DryRunProgressStatus$CreationDate' => 'The timestamp when the dry run was initiated.
', 'DryRunProgressStatus$UpdateDate' => 'The timestamp when the dry run was last updated.
', 'EndpointsMap$key' => NULL, 'GetPackageVersionHistoryResponse$NextToken' => 'When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
The frequency of the recurring charge.
', 'ReservedInstance$ReservedInstanceOfferingId' => 'The unique identifier of the Reserved Instance offering.
', 'ReservedInstance$CurrencyCode' => 'The currency code for the offering.
', 'ReservedInstance$State' => 'The state of the Reserved Instance.
', 'ReservedInstanceOffering$CurrencyCode' => 'The currency code for the Reserved Instance offering.
', 'SAMLOptionsInput$SubjectKey' => 'Element of the SAML assertion to use for the user name. Default is NameID.
Element of the SAML assertion to use for backend roles. Default is roles.
The key used for matching the SAML subject attribute.
', 'SAMLOptionsOutput$RolesKey' => 'The key used for matching the SAML roles attribute.
', 'ScheduledAction$Id' => 'The unique identifier of the scheduled action.
', 'ScheduledAction$Description' => 'A description of the action to be taken.
', 'ServiceSoftwareOptions$CurrentVersion' => 'The current service software version present on the domain.
', 'ServiceSoftwareOptions$NewVersion' => 'The new service software version, if one is available.
', 'ServiceSoftwareOptions$Description' => 'A description of the service software update status.
', 'StringList$member' => NULL, 'UpdateScheduledActionRequest$ActionID' => 'The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.
', 'UpgradeDomainResponse$UpgradeId' => 'The unique identifier of the domain upgrade.
', 'VPCDerivedInfo$VPCId' => 'The ID for your VPC. Amazon VPC generates this value when you create a VPC.
', 'ValidationFailure$Code' => 'The error code of the failure.
', 'ValidationFailure$Message' => 'A message corresponding to the failure.
', 'VpcEndpointError$ErrorMessage' => 'A message describing the error.
', 'VpcEndpointSummary$VpcEndpointOwner' => 'The creator of the endpoint.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$PendingProperties' => 'The list of properties in the domain configuration change that are still pending.
', 'ChangeProgressStatusDetails$CompletedProperties' => 'The list of properties in the domain configuration change that have completed.
', 'RemoveTagsRequest$TagKeys' => 'The list of tag keys to remove from the domain.
', 'VPCDerivedInfo$SubnetIds' => 'A list of subnet IDs associated with the VPC endpoints for the domain.
', 'VPCDerivedInfo$AvailabilityZones' => 'The list of Availability Zones associated with the VPC subnets.
', 'VPCDerivedInfo$SecurityGroupIds' => 'The list of security group IDs associated with the VPC endpoints for the domain.
', 'VPCOptions$SubnetIds' => 'A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.
', 'VPCOptions$SecurityGroupIds' => 'The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.
', ], ], 'TLSSecurityPolicy' => [ 'base' => NULL, 'refs' => [ 'DomainEndpointOptions$TLSSecurityPolicy' => 'Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2
A tag (key-value pair) for an Amazon OpenSearch Service resource.
', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => 'A string between 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they\'re attached.
', 'refs' => [ 'Tag$Key' => 'The tag key. Tag keys must be unique for the domain to which they are attached.
', ], ], 'TagList' => [ 'base' => 'A list of tags attached to a domain.
', 'refs' => [ 'AddTagsRequest$TagList' => 'List of resource tags.
', 'CreateDomainRequest$TagList' => 'List of tags to add to the domain upon creation.
', 'ListTagsResponse$TagList' => 'List of resource tags associated with the specified domain.
', ], ], 'TagValue' => [ 'base' => 'A string between 0 to 256 characters that specifies the value for a tag. Tag values can be null and don\'t have to be unique in a tag set.
', 'refs' => [ 'Tag$Value' => 'The value assigned to the corresponding tag key. Tag values can be null and don\'t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
The unit of a maintenance schedule duration. Valid value is HOUR.
The unit of measurement for the duration of a maintenance schedule.
', ], ], 'TotalNumberOfStages' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatusDetails$TotalNumberOfStages' => 'The total number of stages required for the configuration change.
', ], ], 'UIntValue' => [ 'base' => NULL, 'refs' => [ 'AutoTuneStatus$UpdateVersion' => 'The latest version of the Auto-Tune options.
', 'OptionStatus$UpdateVersion' => 'The latest version of the entity.
', ], ], 'UpdateDomainConfigRequest' => [ 'base' => 'Container for the request parameters to the UpdateDomain operation.
The results of an UpdateDomain request. Contains the status of the domain being updated.
Container for request parameters to the UpdatePackage operation.
Container for the response returned by the UpdatePackage operation.
Date and time when Auto-Tune was enabled for the domain.
', 'AutoTuneStatus$UpdateDate' => 'Date and time when the Auto-Tune options were last updated for the domain.
', 'ChangeProgressStatusDetails$StartTime' => 'The time at which the configuration change is made on the domain.
', 'OptionStatus$CreationDate' => 'The timestamp when the entity was created.
', 'OptionStatus$UpdateDate' => 'The timestamp of the last time the entity was updated.
', 'ReservedInstance$StartTime' => 'The date and time when the reservation was purchased.
', ], ], 'UpdateVpcEndpointRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVpcEndpointResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpgradeDomainRequest' => [ 'base' => 'Container for the request parameters to the UpgradeDomain operation.
Container for the response returned by UpgradeDomain operation.
History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.
', 'refs' => [ 'UpgradeHistoryList$member' => NULL, ], ], 'UpgradeHistoryList' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeHistoryResponse$UpgradeHistories' => 'A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.
', ], ], 'UpgradeName' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$UpgradeName' => 'A string that describes the update.
', 'UpgradeHistory$UpgradeName' => 'A string that describes the upgrade.
', ], ], 'UpgradeStatus' => [ 'base' => NULL, 'refs' => [ 'GetUpgradeStatusResponse$StepStatus' => 'The status of the current step that an upgrade is on.
', 'UpgradeHistory$UpgradeStatus' => 'The current status of the upgrade. The status can take one of the following values:
In Progress
Succeeded
Succeeded with Issues
Failed
The current status of the upgrade. The status can take one of the following values:
In Progress
Succeeded
Succeeded with Issues
Failed
One of three steps that an upgrade or upgrade eligibility check goes through.
', 'UpgradeStepItem$UpgradeStep' => 'One of three steps that an upgrade or upgrade eligibility check goes through:
PreUpgradeCheck
Snapshot
Upgrade
Represents a single step of an upgrade or upgrade eligibility check workflow.
', 'refs' => [ 'UpgradeStepsList$member' => NULL, ], ], 'UpgradeStepsList' => [ 'base' => NULL, 'refs' => [ 'UpgradeHistory$StepsList' => 'A list of each step performed as part of a specific upgrade or upgrade eligibility check.
', ], ], 'UserPoolId' => [ 'base' => NULL, 'refs' => [ 'CognitoOptions$UserPoolId' => 'The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
', ], ], 'Username' => [ 'base' => NULL, 'refs' => [ 'MasterUserOptions$MasterUserName' => 'User name for the master user. Only specify if InternalUserDatabaseEnabled is true.
The SAML master user name, which is stored in the domain\'s internal user database.
', ], ], 'VPCDerivedInfo' => [ 'base' => 'Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC). For more information, see Launching your Amazon OpenSearch Service domains using a VPC. This information only exists if the domain was created with VPCOptions.
The VPC configuration for the domain.
', 'VPCDerivedInfoStatus$Options' => 'The VPC options for the specified domain.
', 'VpcEndpoint$VpcOptions' => 'Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
', ], ], 'VPCDerivedInfoStatus' => [ 'base' => 'Status of the VPC options for a specified domain.
', 'refs' => [ 'DomainConfig$VPCOptions' => 'The current VPC options for the domain and the status of any updates to their configuration.
', ], ], 'VPCOptions' => [ 'base' => 'Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
', 'refs' => [ 'CreateDomainRequest$VPCOptions' => 'Container for the values required to configure VPC access domains. If you don\'t specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
', 'CreateVpcEndpointRequest$VpcOptions' => 'Options to specify the subnets and security groups for the endpoint.
', 'UpdateDomainConfigRequest$VPCOptions' => 'Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
', 'UpdateVpcEndpointRequest$VpcOptions' => 'The security groups and/or subnets to add, remove, or modify.
', ], ], 'ValidationException' => [ 'base' => 'An exception for accessing or deleting a resource that doesn\'t exist.
', 'refs' => [], ], 'ValidationFailure' => [ 'base' => 'A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.
', 'refs' => [ 'ValidationFailures$member' => NULL, ], ], 'ValidationFailures' => [ 'base' => NULL, 'refs' => [ 'DryRunProgressStatus$ValidationFailures' => 'Any validation failures that occurred as a result of the dry run.
', ], ], 'ValueStringList' => [ 'base' => NULL, 'refs' => [ 'Filter$Values' => 'One or more values for the filter.
', ], ], 'VersionList' => [ 'base' => 'List of supported OpenSearch versions.
', 'refs' => [ 'CompatibleVersionsMap$TargetVersions' => 'The possible versions that you can upgrade the domain to.
', 'ListVersionsResponse$Versions' => 'A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
', ], ], 'VersionStatus' => [ 'base' => 'The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.
', 'refs' => [ 'DomainConfig$EngineVersion' => 'The OpenSearch or Elasticsearch version that the domain is running.
', ], ], 'VersionString' => [ 'base' => NULL, 'refs' => [ 'CompatibleVersionsMap$SourceVersion' => 'The current version that the OpenSearch Service domain is running.
', 'CreateDomainRequest$EngineVersion' => 'String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
', 'DomainStatus$EngineVersion' => 'Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
', 'UpgradeDomainRequest$TargetVersion' => 'OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.
', 'UpgradeDomainResponse$TargetVersion' => 'OpenSearch or Elasticsearch version that the domain was upgraded to.
', 'VersionList$member' => NULL, 'VersionStatus$Options' => 'The OpenSearch or Elasticsearch version for the specified domain.
', ], ], 'VolumeSize' => [ 'base' => NULL, 'refs' => [ 'DomainNodesStatus$StorageSize' => 'The storage size of the node, in GiB.
', ], ], 'VolumeType' => [ 'base' => 'The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage.
', 'refs' => [ 'DomainNodesStatus$StorageVolumeType' => 'If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable for data nodes.
', 'EBSOptions$VolumeType' => 'Specifies the type of EBS volumes attached to data nodes.
', ], ], 'VpcEndpoint' => [ 'base' => 'The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
', 'refs' => [ 'CreateVpcEndpointResponse$VpcEndpoint' => 'Information about the newly created VPC endpoint.
', 'UpdateVpcEndpointResponse$VpcEndpoint' => 'The endpoint to be updated.
', 'VpcEndpoints$member' => NULL, ], ], 'VpcEndpointError' => [ 'base' => 'Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
', 'refs' => [ 'VpcEndpointErrorList$member' => NULL, ], ], 'VpcEndpointErrorCode' => [ 'base' => NULL, 'refs' => [ 'VpcEndpointError$ErrorCode' => 'The code associated with the error.
', ], ], 'VpcEndpointErrorList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpointErrors' => 'Any errors associated with the request.
', ], ], 'VpcEndpointId' => [ 'base' => NULL, 'refs' => [ 'DeleteVpcEndpointRequest$VpcEndpointId' => 'The unique identifier of the endpoint.
', 'UpdateVpcEndpointRequest$VpcEndpointId' => 'The unique identifier of the endpoint.
', 'VpcEndpoint$VpcEndpointId' => 'The unique identifier of the endpoint.
', 'VpcEndpointError$VpcEndpointId' => 'The unique identifier of the endpoint.
', 'VpcEndpointIdList$member' => NULL, 'VpcEndpointSummary$VpcEndpointId' => 'The unique identifier of the endpoint.
', ], ], 'VpcEndpointIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsRequest$VpcEndpointIds' => 'The unique identifiers of the endpoints to get information about.
', ], ], 'VpcEndpointStatus' => [ 'base' => NULL, 'refs' => [ 'VpcEndpoint$Status' => 'The current status of the endpoint.
', 'VpcEndpointSummary$Status' => 'The current status of the endpoint.
', ], ], 'VpcEndpointSummary' => [ 'base' => 'Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
', 'refs' => [ 'DeleteVpcEndpointResponse$VpcEndpointSummary' => 'Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).
Information about each endpoint associated with the domain.
', 'ListVpcEndpointsResponse$VpcEndpointSummaryList' => 'Information about each endpoint.
', ], ], 'VpcEndpoints' => [ 'base' => NULL, 'refs' => [ 'DescribeVpcEndpointsResponse$VpcEndpoints' => 'Information about each requested VPC endpoint.
', ], ], 'WindowStartTime' => [ 'base' => 'The desired start time for an off-peak maintenance window.
', 'refs' => [ 'OffPeakWindow$WindowStartTime' => 'A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can\'t specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
', ], ], 'ZoneAwarenessConfig' => [ 'base' => 'The zone awareness configuration for an Amazon OpenSearch Service domain.
', 'refs' => [ 'ClusterConfig$ZoneAwarenessConfig' => 'Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.
The current state of the Availability Zone. Current options are Active and StandBy.
Active - Data nodes in the Availability Zone are in use.
StandBy - Data nodes in the Availability Zone are in a standby state.
NotAvailable - Unable to retrieve information.