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
# SignerClient 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.
# Exceptions.exceptions usage example
client = boto3.client("signer")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServiceErrorException,
client.exceptions.NotFoundException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceLimitExceededException,
client.exceptions.ThrottlingException,
client.exceptions.TooManyRequestsException,
client.exceptions.ValidationException,
) as e:
print(e)# Exceptions.exceptions 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
# add_profile_permission method definition
def add_profile_permission(
self,
*,
profileName: str,
action: str,
principal: str,
statementId: str,
profileVersion: str = ...,
revisionId: str = ...,
) -> AddProfilePermissionResponseTypeDef: # (1)
...# add_profile_permission method usage example with argument unpacking
kwargs: AddProfilePermissionRequestRequestTypeDef = { # (1)
"profileName": ...,
"action": ...,
"principal": ...,
"statementId": ...,
}
parent.add_profile_permission(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("signer").can_paginate method.
boto3 documentation
# can_paginate 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
# cancel_signing_profile method definition
def cancel_signing_profile(
self,
*,
profileName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# cancel_signing_profile method usage example with argument unpacking
kwargs: CancelSigningProfileRequestRequestTypeDef = { # (1)
"profileName": ...,
}
parent.cancel_signing_profile(**kwargs)close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("signer").close method.
boto3 documentation
# close 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
# describe_signing_job method definition
def describe_signing_job(
self,
*,
jobId: str,
) -> DescribeSigningJobResponseTypeDef: # (1)
...# describe_signing_job method usage example with argument unpacking
kwargs: DescribeSigningJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.describe_signing_job(**kwargs)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
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_revocation_status#
Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.
Type annotations and code completion for boto3.client("signer").get_revocation_status method.
boto3 documentation
# get_revocation_status method definition
def get_revocation_status(
self,
*,
signatureTimestamp: TimestampTypeDef,
platformId: str,
profileVersionArn: str,
jobArn: str,
certificateHashes: Sequence[str],
) -> GetRevocationStatusResponseTypeDef: # (1)
...# get_revocation_status method usage example with argument unpacking
kwargs: GetRevocationStatusRequestRequestTypeDef = { # (1)
"signatureTimestamp": ...,
"platformId": ...,
"profileVersionArn": ...,
"jobArn": ...,
"certificateHashes": ...,
}
parent.get_revocation_status(**kwargs)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
# get_signing_platform method definition
def get_signing_platform(
self,
*,
platformId: str,
) -> GetSigningPlatformResponseTypeDef: # (1)
...# get_signing_platform method usage example with argument unpacking
kwargs: GetSigningPlatformRequestRequestTypeDef = { # (1)
"platformId": ...,
}
parent.get_signing_platform(**kwargs)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
# get_signing_profile method definition
def get_signing_profile(
self,
*,
profileName: str,
profileOwner: str = ...,
) -> GetSigningProfileResponseTypeDef: # (1)
...# get_signing_profile method usage example with argument unpacking
kwargs: GetSigningProfileRequestRequestTypeDef = { # (1)
"profileName": ...,
}
parent.get_signing_profile(**kwargs)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
# list_profile_permissions method definition
def list_profile_permissions(
self,
*,
profileName: str,
nextToken: str = ...,
) -> ListProfilePermissionsResponseTypeDef: # (1)
...# list_profile_permissions method usage example with argument unpacking
kwargs: ListProfilePermissionsRequestRequestTypeDef = { # (1)
"profileName": ...,
}
parent.list_profile_permissions(**kwargs)list_signing_jobs#
Lists all your signing jobs.
Type annotations and code completion for boto3.client("signer").list_signing_jobs method.
boto3 documentation
# list_signing_jobs method definition
def list_signing_jobs(
self,
*,
status: SigningStatusType = ..., # (1)
platformId: str = ...,
requestedBy: str = ...,
maxResults: int = ...,
nextToken: str = ...,
isRevoked: bool = ...,
signatureExpiresBefore: TimestampTypeDef = ...,
signatureExpiresAfter: TimestampTypeDef = ...,
jobInvoker: str = ...,
) -> ListSigningJobsResponseTypeDef: # (2)
...# list_signing_jobs method usage example with argument unpacking
kwargs: ListSigningJobsRequestRequestTypeDef = { # (1)
"status": ...,
}
parent.list_signing_jobs(**kwargs)list_signing_platforms#
Lists all signing platforms available in AWS Signer that match the request parameters.
Type annotations and code completion for boto3.client("signer").list_signing_platforms method.
boto3 documentation
# list_signing_platforms method definition
def list_signing_platforms(
self,
*,
category: str = ...,
partner: str = ...,
target: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListSigningPlatformsResponseTypeDef: # (1)
...# list_signing_platforms method usage example with argument unpacking
kwargs: ListSigningPlatformsRequestRequestTypeDef = { # (1)
"category": ...,
}
parent.list_signing_platforms(**kwargs)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
# list_signing_profiles method definition
def list_signing_profiles(
self,
*,
includeCanceled: bool = ...,
maxResults: int = ...,
nextToken: str = ...,
platformId: str = ...,
statuses: Sequence[SigningProfileStatusType] = ..., # (1)
) -> ListSigningProfilesResponseTypeDef: # (2)
...# list_signing_profiles method usage example with argument unpacking
kwargs: ListSigningProfilesRequestRequestTypeDef = { # (1)
"includeCanceled": ...,
}
parent.list_signing_profiles(**kwargs)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
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)put_signing_profile#
Creates a signing profile.
Type annotations and code completion for boto3.client("signer").put_signing_profile method.
boto3 documentation
# put_signing_profile 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)
...- See SigningMaterialTypeDef
- See SignatureValidityPeriodTypeDef
- See SigningPlatformOverridesTypeDef
- See PutSigningProfileResponseTypeDef
# put_signing_profile method usage example with argument unpacking
kwargs: PutSigningProfileRequestRequestTypeDef = { # (1)
"profileName": ...,
"platformId": ...,
}
parent.put_signing_profile(**kwargs)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
# remove_profile_permission method definition
def remove_profile_permission(
self,
*,
profileName: str,
revisionId: str,
statementId: str,
) -> RemoveProfilePermissionResponseTypeDef: # (1)
...# remove_profile_permission method usage example with argument unpacking
kwargs: RemoveProfilePermissionRequestRequestTypeDef = { # (1)
"profileName": ...,
"revisionId": ...,
"statementId": ...,
}
parent.remove_profile_permission(**kwargs)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
# revoke_signature method definition
def revoke_signature(
self,
*,
jobId: str,
reason: str,
jobOwner: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# revoke_signature method usage example with argument unpacking
kwargs: RevokeSignatureRequestRequestTypeDef = { # (1)
"jobId": ...,
"reason": ...,
}
parent.revoke_signature(**kwargs)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
# revoke_signing_profile method definition
def revoke_signing_profile(
self,
*,
profileName: str,
profileVersion: str,
reason: str,
effectiveTime: TimestampTypeDef,
) -> EmptyResponseMetadataTypeDef: # (1)
...# revoke_signing_profile method usage example with argument unpacking
kwargs: RevokeSigningProfileRequestRequestTypeDef = { # (1)
"profileName": ...,
"profileVersion": ...,
"reason": ...,
"effectiveTime": ...,
}
parent.revoke_signing_profile(**kwargs)sign_payload#
Signs a binary payload and returns a signature envelope.
Type annotations and code completion for boto3.client("signer").sign_payload method.
boto3 documentation
# sign_payload method definition
def sign_payload(
self,
*,
profileName: str,
payload: BlobTypeDef,
payloadFormat: str,
profileOwner: str = ...,
) -> SignPayloadResponseTypeDef: # (1)
...# sign_payload method usage example with argument unpacking
kwargs: SignPayloadRequestRequestTypeDef = { # (1)
"profileName": ...,
"payload": ...,
"payloadFormat": ...,
}
parent.sign_payload(**kwargs)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
# start_signing_job method definition
def start_signing_job(
self,
*,
source: SourceTypeDef, # (1)
destination: DestinationTypeDef, # (2)
profileName: str,
clientRequestToken: str,
profileOwner: str = ...,
) -> StartSigningJobResponseTypeDef: # (3)
...# start_signing_job method usage example with argument unpacking
kwargs: StartSigningJobRequestRequestTypeDef = { # (1)
"source": ...,
"destination": ...,
"profileName": ...,
"clientRequestToken": ...,
}
parent.start_signing_job(**kwargs)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
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)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
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("signer").get_paginator method with overloads.
client.get_paginator("list_signing_jobs")-> ListSigningJobsPaginatorclient.get_paginator("list_signing_platforms")-> ListSigningPlatformsPaginatorclient.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