Skip to content

Type definitions#

Index > signer > Type definitions

Auto-generated documentation for signer type annotations stubs module mypy-boto3-signer.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AddProfilePermissionRequestRequestTypeDef#

# AddProfilePermissionRequestRequestTypeDef definition

class AddProfilePermissionRequestRequestTypeDef(TypedDict):
    profileName: str,
    action: str,
    principal: str,
    statementId: str,
    profileVersion: NotRequired[str],
    revisionId: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CancelSigningProfileRequestRequestTypeDef#

# CancelSigningProfileRequestRequestTypeDef definition

class CancelSigningProfileRequestRequestTypeDef(TypedDict):
    profileName: str,

DescribeSigningJobRequestRequestTypeDef#

# DescribeSigningJobRequestRequestTypeDef definition

class DescribeSigningJobRequestRequestTypeDef(TypedDict):
    jobId: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

SigningJobRevocationRecordTypeDef#

# SigningJobRevocationRecordTypeDef definition

class SigningJobRevocationRecordTypeDef(TypedDict):
    reason: NotRequired[str],
    revokedAt: NotRequired[datetime],
    revokedBy: NotRequired[str],

SigningMaterialTypeDef#

# SigningMaterialTypeDef definition

class SigningMaterialTypeDef(TypedDict):
    certificateArn: str,

S3DestinationTypeDef#

# S3DestinationTypeDef definition

class S3DestinationTypeDef(TypedDict):
    bucketName: NotRequired[str],
    prefix: NotRequired[str],

EncryptionAlgorithmOptionsTypeDef#

# EncryptionAlgorithmOptionsTypeDef definition

class EncryptionAlgorithmOptionsTypeDef(TypedDict):
    allowedValues: List[EncryptionAlgorithmType],  # (1)
    defaultValue: EncryptionAlgorithmType,  # (2)
  1. See EncryptionAlgorithmType
  2. See EncryptionAlgorithmType

GetSigningPlatformRequestRequestTypeDef#

# GetSigningPlatformRequestRequestTypeDef definition

class GetSigningPlatformRequestRequestTypeDef(TypedDict):
    platformId: str,

SigningImageFormatTypeDef#

# SigningImageFormatTypeDef definition

class SigningImageFormatTypeDef(TypedDict):
    supportedFormats: List[ImageFormatType],  # (1)
    defaultFormat: ImageFormatType,  # (2)
  1. See ImageFormatType
  2. See ImageFormatType

GetSigningProfileRequestRequestTypeDef#

# GetSigningProfileRequestRequestTypeDef definition

class GetSigningProfileRequestRequestTypeDef(TypedDict):
    profileName: str,
    profileOwner: NotRequired[str],

SignatureValidityPeriodTypeDef#

# SignatureValidityPeriodTypeDef definition

class SignatureValidityPeriodTypeDef(TypedDict):
    value: NotRequired[int],
    type: NotRequired[ValidityTypeType],  # (1)
  1. See ValidityTypeType

SigningProfileRevocationRecordTypeDef#

# SigningProfileRevocationRecordTypeDef definition

class SigningProfileRevocationRecordTypeDef(TypedDict):
    revocationEffectiveFrom: NotRequired[datetime],
    revokedAt: NotRequired[datetime],
    revokedBy: NotRequired[str],

HashAlgorithmOptionsTypeDef#

# HashAlgorithmOptionsTypeDef definition

class HashAlgorithmOptionsTypeDef(TypedDict):
    allowedValues: List[HashAlgorithmType],  # (1)
    defaultValue: HashAlgorithmType,  # (2)
  1. See HashAlgorithmType
  2. See HashAlgorithmType

ListProfilePermissionsRequestRequestTypeDef#

# ListProfilePermissionsRequestRequestTypeDef definition

class ListProfilePermissionsRequestRequestTypeDef(TypedDict):
    profileName: str,
    nextToken: NotRequired[str],

PermissionTypeDef#

# PermissionTypeDef definition

