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.
Parameters:
-
domain_name
(DomainName)
–
-
dry_run_id
(Optional[GUID], default:
None
)
–
The unique identifier of the dry run.
-
load_dry_run_config
(Optional[Boolean], default:
None
)
–
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.
Raises:
Source code in docs_src/capo_opensearch/_services/open_search.py
| def describe_dry_run_progress(
self,
domain_name: "capo_opensearch.types.domain_name.DomainName",
*,
config_overrides: Optional[OpenSearchClientConfig] = None,
dry_run_id: Optional["capo_opensearch.types.guid.GUID"] = None,
load_dry_run_config: Optional["capo_opensearch.types.boolean.Boolean"] = None,
) -> "capo_opensearch.types.describe_dry_run_progress_response.DescribeDryRunProgressResponse":
"""<p>Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#dryrun">Determining whether a change will cause a blue/green deployment</a>.</p>
Args:
domain_name: <p>The name of the domain.</p>
dry_run_id: <p>The unique identifier of the dry run.</p>
load_dry_run_config: <p>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.</p>
Raises:
capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
capo_opensearch.errors.disabled_operation_exception.DisabledOperationException: <p>An error occured because the client wanted to access an unsupported operation.</p>
capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
capo_opensearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_opensearch.types.describe_dry_run_progress_request.DescribeDryRunProgressRequest]",
) -> OperationResponse[
"capo_opensearch.types.describe_dry_run_progress_response.DescribeDryRunProgressResponse"
]:
import capo_opensearch._operations.amazon_open_search_service.describe_dry_run_progress
output, http_response = (
capo_opensearch._operations.amazon_open_search_service.describe_dry_run_progress.describe_dry_run_progress(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDryRunProgress")
)
input_: capo_opensearch.types.describe_dry_run_progress_request.DescribeDryRunProgressRequest = {
"domain_name": domain_name
}
if dry_run_id is not None:
input_["dry_run_id"] = dry_run_id
if load_dry_run_config is not None:
input_["load_dry_run_config"] = load_dry_run_config
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|