signerClient

Index > signer > signerClient

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

signerClient

Type annotations and code completion for boto3.client("signer"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_signer.client import signerClient

def get_signer_client() -> signerClient:
    return Session().client("signer")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("signer").exceptions structure.

Usage example

client = boto3.client("signer")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.BadRequestException,
    client.ClientError,
    client.ConflictException,
    client.InternalServiceErrorException,
    client.NotFoundException,
    client.ResourceNotFoundException,
    client.ServiceLimitExceededException,
    client.ThrottlingException,
    client.TooManyRequestsException,
    client.ValidationException,
) as e:
    print(e)

Type checking example

from mypy_boto3_signer.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

add_profile_permission

Adds cross-account permissions to a signing profile.

Type annotations and code completion for boto3.client("signer").add_profile_permission method. boto3 documentation

Method definition

def add_profile_permission(
    self,
    *,
    profileName: str,
    action: str,
    principal: str,
    statementId: str,
    profileVersion: str = ...,
    revisionId: str = ...,
) -> AddProfilePermissionResponseTypeDef:  # (1)
    ...

1. See AddProfilePermissionResponseTypeDef

Usage example with kwargs

kwargs: AddProfilePermissionRequestRequestTypeDef = {  # (1)
    "profileName": ...,
    "action": ...,
    "principal": ...,
    "statementId": ...,
}

parent.add_profile_permission(**kwargs)

1. See AddProfilePermissionRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("signer").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_signing_profile

Changes the state of an ACTIVE signing profile to CANCELED.

Type annotations and code completion for boto3.client("signer").cancel_signing_profile method. boto3 documentation

Method definition