class PermissionTypeDef(TypedDict):
    action: NotRequired[str],
    principal: NotRequired[str],
    statementId: NotRequired[str],
    profileVersion: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListSigningPlatformsRequestRequestTypeDef#

# ListSigningPlatformsRequestRequestTypeDef definition

class ListSigningPlatformsRequestRequestTypeDef(TypedDict):
    category: NotRequired[str],
    partner: NotRequired[str],
    target: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListSigningProfilesRequestRequestTypeDef#

# ListSigningProfilesRequestRequestTypeDef definition

class ListSigningProfilesRequestRequestTypeDef(TypedDict):
    includeCanceled: NotRequired[bool],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    platformId: NotRequired[str],
    statuses: NotRequired[Sequence[SigningProfileStatusType]],  # (1)
  1. See SigningProfileStatusType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

RemoveProfilePermissionRequestRequestTypeDef#

# RemoveProfilePermissionRequestRequestTypeDef definition

class RemoveProfilePermissionRequestRequestTypeDef(TypedDict):
    profileName: str,
    revisionId: str,
    statementId: str,

RevokeSignatureRequestRequestTypeDef#

# RevokeSignatureRequestRequestTypeDef definition

class RevokeSignatureRequestRequestTypeDef(TypedDict):
    jobId: str,
    reason: str,
    jobOwner: NotRequired[str],

S3SignedObjectTypeDef#

# S3SignedObjectTypeDef definition

class S3SignedObjectTypeDef(TypedDict):
    bucketName: NotRequired[str],
    key: NotRequired[str],

S3SourceTypeDef#

# S3SourceTypeDef definition

class S3SourceTypeDef(TypedDict):
    bucketName: str,
    key: str,
    version: str,

SigningConfigurationOverridesTypeDef#

# SigningConfigurationOverridesTypeDef definition

class SigningConfigurationOverridesTypeDef(TypedDict):
    encryptionAlgorithm: NotRequired[EncryptionAlgorithmType],  # (1)
    hashAlgorithm: NotRequired[HashAlgorithmType],  # (2)
  1. See EncryptionAlgorithmType
  2. See HashAlgorithmType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

AddProfilePermissionResponseTypeDef#

# AddProfilePermissionResponseTypeDef definition

class AddProfilePermissionResponseTypeDef(TypedDict):
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetRevocationStatusResponseTypeDef#

# GetRevocationStatusResponseTypeDef definition

class GetRevocationStatusResponseTypeDef(TypedDict):
    revokedEntities: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutSigningProfileResponseTypeDef#

# PutSigningProfileResponseTypeDef definition

class PutSigningProfileResponseTypeDef(TypedDict):
    arn: str,
    profileVersion: str,
    profileVersionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RemoveProfilePermissionResponseTypeDef#

# RemoveProfilePermissionResponseTypeDef definition

class RemoveProfilePermissionResponseTypeDef(TypedDict):
    revisionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SignPayloadResponseTypeDef#

# SignPayloadResponseTypeDef definition

class SignPayloadResponseTypeDef(TypedDict):
    jobId: str,
    jobOwner: str,
    metadata: Dict[str, str],
    signature: bytes,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartSigningJobResponseTypeDef#

# StartSigningJobResponseTypeDef definition

class StartSigningJobResponseTypeDef(TypedDict):
    jobId: str,
    jobOwner: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SignPayloadRequestRequestTypeDef#

# SignPayloadRequestRequestTypeDef definition

class SignPayloadRequestRequestTypeDef(TypedDict):
    profileName: str,
    payload: Union[str, bytes, IO[Any], StreamingBody],
    payloadFormat: str,
    profileOwner: NotRequired[str],

DescribeSigningJobRequestSuccessfulSigningJobWaitTypeDef#

# DescribeSigningJobRequestSuccessfulSigningJobWaitTypeDef definition

class DescribeSigningJobRequestSuccessfulSigningJobWaitTypeDef(TypedDict):
    jobId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DestinationTypeDef#

