Amazon Elasticsearch Service
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept
      PUT
    • /2015-01-01/tags
      POST
    • /2015-01-01/packages/associate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/cancel
      POST
    • /2015-01-01/es/domain
      POST
    • /2015-01-01/es/ccs/outboundConnection
      POST
    • /2015-01-01/packages
      POST
    • /2015-01-01/es/vpcEndpoints
      POST
    • /2015-01-01/es/vpcEndpoints
      GET
    • /2015-01-01/es/domain/{DomainName}
      DELETE
    • /2015-01-01/es/domain/{DomainName}
      GET
    • /2015-01-01/es/role
      DELETE
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/es/ccs/outboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/packages/{PackageID}
      DELETE
    • /2015-01-01/es/vpcEndpoints/{VpcEndpointId}
      DELETE
    • /2015-01-01/es/domain/{DomainName}/autoTunes
      GET
    • /2015-01-01/es/domain/{DomainName}/progress
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      POST
    • /2015-01-01/es/domain-info
      POST
    • /2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}
      GET
    • /2015-01-01/es/ccs/inboundConnection/search
      POST
    • /2015-01-01/es/ccs/outboundConnection/search
      POST
    • /2015-01-01/packages/describe
      POST
    • /2015-01-01/es/reservedInstanceOfferings
      GET
    • /2015-01-01/es/reservedInstances
      GET
    • /2015-01-01/es/vpcEndpoints/describe
      POST
    • /2015-01-01/packages/dissociate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/compatibleVersions
      GET
    • /2015-01-01/packages/{PackageID}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/status
      GET
    • /2015-01-01/domain
      GET
    • /2015-01-01/packages/{PackageID}/domains
      GET
    • /2015-01-01/es/instanceTypes/{ElasticsearchVersion}
      GET
    • /2015-01-01/es/versions
      GET
    • /2015-01-01/domain/{DomainName}/packages
      GET
    • /2015-01-01/tags/
      GET
    • /2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess
      GET
    • /2015-01-01/es/domain/{DomainName}/vpcEndpoints
      GET
    • /2015-01-01/es/purchaseReservedInstanceOffering
      POST
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject
      PUT
    • /2015-01-01/tags-removal
      POST
    • /2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/start
      POST
    • /2015-01-01/packages/update
      POST
    • /2015-01-01/es/vpcEndpoints/update
      POST
    • /2015-01-01/es/upgradeDomain
      POST
    • Schemas
      • Schemas
        • AcceptInboundCrossClusterSearchConnectionResponse
        • ResourceNotFoundException
        • LimitExceededException
        • DisabledOperationException
        • Tag
        • BaseException
        • ValidationException
        • InternalException
        • AssociatePackageResponse
        • AccessDeniedException
        • ConflictException
        • CancelElasticsearchServiceSoftwareUpdateResponse
        • AuthorizeVpcEndpointAccessResponse
        • CreateElasticsearchDomainResponse
        • ESPartitionInstanceType
        • IntegerClass
        • Boolean
        • ZoneAwarenessConfig
        • ESWarmPartitionInstanceType
        • ColdStorageOptions
        • VolumeType
        • StringList
        • UserPoolId
        • IdentityPoolId
        • RoleArn
        • KmsKeyId
        • String
        • LogPublishingOption
        • TLSSecurityPolicy
        • DomainNameFqdn
        • ARN
        • MasterUserOptions
        • SAMLOptionsInput
        • AutoTuneDesiredState
        • AutoTuneMaintenanceScheduleList
        • InvalidTypeException
        • ResourceAlreadyExistsException
        • CreateOutboundCrossClusterSearchConnectionResponse
        • OwnerId
        • DomainName
        • Region
        • CreatePackageResponse
        • S3BucketName
        • S3Key
        • DeleteElasticsearchDomainResponse
        • DeleteInboundCrossClusterSearchConnectionResponse
        • CreateVpcEndpointResponse
        • DeleteOutboundCrossClusterSearchConnectionResponse
        • DeletePackageResponse
        • DescribeDomainAutoTunesResponse
        • DescribeElasticsearchDomainResponse
        • DescribeElasticsearchDomainConfigResponse
        • DeleteVpcEndpointResponse
        • DescribeElasticsearchDomainsResponse
        • DescribeElasticsearchInstanceTypeLimitsResponse
        • DescribeDomainChangeProgressResponse
        • DescribeInboundCrossClusterSearchConnectionsResponse
        • Filter
        • InvalidPaginationTokenException
        • DescribeOutboundCrossClusterSearchConnectionsResponse
        • DescribePackagesResponse
        • DescribePackagesFilter
        • DescribeReservedElasticsearchInstanceOfferingsResponse
        • DescribeReservedElasticsearchInstancesResponse
        • DissociatePackageResponse
        • GetCompatibleElasticsearchVersionsResponse
        • GetPackageVersionHistoryResponse
        • GetUpgradeHistoryResponse
        • GetUpgradeStatusResponse
        • DescribeVpcEndpointsResponse
        • ListDomainNamesResponse
        • VpcEndpointId
        • ListDomainsForPackageResponse
        • ListElasticsearchInstanceTypesResponse
        • ListElasticsearchVersionsResponse
        • ListPackagesForDomainResponse
        • ListTagsResponse
        • PurchaseReservedElasticsearchInstanceOfferingResponse
        • RejectInboundCrossClusterSearchConnectionResponse
        • StartElasticsearchServiceSoftwareUpdateResponse
        • UpdateElasticsearchDomainConfigResponse
        • RollbackOnDisable
        • UpdatePackageResponse
        • UpgradeElasticsearchDomainResponse
        • ListVpcEndpointAccessResponse
        • CrossClusterSearchConnectionId
        • ListVpcEndpointsResponse
        • AcceptInboundCrossClusterSearchConnectionRequest
        • ListVpcEndpointsForDomainResponse
        • InboundCrossClusterSearchConnection
        • PolicyDocument
        • OptionStatus
        • RevokeVpcEndpointAccessResponse
        • AccessPoliciesStatus
        • TagList
        • AddTagsRequest
        • LimitName
        • LimitValueList
        • UpdateVpcEndpointResponse
        • AdditionalLimit
        • AdditionalLimitList
        • AWSAccount
        • AdvancedOptions
        • AdvancedOptionsStatus
        • SAMLOptionsOutput
        • AdvancedSecurityOptions
        • AdvancedSecurityOptionsInput
        • AdvancedSecurityOptionsStatus
        • PackageID
        • AssociatePackageRequest
        • DomainPackageDetails
        • AutoTuneType
        • AutoTuneDetails
        • AutoTune
        • AutoTuneDate
        • ScheduledAutoTuneDetails
        • AutoTuneList
        • StartAt
        • DisableTimestamp
        • Duration
        • AutoTuneMaintenanceSchedule
        • AutoTuneOptions
        • AutoTuneOptionsInput
        • AutoTuneState
        • AutoTuneOptionsOutput
        • AutoTuneStatus
        • AuthorizeVpcEndpointAccessRequest
        • AutoTuneOptionsStatus
        • AuthorizedPrincipal
        • UpdateTimestamp
        • PrincipalType
        • UIntValue
        • AuthorizedPrincipalList
        • BackendRole
        • CancelElasticsearchServiceSoftwareUpdateRequest
        • ServiceSoftwareOptions
        • CloudWatchLogsLogGroupArn
        • CognitoOptions
        • CognitoOptionsStatus
        • CommitMessage
        • CompatibleVersionsMap
        • CompatibleElasticsearchVersionsList
        • ElasticsearchVersionString
        • ElasticsearchVersionList
        • ConnectionAlias
        • ElasticsearchClusterConfig
        • EBSOptions
        • SnapshotOptions
        • VPCOptions
        • EncryptionAtRestOptions
        • NodeToNodeEncryptionOptions
        • LogPublishingOptions
        • DomainEndpointOptions
        • CreateElasticsearchDomainRequest
        • ElasticsearchDomainStatus
        • Message
        • DomainInformation
        • ChangeProgressDetails
        • CreateOutboundCrossClusterSearchConnectionRequest
        • ChangeProgressStageName
        • OutboundCrossClusterSearchConnectionStatus
        • ChangeProgressStageStatus
        • PackageName
        • Description
        • PackageType
        • PackageDescription
        • ChangeProgressStage
        • PackageSource
        • ChangeProgressStageList
        • CreatePackageRequest
        • OverallChangeStatus
        • PackageDetails
        • TotalNumberOfStages
        • CreatedAt
        • ChangeProgressStatusDetails
        • CrossClusterSearchConnectionStatusMessage
        • ClientToken
        • DeleteElasticsearchDomainRequest
        • DeleteInboundCrossClusterSearchConnectionRequest
        • DeleteOutboundCrossClusterSearchConnectionRequest
        • OutboundCrossClusterSearchConnection
        • DeletePackageRequest
        • DeploymentCloseDateTimeStamp
        • DeploymentStatus
        • MaxResults
        • NextToken
        • DescribeDomainAutoTunesRequest
        • DescribeElasticsearchDomainConfigRequest
        • ElasticsearchDomainConfig
        • DescribeElasticsearchDomainRequest
        • DomainNameList
        • DescribeElasticsearchDomainsRequest
        • ElasticsearchDomainStatusList
        • DescribeElasticsearchInstanceTypeLimitsRequest
        • LimitsByRole
        • FilterList
        • DescribeInboundCrossClusterSearchConnectionsRequest
        • InboundCrossClusterSearchConnections
        • DescribeOutboundCrossClusterSearchConnectionsRequest
        • OutboundCrossClusterSearchConnections
        • DescribePackagesFilterName
        • DescribePackagesFilterValues
        • DescribePackagesFilterList
        • DescribePackagesFilterValue
        • DescribePackagesRequest
        • PackageDetailsList
        • DomainArn
        • GUID
        • CreateVpcEndpointRequest
        • DescribeReservedElasticsearchInstanceOfferingsRequest
        • VpcEndpoint
        • ReservedElasticsearchInstanceOfferingList
        • DescribeReservedElasticsearchInstancesRequest
        • ReservedElasticsearchInstanceList
        • DissociatePackageRequest
        • DomainEndpointOptionsStatus
        • DomainId
        • EngineType
        • DomainInfo
        • DeleteVpcEndpointRequest
        • DomainInfoList
        • VpcEndpointSummary
        • LastUpdated
        • DomainPackageStatus
        • PackageVersion
        • DeploymentType
        • ReferencePath
        • ErrorDetails
        • DomainPackageDetailsList
        • Double
        • DescribeDomainChangeProgressRequest
        • DurationValue
        • TimeUnit
        • EBSOptionsStatus
        • ElasticsearchClusterConfigStatus
        • ElasticsearchVersionStatus
        • SnapshotOptionsStatus
        • VPCDerivedInfoStatus
        • EncryptionAtRestOptionsStatus
        • NodeToNodeEncryptionOptionsStatus
        • LogPublishingOptionsStatus
        • ServiceUrl
        • EndpointsMap
        • VPCDerivedInfo
        • ElasticsearchInstanceTypeList
        • ErrorType
        • ErrorMessage
        • NonEmptyString
        • ValueStringList
        • GetCompatibleElasticsearchVersionsRequest
        • GetPackageVersionHistoryRequest
        • PackageVersionHistoryList
        • GetUpgradeHistoryRequest
        • UpgradeHistoryList
        • GetUpgradeStatusRequest
        • VpcEndpointIdList
        • UpgradeStep
        • DescribeVpcEndpointsRequest
        • UpgradeStatus
        • VpcEndpoints
        • UpgradeName
        • VpcEndpointErrorList
        • InboundCrossClusterSearchConnectionStatus
        • InboundCrossClusterSearchConnectionStatusCode
        • InstanceCount
        • MinimumInstanceCount
        • MaximumInstanceCount
        • InstanceCountLimits
        • InstanceLimits
        • InstanceRole
        • Integer
        • Issue
        • Issues
        • LimitValue
        • StorageTypeList
        • DryRun
        • Limits
        • DryRunResults
        • ListDomainNamesRequest
        • ListDomainsForPackageRequest
        • ListElasticsearchInstanceTypesRequest
        • ListElasticsearchVersionsRequest
        • ListPackagesForDomainRequest
        • ListTagsRequest
        • LogType
        • Username
        • Password
        • OptionState
        • OutboundCrossClusterSearchConnectionStatusCode
        • PackageStatus
        • PackageVersionHistory
        • ReservationToken
        • PurchaseReservedElasticsearchInstanceOfferingRequest
        • Endpoint
        • RecurringCharge
        • RecurringChargeList
        • RejectInboundCrossClusterSearchConnectionRequest
        • RemoveTagsRequest
        • ReservedElasticsearchInstancePaymentOption
        • ReservedElasticsearchInstance
        • ReservedElasticsearchInstanceOffering
        • SAMLEntityId
        • SAMLMetadata
        • SAMLIdp
        • ScheduledAutoTuneActionType
        • ScheduledAutoTuneDescription
        • ScheduledAutoTuneSeverityType
        • StartElasticsearchServiceSoftwareUpdateRequest
        • StartTimestamp
        • StorageSubTypeName
        • StorageTypeName
        • StorageTypeLimitList
        • StorageType
        • StorageTypeLimit
        • TagKey
        • TagValue
        • UpdateElasticsearchDomainConfigRequest
        • UpdatePackageRequest
        • UpgradeElasticsearchDomainRequest
        • UpgradeStepsList
        • UpgradeHistory
        • UpgradeStepItem
        • ListVpcEndpointAccessRequest
        • ListVpcEndpointsForDomainRequest
        • VpcEndpointSummaryList
        • ListVpcEndpointsRequest
        • RevokeVpcEndpointAccessRequest
        • UpdateVpcEndpointRequest
        • VpcEndpointErrorCode
        • VpcEndpointError

      /2015-01-01/es/upgradeDomain/{DomainName}/status

      The Amazon Elasticsearch Service multi-region endpoint
      http://es.{region}.amazonaws.com
      The Amazon Elasticsearch Service multi-region endpoint
      http://es.{region}.amazonaws.com
      GET
      /2015-01-01/es/upgradeDomain/{DomainName}/status
      Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

      Request

      Path Params

      Responses

      🟢200Success
      application/json
      Bodyapplication/json

      🟠480BaseException
      🟠481ResourceNotFoundException
      🟠482DisabledOperationException
      🟠483ValidationException
      🟠484InternalException
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --globoff 'http://es.{region}.amazonaws.com/2015-01-01/es/upgradeDomain//status'
      Response Response Example
      200 - Example 1
      {
    "UpgradeStep": "PRE_UPGRADE_CHECK",
    "StepStatus": "IN_PROGRESS",
    "UpgradeName": "string"
}
      Modified at 2023-08-15 04:15:53
      Previous
      /2015-01-01/es/upgradeDomain/{DomainName}/history
      Next
      /2015-01-01/domain
      Built with