Skip to content

cancel_change_set async

cancel_change_set(
    catalog: Catalog,
    change_set_id: ResourceId,
    *,
    config_overrides: Optional[AsyncMarketplaceCatalogClientConfig] = None,
) -> CancelChangeSetResponse

Used to cancel an open change request. Must be sent before the status of the request changes to APPLYING, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.

Parameters:

  • catalog (Catalog) –

    Required. The catalog related to the request. Fixed value: AWSMarketplace.

  • change_set_id (ResourceId) –

    Required. The unique identifier of the StartChangeSet request that you want to cancel.

Raises:

Source code in docs_src/capo_marketplace_catalog/_services/async_marketplace_catalog.py
async def cancel_change_set(
    self,
    catalog: "capo_marketplace_catalog.types.catalog.Catalog",
    change_set_id: "capo_marketplace_catalog.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[AsyncMarketplaceCatalogClientConfig] = None,
) -> "capo_marketplace_catalog.types.cancel_change_set_response.CancelChangeSetResponse":
    """<p>Used to cancel an open change request. Must be sent before the status of the request changes to <code>APPLYING</code>, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.</p>

    Args:
        catalog: <p>Required. The catalog related to the request. Fixed value: <code>AWSMarketplace</code>.</p>
        change_set_id: <p>Required. The unique identifier of the <code>StartChangeSet</code> request that you want to cancel.</p>

    Raises:
        capo_marketplace_catalog.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p> <p>HTTP status code: 403</p>
        capo_marketplace_catalog.errors.internal_service_exception.InternalServiceException: <p>There was an internal service exception.</p> <p>HTTP status code: 500</p>
        capo_marketplace_catalog.errors.resource_in_use_exception.ResourceInUseException: <p>The resource is currently in use.</p>
        capo_marketplace_catalog.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource wasn't found.</p> <p>HTTP status code: 404</p>
        capo_marketplace_catalog.errors.throttling_exception.ThrottlingException: <p>Too many requests.</p> <p>HTTP status code: 429</p>
        capo_marketplace_catalog.errors.validation_exception.ValidationException: <p>An error occurred during validation.</p> <p>HTTP status code: 422</p>
        capo_marketplace_catalog.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_marketplace_catalog.types.cancel_change_set_request.CancelChangeSetRequest]",
    ) -> AsyncOperationResponse[
        "capo_marketplace_catalog.types.cancel_change_set_response.CancelChangeSetResponse"
    ]:
        import capo_marketplace_catalog._operations.awsmp_seymour.cancel_change_set

        (
            output,
            http_response,
        ) = await capo_marketplace_catalog._operations.awsmp_seymour.cancel_change_set.async_cancel_change_set(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelChangeSet")
    )
    input_: capo_marketplace_catalog.types.cancel_change_set_request.CancelChangeSetRequest = {
        "catalog": catalog,
        "change_set_id": change_set_id,
    }

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