# DestinationTypeDef definition

class DestinationTypeDef(TypedDict):
    s3: NotRequired[S3DestinationTypeDef],  # (1)
  1. See S3DestinationTypeDef

GetRevocationStatusRequestRequestTypeDef#

# GetRevocationStatusRequestRequestTypeDef definition

class GetRevocationStatusRequestRequestTypeDef(TypedDict):
    signatureTimestamp: Union[datetime, str],
    platformId: str,
    profileVersionArn: str,
    jobArn: str,
    certificateHashes: Sequence[str],

ListSigningJobsRequestRequestTypeDef#

# ListSigningJobsRequestRequestTypeDef definition

class ListSigningJobsRequestRequestTypeDef(TypedDict):
    status: NotRequired[SigningStatusType],  # (1)
    platformId: NotRequired[str],
    requestedBy: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    isRevoked: NotRequired[bool],
    signatureExpiresBefore: NotRequired[Union[datetime, str]],
    signatureExpiresAfter: NotRequired[Union[datetime, str]],
    jobInvoker: NotRequired[str],
  1. See SigningStatusType

RevokeSigningProfileRequestRequestTypeDef#

# RevokeSigningProfileRequestRequestTypeDef definition

class RevokeSigningProfileRequestRequestTypeDef(TypedDict):
    profileName: str,
    profileVersion: str,
    reason: str,
    effectiveTime: Union[datetime, str],

SigningProfileTypeDef#

# SigningProfileTypeDef definition

class SigningProfileTypeDef(TypedDict):
    profileName: NotRequired[str],
    profileVersion: NotRequired[str],
    profileVersionArn: NotRequired[str],
    signingMaterial: NotRequired[SigningMaterialTypeDef],  # (1)
    signatureValidityPeriod: NotRequired[SignatureValidityPeriodTypeDef],  # (2)
    platformId: NotRequired[str],
    platformDisplayName: NotRequired[str],
    signingParameters: NotRequired[Dict[str, str]],
    status: NotRequired[SigningProfileStatusType],  # (3)
    arn: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
  1. See SigningMaterialTypeDef
  2. See SignatureValidityPeriodTypeDef
  3. See SigningProfileStatusType

SigningConfigurationTypeDef#

# SigningConfigurationTypeDef definition

class SigningConfigurationTypeDef(TypedDict):
    encryptionAlgorithmOptions: EncryptionAlgorithmOptionsTypeDef,  # (1)
    hashAlgorithmOptions: HashAlgorithmOptionsTypeDef,  # (2)
  1. See EncryptionAlgorithmOptionsTypeDef
  2. See HashAlgorithmOptionsTypeDef

ListProfilePermissionsResponseTypeDef#

# ListProfilePermissionsResponseTypeDef definition

