Skip to content

start_cluster async

start_cluster(
    cluster_arn: str,
    *,
    config_overrides: Optional[AsyncDocDBElasticClientConfig] = None,
) -> StartClusterOutput

Restarts the stopped elastic cluster that is specified by clusterARN.

Parameters:

  • cluster_arn (str) –

    The ARN identifier of the elastic cluster.

Raises:

Examples:

Basic Start Cluster Example update applied

>>> await client.start_cluster(cluster_arn='arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID')
Source code in docs_src/capo_docdb_elastic/_services/async_doc_db_elastic.py
async def start_cluster(
    self,
    cluster_arn: str,
    *,
    config_overrides: Optional[AsyncDocDBElasticClientConfig] = None,
) -> "capo_docdb_elastic.types.start_cluster_output.StartClusterOutput":
    """<p>Restarts the stopped elastic cluster that is specified by <code>clusterARN</code>.</p>

    Args:
        cluster_arn: <p>The ARN identifier of the elastic cluster.</p>

    Raises:
        capo_docdb_elastic.errors.access_denied_exception.AccessDeniedException: <p>An exception that occurs when there are not sufficient permissions to perform an action.</p>
        capo_docdb_elastic.errors.internal_server_exception.InternalServerException: <p>There was an internal server error.</p>
        capo_docdb_elastic.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be located.</p>
        capo_docdb_elastic.errors.throttling_exception.ThrottlingException: <p>ThrottlingException will be thrown when request was denied due to request throttling.</p>
        capo_docdb_elastic.errors.validation_exception.ValidationException: <p>A structure defining a validation exception.</p>
        capo_docdb_elastic.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Basic Start Cluster Example
        update applied

        >>> await client.start_cluster(cluster_arn='arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_docdb_elastic.types.start_cluster_input.StartClusterInput]",
    ) -> AsyncOperationResponse[
        "capo_docdb_elastic.types.start_cluster_output.StartClusterOutput"
    ]:
        import capo_docdb_elastic._operations.chimera_db_lionfish_service_lambda.start_cluster

        (
            output,
            http_response,
        ) = await capo_docdb_elastic._operations.chimera_db_lionfish_service_lambda.start_cluster.async_start_cluster(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartCluster")
    )
    input_: capo_docdb_elastic.types.start_cluster_input.StartClusterInput = {
        "cluster_arn": cluster_arn
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output