| Class | Description |
|---|---|
| AcceptInboundConnectionRequest |
Container for the parameters to the
AcceptInboundConnection operation. |
| AcceptInboundConnectionResponse |
Contains details about the accepted inbound connection.
|
| AccessPoliciesStatus |
The configured access rules for the domain's search endpoint, and the current status of those rules.
|
| AdditionalLimit |
List of limits that are specific to a given instance type.
|
| AddTagsRequest |
Container for the parameters to the
AddTags operation. |
| AddTagsResponse | |
| AdvancedOptionsStatus |
Status of the advanced options for the specified domain.
|
| AdvancedSecurityOptions |
Container for fine-grained access control settings.
|
| AdvancedSecurityOptionsInput |
Options for enabling and configuring fine-grained access control.
|
| AdvancedSecurityOptionsStatus |
The status of fine-grained access control settings for a domain.
|
| AssociatePackageRequest |
Container for the request parameters to the
AssociatePackage operation. |
| AssociatePackageResponse |
Container for the response returned by the
AssociatePackage operation. |
| AuthorizedPrincipal |
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.
|
| AuthorizeVpcEndpointAccessRequest | |
| AuthorizeVpcEndpointAccessResponse | |
| AutoTune |
Information about an Auto-Tune action.
|
| AutoTuneDetails |
Specifies details about a scheduled Auto-Tune action.
|
| AutoTuneMaintenanceSchedule |
|
| AutoTuneOptions |
Auto-Tune settings when updating a domain.
|
| AutoTuneOptionsInput |
Options for configuring Auto-Tune.
|
| AutoTuneOptionsOutput |
The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.
|
| AutoTuneOptionsStatus |
The Auto-Tune status for the domain.
|
| AutoTuneStatus |
The current status of Auto-Tune for the domain.
|
| AvailabilityZoneInfo |
Information about an Availability Zone on a domain.
|
| AWSDomainInformation |
Information about an Amazon OpenSearch Service domain.
|
| CancelServiceSoftwareUpdateRequest |
Container for the request parameters to cancel a service software update.
|
| CancelServiceSoftwareUpdateResponse |
Container for the response to a
CancelServiceSoftwareUpdate operation. |
| ChangeProgressDetails |
Container for information about a configuration change happening on a domain.
|
| ChangeProgressStage |
Progress details for each stage of a domain update.
|
| ChangeProgressStatusDetails |
The progress details of a specific domain configuration change.
|
| ClusterConfig |
Container for the cluster configuration of an OpenSearch Service domain.
|
| ClusterConfigStatus |
The cluster configuration status for a domain.
|
| CognitoOptions |
Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain.
|
| CognitoOptionsStatus |
The status of the Cognito options for the specified domain.
|
| ColdStorageOptions |
Container for the parameters required to enable cold storage for an OpenSearch Service domain.
|
| CompatibleVersionsMap |
A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
|
| ConnectionProperties |
The connection properties of an outbound connection.
|
| CreateDomainRequest | |
| CreateDomainResponse |
The result of a
CreateDomain operation. |
| CreateOutboundConnectionRequest |
Container for the parameters to the
CreateOutboundConnection operation. |
| CreateOutboundConnectionResponse |
The result of a
CreateOutboundConnection request. |
| CreatePackageRequest |
Container for request parameters to the
CreatePackage operation. |
| CreatePackageResponse |
Container for the response returned by the
CreatePackage operation. |
| CreateVpcEndpointRequest | |
| CreateVpcEndpointResponse | |
| CrossClusterSearchConnectionProperties |
Cross cluster search specific connection properties.
|
| DeleteDomainRequest |
Container for the parameters to the
DeleteDomain operation. |
| DeleteDomainResponse |
The results of a
DeleteDomain request. |
| DeleteInboundConnectionRequest |
Container for the parameters to the
DeleteInboundConnection operation. |
| DeleteInboundConnectionResponse |
The results of a
DeleteInboundConnection operation. |
| DeleteOutboundConnectionRequest |
Container for the parameters to the
DeleteOutboundConnection operation. |
| DeleteOutboundConnectionResponse |
Details about the deleted outbound connection.
|
| DeletePackageRequest |
Deletes a package from OpenSearch Service.
|
| DeletePackageResponse |
Container for the response parameters to the
DeletePackage operation. |
| DeleteVpcEndpointRequest | |
| DeleteVpcEndpointResponse | |
| DescribeDomainAutoTunesRequest |
Container for the parameters to the
DescribeDomainAutoTunes operation. |
| DescribeDomainAutoTunesResponse |
The result of a
DescribeDomainAutoTunes request. |
| DescribeDomainChangeProgressRequest |
Container for the parameters to the
DescribeDomainChangeProgress operation. |
| DescribeDomainChangeProgressResponse |
The result of a
DescribeDomainChangeProgress request. |
| DescribeDomainConfigRequest |
Container for the parameters to the
DescribeDomainConfig operation. |
| DescribeDomainConfigResponse |
Contains the configuration information of the requested domain.
|
| DescribeDomainHealthRequest |
Container for the parameters to the
DescribeDomainHealth operation. |
| DescribeDomainHealthResponse |
The result of a
DescribeDomainHealth request. |
| DescribeDomainNodesRequest |
Container for the parameters to the
DescribeDomainNodes operation. |
| DescribeDomainNodesResponse |
The result of a
DescribeDomainNodes request. |
| DescribeDomainRequest |
Container for the parameters to the
DescribeDomain operation. |
| DescribeDomainResponse |
Contains the status of the domain specified in the request.
|
| DescribeDomainsRequest |
Container for the parameters to the
DescribeDomains operation. |
| DescribeDomainsResponse |
Contains the status of the specified domains or all domains owned by the account.
|
| DescribeDryRunProgressRequest | |
| DescribeDryRunProgressResponse | |
| DescribeInboundConnectionsRequest |
Container for the parameters to the
DescribeInboundConnections operation. |
| DescribeInboundConnectionsResponse |
Contains a list of connections matching the filter criteria.
|
| DescribeInstanceTypeLimitsRequest |
Container for the parameters to the
DescribeInstanceTypeLimits operation. |
| DescribeInstanceTypeLimitsResponse |
Container for the parameters received from the
DescribeInstanceTypeLimits operation. |
| DescribeOutboundConnectionsRequest |
Container for the parameters to the
DescribeOutboundConnections operation. |
| DescribeOutboundConnectionsResponse |
Contains a list of connections matching the filter criteria.
|
| DescribePackagesFilter |
A filter to apply to the
DescribePackage response. |
| DescribePackagesRequest |
Container for the request parameters to the
DescribePackage operation. |
| DescribePackagesResponse |
Container for the response returned by the
DescribePackages operation. |
| DescribeReservedInstanceOfferingsRequest |
Container for the request parameters to a
DescribeReservedInstanceOfferings operation. |
| DescribeReservedInstanceOfferingsResponse |
Container for results of a
DescribeReservedInstanceOfferings request. |
| DescribeReservedInstancesRequest |
Container for the request parameters to the
DescribeReservedInstances operation. |
| DescribeReservedInstancesResponse |
Container for results from
DescribeReservedInstances |
| DescribeVpcEndpointsRequest | |
| DescribeVpcEndpointsResponse | |
| DissociatePackageRequest |
Container for the request parameters to the
DissociatePackage operation. |
| DissociatePackageResponse |
Container for the response returned by an
DissociatePackage operation. |
| DomainConfig |
Container for the configuration of an OpenSearch Service domain.
|
| DomainEndpointOptions |
Options to configure a custom endpoint for an OpenSearch Service domain.
|
| DomainEndpointOptionsStatus |
The configured endpoint options for a domain and their current status.
|
| DomainInfo |
Information about an OpenSearch Service domain.
|
| DomainInformationContainer |
Container for information about an OpenSearch Service domain.
|
| DomainNodesStatus |
Container for information about nodes on the domain.
|
| DomainPackageDetails |
Information about a package that is associated with a domain.
|
| DomainStatus |
The current status of an OpenSearch Service domain.
|
| DryRunProgressStatus |
Information about the progress of a pre-upgrade dry run analysis.
|
| DryRunResults |
Results of a dry run performed in an update domain request.
|
| Duration |
The duration of a maintenance schedule.
|
| EBSOptions |
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
|
| EBSOptionsStatus |
The status of the EBS options for the specified OpenSearch Service domain.
|
| EncryptionAtRestOptions |
Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use.
|
| EncryptionAtRestOptionsStatus |
Status of the encryption at rest options for the specified OpenSearch Service domain.
|
| EnvironmentInfo |
Information about the active domain environment.
|
| ErrorDetails |
Additional information if the package is in an error state.
|
| Filter |
A filter used to limit results when describing inbound or outbound cross-cluster connections.
|
| GetCompatibleVersionsRequest |
Container for the request parameters to
GetCompatibleVersions operation. |
| GetCompatibleVersionsResponse |
Container for the response returned by the
GetCompatibleVersions operation. |
| GetPackageVersionHistoryRequest |
Container for the request parameters to the
GetPackageVersionHistory operation. |
| GetPackageVersionHistoryResponse |
Container for response returned by
GetPackageVersionHistory operation. |
| GetUpgradeHistoryRequest |
Container for the request parameters to the
GetUpgradeHistory operation. |
| GetUpgradeHistoryResponse |
Container for the response returned by the
GetUpgradeHistory operation. |
| GetUpgradeStatusRequest |
Container for the request parameters to the
GetUpgradeStatus operation. |
| GetUpgradeStatusResponse |
Container for the response returned by the
GetUpgradeStatus operation. |
| InboundConnection |
Describes an inbound cross-cluster connection for Amazon OpenSearch Service.
|
| InboundConnectionStatus |
The status of an inbound cross-cluster connection for OpenSearch Service.
|
| InstanceCountLimits |
Limits on the number of instances that can be created in OpenSearch Service for a given instance type.
|
| InstanceLimits |
Instance-related attributes that are available for a given instance type.
|
| InstanceTypeDetails |
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
|
| Limits |
Limits for a given instance type and for each of its roles.
|
| ListDomainNamesRequest |
Container for the parameters to the
ListDomainNames operation. |
| ListDomainNamesResponse |
The results of a
ListDomainNames operation. |
| ListDomainsForPackageRequest |
Container for the request parameters to the
ListDomainsForPackage operation. |
| ListDomainsForPackageResponse |
Container for the response parameters to the
ListDomainsForPackage operation. |
| ListInstanceTypeDetailsRequest | |
| ListInstanceTypeDetailsResponse | |
| ListPackagesForDomainRequest |
Container for the request parameters to the
ListPackagesForDomain operation. |
| ListPackagesForDomainResponse |
Container for the response parameters to the
ListPackagesForDomain operation. |
| ListScheduledActionsRequest | |
| ListScheduledActionsResponse | |
| ListTagsRequest |
Container for the parameters to the
ListTags operation. |
| ListTagsResponse |
The results of a
ListTags operation. |
| ListVersionsRequest |
Container for the request parameters to the
ListVersions operation. |
| ListVersionsResponse |
Container for the parameters for response received from the
ListVersions operation. |
| ListVpcEndpointAccessRequest | |
| ListVpcEndpointAccessResponse | |
| ListVpcEndpointsForDomainRequest | |
| ListVpcEndpointsForDomainResponse | |
| ListVpcEndpointsRequest | |
| ListVpcEndpointsResponse | |
| LogPublishingOption |
Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon
CloudWatch.
|
| LogPublishingOptionsStatus |
The configured log publishing options for the domain and their current status.
|
| MasterUserOptions |
Credentials for the master user for a domain.
|
| NodeToNodeEncryptionOptions |
Enables or disables node-to-node encryption.
|
| NodeToNodeEncryptionOptionsStatus |
Status of the node-to-node encryption options for the specified domain.
|
| OffPeakWindow |
A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on
the domain.
|
| OffPeakWindowOptions |
Options for a domain's off-peak window,
during which OpenSearch Service can perform mandatory configuration changes on the domain.
|
| OffPeakWindowOptionsStatus |
The status of off-peak window
options for a domain.
|
| OpenSearchException.BuilderImpl | |
| OpenSearchRequest | |
| OpenSearchRequest.BuilderImpl | |
| OpenSearchResponse | |
| OpenSearchResponse.BuilderImpl | |
| OpenSearchResponseMetadata | |
| OptionStatus |
Provides the current status of an entity.
|
| OutboundConnection |
Specifies details about an outbound cross-cluster connection.
|
| OutboundConnectionStatus |
The status of an outbound cross-cluster connection.
|
| PackageDetails |
Basic information about a package.
|
| PackageSource |
The Amazon S3 location to import the package from.
|
| PackageVersionHistory |
Details about a package version.
|
| PurchaseReservedInstanceOfferingRequest |
Container for request parameters to the
PurchaseReservedInstanceOffering operation. |
| PurchaseReservedInstanceOfferingResponse |
Represents the output of a
PurchaseReservedInstanceOffering operation. |
| RecurringCharge |
Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a
Reserved Instance offering.
|
| RejectInboundConnectionRequest |
Container for the request parameters to the
RejectInboundConnection operation. |
| RejectInboundConnectionResponse |
Represents the output of a
RejectInboundConnection operation. |
| RemoveTagsRequest |
Container for the request parameters to the
RemoveTags operation. |
| RemoveTagsResponse | |
| ReservedInstance |
Details of an OpenSearch Reserved Instance.
|
| ReservedInstanceOffering |
Details of an OpenSearch Reserved Instance offering.
|
| RevokeVpcEndpointAccessRequest | |
| RevokeVpcEndpointAccessResponse | |
| SAMLIdp |
The SAML identity povider information.
|
| SAMLOptionsInput |
The SAML authentication configuration for an Amazon OpenSearch Service domain.
|
| SAMLOptionsOutput |
Describes the SAML application configured for the domain.
|
| ScheduledAction |
Information about a scheduled configuration change for an OpenSearch Service domain.
|
| ScheduledAutoTuneDetails |
Specifies details about a scheduled Auto-Tune action.
|
| ServiceSoftwareOptions |
The current status of the service software for an Amazon OpenSearch Service domain.
|
| SnapshotOptions |
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain.
|
| SnapshotOptionsStatus |
Container for information about a daily automated snapshot for an OpenSearch Service domain.
|
| SoftwareUpdateOptions |
Options for configuring service software updates for a domain.
|
| SoftwareUpdateOptionsStatus |
The status of the service software options for a domain.
|
| StartServiceSoftwareUpdateRequest |
Container for the request parameters to the
StartServiceSoftwareUpdate operation. |
| StartServiceSoftwareUpdateResponse |
Represents the output of a
StartServiceSoftwareUpdate operation. |
| StorageType |
A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.
|
| StorageTypeLimit |
Limits that are applicable for the given Amazon OpenSearch Service storage type.
|
| Tag |
A tag (key-value pair) for an Amazon OpenSearch Service resource.
|
| UpdateDomainConfigRequest |
Container for the request parameters to the
UpdateDomain operation. |
| UpdateDomainConfigResponse |
The results of an
UpdateDomain request. |
| UpdatePackageRequest |
Container for request parameters to the
UpdatePackage operation. |
| UpdatePackageResponse |
Container for the response returned by the
UpdatePackage operation. |
| UpdateScheduledActionRequest | |
| UpdateScheduledActionResponse | |
| UpdateVpcEndpointRequest | |
| UpdateVpcEndpointResponse | |
| UpgradeDomainRequest |
Container for the request parameters to the
UpgradeDomain operation. |
| UpgradeDomainResponse |
Container for the response returned by
UpgradeDomain operation. |
| UpgradeHistory |
History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.
|
| UpgradeStepItem |
Represents a single step of an upgrade or upgrade eligibility check workflow.
|
| ValidationFailure |
A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.
|
| VersionStatus |
The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.
|
| VPCDerivedInfo |
Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a
virtual private cloud (VPC).
|
| VPCDerivedInfoStatus |
Status of the VPC options for a specified domain.
|
| VpcEndpoint |
The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
|
| VpcEndpointError |
Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
|
| VpcEndpointSummary |
Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
|
| VPCOptions |
Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
|
| WindowStartTime |
The desired start time for an off-peak maintenance
window.
|
| ZoneAwarenessConfig |
The zone awareness configuration for an Amazon OpenSearch Service domain.
|
| Exception | Description |
|---|---|
| AccessDeniedException |
An error occurred because you don't have permissions to access the resource.
|
| BaseException |
An error occurred while processing the request.
|
| ConflictException |
An error occurred because the client attempts to remove a resource that is currently in use.
|
| DependencyFailureException |
An exception for when a failure in one of the dependencies results in the service being unable to fetch details about
the resource.
|
| DisabledOperationException |
An error occured because the client wanted to access an unsupported operation.
|
| InternalException |
Request processing failed because of an unknown error, exception, or internal failure.
|
| InvalidPaginationTokenException |
Request processing failed because you provided an invalid pagination token.
|
| InvalidTypeException |
An exception for trying to create or access a sub-resource that's either invalid or not supported.
|
| LimitExceededException |
An exception for trying to create more than the allowed number of resources or sub-resources.
|
| OpenSearchException | |
| ResourceAlreadyExistsException |
An exception for creating a resource that already exists.
|
| ResourceNotFoundException |
An exception for accessing or deleting a resource that doesn't exist.
|
| SlotNotAvailableException |
An exception for attempting to schedule a domain action during an unavailable time slot.
|
| ValidationException |
An exception for accessing or deleting a resource that doesn't exist.
|
Copyright © 2023. All rights reserved.