class ListProfilePermissionsResponseTypeDef(TypedDict):
    revisionId: str,
    policySizeBytes: int,
    permissions: List[PermissionTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PermissionTypeDef
  2. See ResponseMetadataTypeDef

ListSigningJobsRequestListSigningJobsPaginateTypeDef#

# ListSigningJobsRequestListSigningJobsPaginateTypeDef definition

class ListSigningJobsRequestListSigningJobsPaginateTypeDef(TypedDict):
    status: NotRequired[SigningStatusType],  # (1)
    platformId: NotRequired[str],
    requestedBy: NotRequired[str],
    isRevoked: NotRequired[bool],
    signatureExpiresBefore: NotRequired[Union[datetime, str]],
    signatureExpiresAfter: NotRequired[Union[datetime, str]],
    jobInvoker: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SigningStatusType
  2. See PaginatorConfigTypeDef

ListSigningPlatformsRequestListSigningPlatformsPaginateTypeDef#

# ListSigningPlatformsRequestListSigningPlatformsPaginateTypeDef definition

class ListSigningPlatformsRequestListSigningPlatformsPaginateTypeDef(TypedDict):
    category: NotRequired[str],
    partner: NotRequired[str],
    target: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListSigningProfilesRequestListSigningProfilesPaginateTypeDef#

# ListSigningProfilesRequestListSigningProfilesPaginateTypeDef definition

class ListSigningProfilesRequestListSigningProfilesPaginateTypeDef(TypedDict):
    includeCanceled: NotRequired[bool],
    platformId: NotRequired[str],
    statuses: NotRequired[Sequence[SigningProfileStatusType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SigningProfileStatusType
  2. See PaginatorConfigTypeDef

SignedObjectTypeDef#

# SignedObjectTypeDef definition

class SignedObjectTypeDef(TypedDict):
    s3: NotRequired[S3SignedObjectTypeDef],  # (1)
  1. See S3SignedObjectTypeDef

SourceTypeDef#

# SourceTypeDef definition

class SourceTypeDef(TypedDict):
    s3: NotRequired[S3SourceTypeDef],  # (1)
  1. See S3SourceTypeDef

SigningPlatformOverridesTypeDef#

# SigningPlatformOverridesTypeDef definition

class SigningPlatformOverridesTypeDef(TypedDict):
    signingConfiguration: NotRequired[SigningConfigurationOverridesTypeDef],  # (1)
    signingImageFormat: NotRequired[ImageFormatType],  # (2)
  1. See SigningConfigurationOverridesTypeDef
  2. See ImageFormatType

ListSigningProfilesResponseTypeDef#

# ListSigningProfilesResponseTypeDef definition

class ListSigningProfilesResponseTypeDef(TypedDict):
    profiles: List[SigningProfileTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SigningProfileTypeDef
  2. See ResponseMetadataTypeDef

GetSigningPlatformResponseTypeDef#

# GetSigningPlatformResponseTypeDef definition

class GetSigningPlatformResponseTypeDef(TypedDict):
    platformId: str,
    displayName: str,
    partner: str,
    target: str,
    category: CategoryType,  # (1)
    signingConfiguration: SigningConfigurationTypeDef,  # (2)
    signingImageFormat: SigningImageFormatTypeDef,  # (3)
    maxSizeInMB: int,
    revocationSupported: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See CategoryType
  2. See SigningConfigurationTypeDef
  3. See SigningImageFormatTypeDef
  4. See ResponseMetadataTypeDef

SigningPlatformTypeDef#

# SigningPlatformTypeDef definition

class SigningPlatformTypeDef(TypedDict):
    platformId: NotRequired[str],
    displayName: NotRequired[str],
    partner: NotRequired[str],
    target: NotRequired[str],
    category: NotRequired[CategoryType],  # (1)
    signingConfiguration: NotRequired[SigningConfigurationTypeDef],  # (2)
    signingImageFormat: NotRequired[SigningImageFormatTypeDef],  # (3)
    maxSizeInMB: NotRequired[int],
    revocationSupported: NotRequired[bool],
  1. See CategoryType
  2. See SigningConfigurationTypeDef
  3. See SigningImageFormatTypeDef

SigningJobTypeDef#

# SigningJobTypeDef definition

class SigningJobTypeDef(TypedDict):
    jobId: NotRequired[str],
    source: NotRequired[SourceTypeDef],  # (1)
    signedObject: NotRequired[SignedObjectTypeDef],  # (2)
    signingMaterial: NotRequired[SigningMaterialTypeDef],  # (3)
    createdAt: NotRequired[datetime],
    status: NotRequired[SigningStatusType],  # (4)
    isRevoked: NotRequired[bool],
    profileName: NotRequired[str],
    profileVersion: NotRequired[str],
    platformId: NotRequired[str],
    platformDisplayName: NotRequired[str],
    signatureExpiresAt: NotRequired[datetime],
    jobOwner: NotRequired[str],
    jobInvoker: NotRequired[str],
  1. See SourceTypeDef
  2. See SignedObjectTypeDef
  3. See SigningMaterialTypeDef
  4. See SigningStatusType

StartSigningJobRequestRequestTypeDef#

# StartSigningJobRequestRequestTypeDef definition

class StartSigningJobRequestRequestTypeDef(TypedDict):
    source: SourceTypeDef,  # (1)
    destination: DestinationTypeDef,  # (2)
    profileName: str,
    clientRequestToken: str,
    profileOwner: NotRequired[str],
  1. See SourceTypeDef
  2. See DestinationTypeDef

DescribeSigningJobResponseTypeDef#

# DescribeSigningJobResponseTypeDef definition

class DescribeSigningJobResponseTypeDef(TypedDict):
    jobId: str,
    source: SourceTypeDef,  # (1)
    signingMaterial: SigningMaterialTypeDef,  # (2)
    platformId: str,
    platformDisplayName: str,
    profileName: str,
    profileVersion: str,
    overrides: SigningPlatformOverridesTypeDef,  # (3)
    signingParameters: Dict[str, str],
    createdAt: datetime,
    completedAt: datetime,
    signatureExpiresAt: datetime,
    requestedBy: str,
    status: SigningStatusType,  # (4)
    statusReason: str,
    revocationRecord: SigningJobRevocationRecordTypeDef,  # (5)
    signedObject: SignedObjectTypeDef,  # (6)
    jobOwner: str,
    jobInvoker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)
  1. See SourceTypeDef
  2. See SigningMaterialTypeDef
  3. See SigningPlatformOverridesTypeDef
  4. See SigningStatusType
  5. See SigningJobRevocationRecordTypeDef
  6. See SignedObjectTypeDef
  7. See ResponseMetadataTypeDef

GetSigningProfileResponseTypeDef#

# GetSigningProfileResponseTypeDef definition

class GetSigningProfileResponseTypeDef(TypedDict):
    profileName: str,
    profileVersion: str,
    profileVersionArn: str,
    revocationRecord: SigningProfileRevocationRecordTypeDef,  # (1)
    signingMaterial: SigningMaterialTypeDef,  # (2)
    platformId: str,
    platformDisplayName: str,
    signatureValidityPeriod: SignatureValidityPeriodTypeDef,  # (3)
    overrides: SigningPlatformOverridesTypeDef,  # (4)
    signingParameters: Dict[str, str],
    status: SigningProfileStatusType,  # (5)
    statusReason: str,
    arn: str,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See SigningProfileRevocationRecordTypeDef
  2. See SigningMaterialTypeDef
  3. See SignatureValidityPeriodTypeDef
  4. See SigningPlatformOverridesTypeDef
  5. See SigningProfileStatusType
  6. See ResponseMetadataTypeDef

PutSigningProfileRequestRequestTypeDef#

# PutSigningProfileRequestRequestTypeDef definition

class PutSigningProfileRequestRequestTypeDef(TypedDict):
    profileName: str,
    platformId: str,
    signingMaterial: NotRequired[SigningMaterialTypeDef],  # (1)
    signatureValidityPeriod: NotRequired[SignatureValidityPeriodTypeDef],  # (2)
    overrides: NotRequired[SigningPlatformOverridesTypeDef],  # (3)
    signingParameters: NotRequired[Mapping[str, str]],
    tags: NotRequired[Mapping[str, str]],
  1. See SigningMaterialTypeDef
  2. See SignatureValidityPeriodTypeDef
  3. See SigningPlatformOverridesTypeDef

ListSigningPlatformsResponseTypeDef#

# ListSigningPlatformsResponseTypeDef definition

class ListSigningPlatformsResponseTypeDef(TypedDict):
    platforms: List[SigningPlatformTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SigningPlatformTypeDef
  2. See ResponseMetadataTypeDef

ListSigningJobsResponseTypeDef#

# ListSigningJobsResponseTypeDef definition

class ListSigningJobsResponseTypeDef(TypedDict):
    jobs: List[SigningJobTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SigningJobTypeDef
  2. See ResponseMetadataTypeDef