Skip to content

check_in_license

check_in_license(
    license_consumption_token: String,
    *,
    config_overrides: Optional[LicenseManagerClientConfig] = None,
    beneficiary: Optional[String] = None,
) -> CheckInLicenseResponse

Checks in the specified license. Check in a license when it is no longer in use.

Parameters:

  • license_consumption_token (String) –

    License consumption token.

  • beneficiary (Optional[String], default: None ) –

    License beneficiary.

Raises:

Source code in docs_src/capo_license_manager/_services/license_manager.py
def check_in_license(
    self,
    license_consumption_token: "capo_license_manager.types.string.String",
    *,
    config_overrides: Optional[LicenseManagerClientConfig] = None,
    beneficiary: Optional["capo_license_manager.types.string.String"] = None,
) -> "capo_license_manager.types.check_in_license_response.CheckInLicenseResponse":
    """<p>Checks in the specified license. Check in a license when it is no longer in use.</p>

    Args:
        license_consumption_token: <p>License consumption token.</p>
        beneficiary: <p>License beneficiary.</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.conflict_exception.ConflictException: <p>There was a conflict processing the request. Try your request again.</p>
        capo_license_manager.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more parameter values are not valid.</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.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.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.
    """

    def _handler(
        req: "OperationRequest[capo_license_manager.types.check_in_license_request.CheckInLicenseRequest]",
    ) -> OperationResponse[
        "capo_license_manager.types.check_in_license_response.CheckInLicenseResponse"
    ]:
        import capo_license_manager._operations.aws_license_manager.check_in_license

        output, http_response = (
            capo_license_manager._operations.aws_license_manager.check_in_license.check_in_license(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CheckInLicense")
    )
    input_: capo_license_manager.types.check_in_license_request.CheckInLicenseRequest = {
        "license_consumption_token": license_consumption_token
    }
    if beneficiary is not None:
        input_["beneficiary"] = beneficiary

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output