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.
Request Syntax
GET /2021-01-01/opensearch/domain/DomainName/dryRun?dryRunId=DryRunId&loadDryRunConfig=LoadDryRunConfig HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- DomainName
-
The name of the domain.
Length Constraints: Minimum length of 3. Maximum length of 28.
Pattern:
[a-z][a-z0-9\-]+Required: Yes
- DryRunId
-
The unique identifier of the dry run.
Length Constraints: Fixed length of 36.
Pattern:
\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12} - 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.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DryRunConfig": {
"AccessPolicies": "string",
"AdvancedOptions": {
"string" : "string"
},
"AdvancedSecurityOptions": {
"AnonymousAuthDisableDate": number,
"AnonymousAuthEnabled": boolean,
"Enabled": boolean,
"InternalUserDatabaseEnabled": boolean,
"JWTOptions": {
"Enabled": boolean,
"PublicKey": "string",
"RolesKey": "string",
"SubjectKey": "string"
},
"SAMLOptions": {
"Enabled": boolean,
"Idp": {
"EntityId": "string",
"MetadataContent": "string"
},
"RolesKey": "string",
"SessionTimeoutMinutes": number,
"SubjectKey": "string"
}
},
"AIMLOptions": {
"NaturalLanguageQueryGenerationOptions": {
"CurrentState": "string",
"DesiredState": "string"
}
},
"ARN": "string",
"AutoTuneOptions": {
"ErrorMessage": "string",
"State": "string",
"UseOffPeakWindow": boolean
},
"ChangeProgressDetails": {
"ChangeId": "string",
"ConfigChangeStatus": "string",
"InitiatedBy": "string",
"LastUpdatedTime": number,
"Message": "string",
"StartTime": number
},
"ClusterConfig": {
"ColdStorageOptions": {
"Enabled": boolean
},
"DedicatedMasterCount": number,
"DedicatedMasterEnabled": boolean,
"DedicatedMasterType": "string",
"InstanceCount": number,
"InstanceType": "string",
"MultiAZWithStandbyEnabled": boolean,
"NodeOptions": [
{
"NodeConfig": {
"Count": number,
"Enabled": boolean,
"Type": "string"
},
"NodeType": "string"
}
],
"WarmCount": number,
"WarmEnabled": boolean,
"WarmType": "string",
"ZoneAwarenessConfig": {
"AvailabilityZoneCount": number
},
"ZoneAwarenessEnabled": boolean
},
"CognitoOptions": {
"Enabled": boolean,
"IdentityPoolId": "string",
"RoleArn": "string",
"UserPoolId": "string"
},
"Created": boolean,
"Deleted": boolean,
"DomainEndpointOptions": {
"CustomEndpoint": "string",
"CustomEndpointCertificateArn": "string",
"CustomEndpointEnabled": boolean,
"EnforceHTTPS": boolean,
"TLSSecurityPolicy": "string"
},
"DomainEndpointV2HostedZoneId": "string",
"DomainId": "string",
"DomainName": "string",
"DomainProcessingStatus": "string",
"EBSOptions": {
"EBSEnabled": boolean,
"Iops": number,
"Throughput": number,
"VolumeSize": number,
"VolumeType": "string"
},
"EncryptionAtRestOptions": {
"Enabled": boolean,
"KmsKeyId": "string"
},
"Endpoint": "string",
"Endpoints": {
"string" : "string"
},
"EndpointV2": "string",
"EngineVersion": "string",
"IdentityCenterOptions": {
"EnabledAPIAccess": boolean,
"IdentityCenterApplicationARN": "string",
"IdentityCenterInstanceARN": "string",
"IdentityStoreId": "string",
"RolesKey": "string",
"SubjectKey": "string"
},
"IPAddressType": "string",
"LogPublishingOptions": {
"string" : {
"CloudWatchLogsLogGroupArn": "string",
"Enabled": boolean
}
},
"ModifyingProperties": [
{
"ActiveValue": "string",
"Name": "string",
"PendingValue": "string",
"ValueType": "string"
}
],
"NodeToNodeEncryptionOptions": {
"Enabled": boolean
},
"OffPeakWindowOptions": {
"Enabled": boolean,
"OffPeakWindow": {
"WindowStartTime": {
"Hours": number,
"Minutes": number
}
}
},
"Processing": boolean,
"ServiceSoftwareOptions": {
"AutomatedUpdateDate": number,
"Cancellable": boolean,
"CurrentVersion": "string",
"Description": "string",
"NewVersion": "string",
"OptionalDeployment": boolean,
"UpdateAvailable": boolean,
"UpdateStatus": "string"
},
"SnapshotOptions": {
"AutomatedSnapshotStartHour": number
},
"SoftwareUpdateOptions": {
"AutoSoftwareUpdateEnabled": boolean
},
"UpgradeProcessing": boolean,
"VPCOptions": {
"AvailabilityZones": [ "string" ],
"SecurityGroupIds": [ "string" ],
"SubnetIds": [ "string" ],
"VPCId": "string"
}
},
"DryRunProgressStatus": {
"CreationDate": "string",
"DryRunId": "string",
"DryRunStatus": "string",
"UpdateDate": "string",
"ValidationFailures": [
{
"Code": "string",
"Message": "string"
}
]
},
"DryRunResults": {
"DeploymentType": "string",
"Message": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DryRunConfig
-
Details about the changes you're planning to make on the domain.
Type: DomainStatus object
- DryRunProgressStatus
-
The current status of the dry run, including any validation errors.
Type: DryRunProgressStatus object
- DryRunResults
-
The results of the dry run.
Type: DryRunResults object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BaseException
-
An error occurred while processing the request.
HTTP Status Code: 400
- DisabledOperationException
-
An error occured because the client wanted to access an unsupported operation.
HTTP Status Code: 409
- InternalException
-
Request processing failed because of an unknown error, exception, or internal failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 409
- ValidationException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