def cancel_signing_profile(
    self,
    *,
    profileName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: CancelSigningProfileRequestRequestTypeDef = {  # (1)
    "profileName": ...,
}

parent.cancel_signing_profile(**kwargs)

1. See CancelSigningProfileRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("signer").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

describe_signing_job

Returns information about a specific code signing job.

Type annotations and code completion for boto3.client("signer").describe_signing_job method. boto3 documentation

Method definition

def describe_signing_job(
    self,
    *,
    jobId: str,
) -> DescribeSigningJobResponseTypeDef:  # (1)
    ...

1. See DescribeSigningJobResponseTypeDef

Usage example with kwargs

kwargs: DescribeSigningJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.describe_signing_job(**kwargs)

1. See DescribeSigningJobRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("signer").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_signing_platform

Returns information on a specific signing platform.

Type annotations and code completion for boto3.client("signer").get_signing_platform method. boto3 documentation

Method definition

def get_signing_platform(
    self,
    *,
    platformId: str,
) -> GetSigningPlatformResponseTypeDef:  # (1)
    ...

1. See GetSigningPlatformResponseTypeDef

Usage example with kwargs

kwargs: GetSigningPlatformRequestRequestTypeDef = {  # (1)
    "platformId": ...,
}

parent.get_signing_platform(**kwargs)

1. See GetSigningPlatformRequestRequestTypeDef

get_signing_profile

Returns information on a specific signing profile.

Type annotations and code completion for boto3.client("signer").get_signing_profile method. boto3 documentation

Method definition

def get_signing_profile(
    self,
    *,
    profileName: str,
    profileOwner: str = ...,
) -> GetSigningProfileResponseTypeDef:  # (1)
    ...

1. See GetSigningProfileResponseTypeDef

Usage example with kwargs

kwargs: GetSigningProfileRequestRequestTypeDef = {  # (1)
    "profileName": ...,
}

parent.get_signing_profile(**kwargs)

1. See GetSigningProfileRequestRequestTypeDef

list_profile_permissions

Lists the cross-account permissions associated with a signing profile.

Type annotations and code completion for boto3.client("signer").list_profile_permissions method. boto3 documentation

Method definition

def list_profile_permissions(
    self,
    *,
    profileName: str,
    nextToken: str = ...,
) -> ListProfilePermissionsResponseTypeDef:  # (1)
    ...

1. See ListProfilePermissionsResponseTypeDef

Usage example with kwargs

kwargs: ListProfilePermissionsRequestRequestTypeDef = {  # (1)
    "profileName": ...,
}

parent.list_profile_permissions(**kwargs)

1. See ListProfilePermissionsRequestRequestTypeDef

list_signing_jobs

Lists all your signing jobs.

Type annotations and code completion for boto3.client("signer").list_signing_jobs method. boto3 documentation

Method definition

def list_signing_jobs(
    self,
    *,
    status: SigningStatusType = ...,  # (1)
    platformId: str = ...,
    requestedBy: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    isRevoked: bool = ...,
    signatureExpiresBefore: Union[datetime, str] = ...,
    signatureExpiresAfter: Union[datetime, str] = ...,
    jobInvoker: str = ...,
) -> ListSigningJobsResponseTypeDef:  # (2)
    ...

1. See SigningStatusType
2. See ListSigningJobsResponseTypeDef

Usage example with kwargs

kwargs: ListSigningJobsRequestRequestTypeDef = {  # (1)
    "status": ...,
}

parent.list_signing_jobs(**kwargs)

1. See ListSigningJobsRequestRequestTypeDef

list_signing_platforms

Lists all signing platforms available in code signing that match the request parameters.

Type annotations and code completion for boto3.client("signer").list_signing_platforms method. boto3 documentation

Method definition

def list_signing_platforms(
    self,
    *,
    category: str = ...,
    partner: str = ...,
    target: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSigningPlatformsResponseTypeDef:  # (1)
    ...

1. See ListSigningPlatformsResponseTypeDef

Usage example with kwargs

kwargs: ListSigningPlatformsRequestRequestTypeDef = {  # (1)
    "category": ...,
}

parent.list_signing_platforms(**kwargs)

1. See ListSigningPlatformsRequestRequestTypeDef

list_signing_profiles

Lists all available signing profiles in your AWS account.

Type annotations and code completion for boto3.client("signer").list_signing_profiles method. boto3 documentation

Method definition

def list_signing_profiles(
    self,
    *,
    includeCanceled: bool = ...,
    maxResults: int = ...,
    nextToken: str = ...,
    platformId: str = ...,
    statuses: Sequence[SigningProfileStatusType] = ...,  # (1)
) -> ListSigningProfilesResponseTypeDef:  # (2)
    ...

1. See SigningProfileStatusType
2. See ListSigningProfilesResponseTypeDef

Usage example with kwargs

kwargs: ListSigningProfilesRequestRequestTypeDef = {  # (1)
    "includeCanceled": ...,
}

parent.list_signing_profiles(**kwargs)

1. See ListSigningProfilesRequestRequestTypeDef

list_tags_for_resource

Returns a list of the tags associated with a signing profile resource.

Type annotations and code completion for boto3.client("signer").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_signing_profile

Creates a signing profile.

Type annotations and code completion for boto3.client("signer").put_signing_profile method. boto3 documentation

Method definition

def put_signing_profile(
    self,
    *,
    profileName: str,
    platformId: str,
    signingMaterial: SigningMaterialTypeDef = ...,  # (1)
    signatureValidityPeriod: SignatureValidityPeriodTypeDef = ...,  # (2)
    overrides: SigningPlatformOverridesTypeDef = ...,  # (3)
    signingParameters: Mapping[str, str] = ...,
    tags: Mapping[str, str] = ...,
) -> PutSigningProfileResponseTypeDef:  # (4)
    ...

1. See SigningMaterialTypeDef
2. See SignatureValidityPeriodTypeDef
3. See SigningPlatformOverridesTypeDef
4. See PutSigningProfileResponseTypeDef

Usage example with kwargs

kwargs: PutSigningProfileRequestRequestTypeDef = {  # (1)
    "profileName": ...,
    "platformId": ...,
}

parent.put_signing_profile(**kwargs)

1. See PutSigningProfileRequestRequestTypeDef

remove_profile_permission

Removes cross-account permissions from a signing profile.

Type annotations and code completion for boto3.client("signer").remove_profile_permission method. boto3 documentation

Method definition

def remove_profile_permission(
    self,
    *,
    profileName: str,
    revisionId: str,
    statementId: str,
) -> RemoveProfilePermissionResponseTypeDef:  # (1)
    ...

1. See RemoveProfilePermissionResponseTypeDef

Usage example with kwargs

kwargs: RemoveProfilePermissionRequestRequestTypeDef = {  # (1)
    "profileName": ...,
    "revisionId": ...,
    "statementId": ...,
}

parent.remove_profile_permission(**kwargs)

1. See RemoveProfilePermissionRequestRequestTypeDef

revoke_signature

Changes the state of a signing job to REVOKED.

Type annotations and code completion for boto3.client("signer").revoke_signature method. boto3 documentation

Method definition

def revoke_signature(
    self,
    *,
    jobId: str,
    reason: str,
    jobOwner: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: RevokeSignatureRequestRequestTypeDef = {  # (1)
    "jobId": ...,
    "reason": ...,
}

parent.revoke_signature(**kwargs)

1. See RevokeSignatureRequestRequestTypeDef

revoke_signing_profile

Changes the state of a signing profile to REVOKED.

Type annotations and code completion for boto3.client("signer").revoke_signing_profile method. boto3 documentation

Method definition

def revoke_signing_profile(
    self,
    *,
    profileName: str,
    profileVersion: str,
    reason: str,
    effectiveTime: Union[datetime, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: RevokeSigningProfileRequestRequestTypeDef = {  # (1)
    "profileName": ...,
    "profileVersion": ...,
    "reason": ...,
    "effectiveTime": ...,
}

parent.revoke_signing_profile(**kwargs)

1. See RevokeSigningProfileRequestRequestTypeDef

start_signing_job

Initiates a signing job to be performed on the code provided.

Type annotations and code completion for boto3.client("signer").start_signing_job method. boto3 documentation

Method definition

def start_signing_job(
    self,
    *,
    source: SourceTypeDef,  # (1)
    destination: DestinationTypeDef,  # (2)
    profileName: str,
    clientRequestToken: str,
    profileOwner: str = ...,
) -> StartSigningJobResponseTypeDef:  # (3)
    ...

1. See SourceTypeDef
2. See DestinationTypeDef
3. See StartSigningJobResponseTypeDef

Usage example with kwargs

kwargs: StartSigningJobRequestRequestTypeDef = {  # (1)
    "source": ...,
    "destination": ...,
    "profileName": ...,
    "clientRequestToken": ...,
}

parent.start_signing_job(**kwargs)

1. See StartSigningJobRequestRequestTypeDef

tag_resource

Adds one or more tags to a signing profile.

Type annotations and code completion for boto3.client("signer").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes one or more tags from a signing profile.

Type annotations and code completion for boto3.client("signer").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("signer").get_paginator method with overloads.

• client.get_paginator("list_signing_jobs") -> ListSigningJobsPaginator
• client.get_paginator("list_signing_platforms") -> ListSigningPlatformsPaginator
• client.get_paginator("list_signing_profiles") -> ListSigningProfilesPaginator

get_waiter

Type annotations and code completion for boto3.client("signer").get_waiter method with overloads.

• client.get_waiter("successful_signing_job") -> SuccessfulSigningJobWaiter