Skip to content

revoke_signing_profile

revoke_signing_profile(
    profile_name: ProfileName,
    profile_version: ProfileVersion,
    reason: RevocationReasonString,
    effective_time: Timestamp,
    *,
    config_overrides: Optional[signerClientConfig] = None,
) -> None

Changes the state of a signing profile to REVOKED. This indicates that signatures generated using the signing profile after an effective start date are no longer valid. A revoked profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs. See Data Retention for more information on scheduled deletion of a revoked signing profile.

Parameters:

  • profile_name (ProfileName) –

    The name of the signing profile to be revoked.

  • profile_version (ProfileVersion) –

    The version of the signing profile to be revoked.

  • reason (RevocationReasonString) –

    The reason for revoking a signing profile.

  • effective_time (Timestamp) –

    A timestamp for when revocation of a Signing Profile should become effective. Signatures generated using the signing profile after this timestamp are not trusted.

Raises:

Source code in docs_src/capo_signer/_services/signer.py
def revoke_signing_profile(
    self,
    profile_name: "capo_signer.types.profile_name.ProfileName",
    profile_version: "capo_signer.types.profile_version.ProfileVersion",
    reason: "capo_signer.types.revocation_reason_string.RevocationReasonString",
    effective_time: "capo_signer.types.timestamp.Timestamp",
    *,
    config_overrides: Optional[signerClientConfig] = None,
) -> None:
    """<p>Changes the state of a signing profile to <code>REVOKED</code>. This indicates that signatures generated using the signing profile after an effective start date are no longer valid. A revoked profile is still viewable with the <code>ListSigningProfiles</code> operation, but it cannot perform new signing jobs. See <a href="https://docs.aws.amazon.com/signer/latest/developerguide/retention.html">Data Retention</a> for more information on scheduled deletion of a revoked signing profile. </p>

    Args:
        profile_name: <p>The name of the signing profile to be revoked.</p>
        profile_version: <p>The version of the signing profile to be revoked.</p>
        reason: <p>The reason for revoking a signing profile.</p>
        effective_time: <p>A timestamp for when revocation of a Signing Profile should become effective. Signatures generated using the signing profile after this timestamp are not trusted.</p>

    Raises:
        capo_signer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_signer.errors.internal_service_error_exception.InternalServiceErrorException: <p>An internal error occurred.</p>
        capo_signer.errors.resource_not_found_exception.ResourceNotFoundException: <p>A specified resource could not be found.</p>
        capo_signer.errors.too_many_requests_exception.TooManyRequestsException: <p>The allowed number of job-signing requests has been exceeded.</p> <p>This error supersedes the error <code>ThrottlingException</code>.</p>
        capo_signer.errors.validation_exception.ValidationException: <p>You signing certificate could not be validated.</p>
        capo_signer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_signer.types.revoke_signing_profile_request.RevokeSigningProfileRequest]",
    ) -> OperationResponse[None]:
        import capo_signer._operations.wallaby_service.revoke_signing_profile

        output, http_response = (
            capo_signer._operations.wallaby_service.revoke_signing_profile.revoke_signing_profile(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RevokeSigningProfile")
    )
    input_: capo_signer.types.revoke_signing_profile_request.RevokeSigningProfileRequest = {
        "profile_name": profile_name,
        "profile_version": profile_version,
        "reason": reason,
        "effective_time": effective_time,
    }

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