signer / Client / sign_payload

sign_payload

signer.Client.sign_payload(**kwargs)

Signs a binary payload and returns a signature envelope.

See also: AWS API Documentation

Request Syntax

response = client.sign_payload(
    profileName='string',
    profileOwner='string',
    payload=b'bytes',
    payloadFormat='string'
)

Parameters:

• profileName (string) –

  [REQUIRED]

  The name of the signing profile.

• profileOwner (string) – The AWS account ID of the profile owner.

• payload (bytes) –

  [REQUIRED]

  Specifies the object digest (hash) to sign.

• payloadFormat (string) –

  [REQUIRED]

  Payload content type. The single valid type is application/vnd.cncf.notary.payload.v1+json.

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    'jobOwner': 'string',
    'metadata': {
        'string': 'string'
    },
    'signature': b'bytes'
}

Response Structure

• (dict) –

  • jobId (string) –

    Unique identifier of the signing job.

  • jobOwner (string) –

    The AWS account ID of the job owner.

  • metadata (dict) –

    Information including the signing profile ARN and the signing job ID.

    • (string) –

      • (string) –

  • signature (bytes) –

    A cryptographic signature.

Exceptions

• signer.Client.exceptions.ValidationException

• signer.Client.exceptions.ResourceNotFoundException

• signer.Client.exceptions.AccessDeniedException

• signer.Client.exceptions.TooManyRequestsException

• signer.Client.exceptions.InternalServiceErrorException