checkout_license `async` ¶

checkout_license(
    product_sku: String,
    checkout_type: CheckoutType,
    key_fingerprint: String,
    entitlements: EntitlementDataList,
    client_token: ClientToken,
    *,
    config_overrides: Optional[AsyncLicenseManagerClientConfig] = None,
    beneficiary: Optional[String] = None,
    node_id: Optional[String] = None,
) -> CheckoutLicenseResponse

Checks out the specified license.

If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.

Parameters:

product_sku (String) –

Product SKU.
checkout_type (CheckoutType) –

Checkout type.
key_fingerprint (String) –

Key fingerprint identifying the license.
entitlements (EntitlementDataList) –

License entitlements.
client_token (ClientToken) –

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
beneficiary (Optional[String], default: None ) –

License beneficiary.
node_id (Optional[String], default: None ) –

Node ID.

Raises:

AccessDeniedException –

Access to resource denied.
AuthorizationException –

The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.
InvalidParameterValueException –

One or more parameter values are not valid.
NoEntitlementsAllowedException –

There are no entitlements found for this license, or the entitlement maximum count is reached.
RateLimitExceededException –

Too many requests have been submitted. Try again after a brief wait.
RedirectException –

This is not the correct Region for the resource. Try again.
ResourceNotFoundException –

The resource cannot be found.
ServerInternalException –

The server experienced an internal error. Try again.
UnsupportedDigitalSignatureMethodException –

The digital signature method is unsupported. Try your request again.
ValidationException –

The provided input is not valid. Try your request again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_license_manager/_services/async_license_manager.py

async def checkout_license(
    self,
    product_sku: "capo_license_manager.types.string.String",
    checkout_type: "capo_license_manager.types.checkout_type.CheckoutType",
    key_fingerprint: "capo_license_manager.types.string.String",
    entitlements: "capo_license_manager.types.entitlement_data_list.EntitlementDataList",
    client_token: "capo_license_manager.types.client_token.ClientToken",
    *,
    config_overrides: Optional[AsyncLicenseManagerClientConfig] = None,
    beneficiary: Optional["capo_license_manager.types.string.String"] = None,
    node_id: Optional["capo_license_manager.types.string.String"] = None,
) -> "capo_license_manager.types.checkout_license_response.CheckoutLicenseResponse":
    """<p>Checks out the specified license.</p> <note> <p>If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.</p> </note>

    Args:
        product_sku: <p>Product SKU.</p>
        checkout_type: <p>Checkout type.</p>
        key_fingerprint: <p>Key fingerprint identifying the license.</p>
        entitlements: <p>License entitlements.</p>
        client_token: <p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>
        beneficiary: <p>License beneficiary.</p>
        node_id: <p>Node ID.</p>

    Raises:
        capo_license_manager.errors.access_denied_exception.AccessDeniedException: <p>Access to resource denied.</p>
        capo_license_manager.errors.authorization_exception.AuthorizationException: <p>The Amazon Web Services user account does not have permission to perform the action. Check the IAM policy associated with this account.</p>
        capo_license_manager.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameter values are not valid.</p>
        capo_license_manager.errors.no_entitlements_allowed_exception.NoEntitlementsAllowedException: <p>There are no entitlements found for this license, or the entitlement maximum count is reached.</p>
        capo_license_manager.errors.rate_limit_exceeded_exception.RateLimitExceededException: <p>Too many requests have been submitted. Try again after a brief wait.</p>
        capo_license_manager.errors.redirect_exception.RedirectException: <p>This is not the correct Region for the resource. Try again.</p>
        capo_license_manager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource cannot be found.</p>
        capo_license_manager.errors.server_internal_exception.ServerInternalException: <p>The server experienced an internal error. Try again.</p>
        capo_license_manager.errors.unsupported_digital_signature_method_exception.UnsupportedDigitalSignatureMethodException: <p>The digital signature method is unsupported. Try your request again.</p>
        capo_license_manager.errors.validation_exception.ValidationException: <p>The provided input is not valid. Try your request again.</p>
        capo_license_manager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_license_manager.types.checkout_license_request.CheckoutLicenseRequest]",
    ) -> AsyncOperationResponse[
        "capo_license_manager.types.checkout_license_response.CheckoutLicenseResponse"
    ]:
        import capo_license_manager._operations.aws_license_manager.checkout_license

        (
            output,
            http_response,
        ) = await capo_license_manager._operations.aws_license_manager.checkout_license.async_checkout_license(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CheckoutLicense")
    )
    input_: capo_license_manager.types.checkout_license_request.CheckoutLicenseRequest = {
        "product_sku": product_sku,
        "checkout_type": checkout_type,
        "key_fingerprint": key_fingerprint,
        "entitlements": entitlements,
        "client_token": client_token,
    }
    if beneficiary is not None:
        input_["beneficiary"] = beneficiary
    if node_id is not None:
        input_["node_id"] = node_id

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

checkout_license async ¶

checkout_license `async` ¶