com.amazonaws.services.signer

Class AWSsignerClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.signer.AWSsignerClient

All Implemented Interfaces:

AWSsigner

Direct Known Subclasses:

AWSsignerAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSsignerClient
extends AmazonWebServiceClient
implements AWSsigner

Client for accessing signer. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Signer is a fully managed code-signing service to help you ensure the trust and integrity of your code.

Signer supports the following applications:

With code signing for AWS Lambda, you can sign AWS Lambda deployment packages. Integrated support is provided for Amazon S3, Amazon CloudWatch, and AWS CloudTrail. In order to sign code, you create a signing profile and then use Signer to sign Lambda zip files in S3.

With code signing for IoT, you can sign code for any IoT device that is supported by AWS. IoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is integrated with AWS Certificate Manager (ACM). In order to sign code, you Project, you can sign container images stored in a container registry such as Amazon Elastic Container Registry (ECR). The signatures are stored in the registry alongside the images, where they are available for verifying image authenticity and integrity.

For more information about Signer, see the AWS Signer Developer Guide.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.signer.AWSsigner

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AddProfilePermissionResult	addProfilePermission(AddProfilePermissionRequest request) Adds cross-account permissions to a signing profile.
static AWSsignerClientBuilder	builder()
CancelSigningProfileResult	cancelSigningProfile(CancelSigningProfileRequest request) Changes the state of an ACTIVE signing profile to CANCELED.
DescribeSigningJobResult	describeSigningJob(DescribeSigningJobRequest request) Returns information about a specific code signing job.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetRevocationStatusResult	getRevocationStatus(GetRevocationStatusRequest request) Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.
GetSigningPlatformResult	getSigningPlatform(GetSigningPlatformRequest request) Returns information on a specific signing platform.
GetSigningProfileResult	getSigningProfile(GetSigningProfileRequest request) Returns information on a specific signing profile.
ListProfilePermissionsResult	listProfilePermissions(ListProfilePermissionsRequest request) Lists the cross-account permissions associated with a signing profile.
ListSigningJobsResult	listSigningJobs(ListSigningJobsRequest request) Lists all your signing jobs.
ListSigningPlatformsResult	listSigningPlatforms(ListSigningPlatformsRequest request) Lists all signing platforms available in AWS Signer that match the request parameters.
ListSigningProfilesResult	listSigningProfiles(ListSigningProfilesRequest request) Lists all available signing profiles in your AWS account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of the tags associated with a signing profile resource.
PutSigningProfileResult	putSigningProfile(PutSigningProfileRequest request) Creates a signing profile.
RemoveProfilePermissionResult	removeProfilePermission(RemoveProfilePermissionRequest request) Removes cross-account permissions from a signing profile.
RevokeSignatureResult	revokeSignature(RevokeSignatureRequest request) Changes the state of a signing job to REVOKED.
RevokeSigningProfileResult	revokeSigningProfile(RevokeSigningProfileRequest request) Changes the state of a signing profile to REVOKED.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SignPayloadResult	signPayload(SignPayloadRequest request) Signs a binary payload and returns a signature envelope.
StartSigningJobResult	startSigningJob(StartSigningJobRequest request) Initiates a signing job to be performed on the code provided.
TagResourceResult	tagResource(TagResourceRequest request) Adds one or more tags to a signing profile.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes one or more tags from a signing profile.
AWSsignerWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSsignerClientBuilder builder()

addProfilePermission

public AddProfilePermissionResult addProfilePermission(AddProfilePermissionRequest request)

Adds cross-account permissions to a signing profile.

Specified by:

addProfilePermission in interface AWSsigner

Parameters:

addProfilePermissionRequest -

Returns:

Result of the AddProfilePermission operation returned by the service.

Throws:

ValidationException - You signing certificate could not be validated.

ResourceNotFoundException - A specified resource could not be found.

AccessDeniedException - You do not have sufficient access to perform this action.

ServiceLimitExceededException - The client is making a request that exceeds service limits.

ConflictException - The resource encountered a conflicting state.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

cancelSigningProfile

public CancelSigningProfileResult cancelSigningProfile(CancelSigningProfileRequest request)

Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

Specified by:

cancelSigningProfile in interface AWSsigner

Parameters:

cancelSigningProfileRequest -

Returns:

Result of the CancelSigningProfile operation returned by the service.

Throws:

ResourceNotFoundException - A specified resource could not be found.

AccessDeniedException - You do not have sufficient access to perform this action.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

describeSigningJob

public DescribeSigningJobResult describeSigningJob(DescribeSigningJobRequest request)

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

Specified by:

describeSigningJob in interface AWSsigner

Parameters:

describeSigningJobRequest -

Returns:

Result of the DescribeSigningJob operation returned by the service.

Throws:

ResourceNotFoundException - A specified resource could not be found.

AccessDeniedException - You do not have sufficient access to perform this action.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

getRevocationStatus

public GetRevocationStatusResult getRevocationStatus(GetRevocationStatusRequest request)

Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.

Specified by:

getRevocationStatus in interface AWSsigner

Parameters:

getRevocationStatusRequest -

Returns:

Result of the GetRevocationStatus operation returned by the service.

Throws:

ValidationException - You signing certificate could not be validated.

AccessDeniedException - You do not have sufficient access to perform this action.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

getSigningPlatform

public GetSigningPlatformResult getSigningPlatform(GetSigningPlatformRequest request)

Returns information on a specific signing platform.

Specified by:

getSigningPlatform in interface AWSsigner

Parameters:

getSigningPlatformRequest -

Returns:

Result of the GetSigningPlatform operation returned by the service.

Throws:

ResourceNotFoundException - A specified resource could not be found.

AccessDeniedException - You do not have sufficient access to perform this action.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

getSigningProfile

public GetSigningProfileResult getSigningProfile(GetSigningProfileRequest request)

Returns information on a specific signing profile.

Specified by:

getSigningProfile in interface AWSsigner

Parameters:

getSigningProfileRequest -

Returns:

Result of the GetSigningProfile operation returned by the service.

Throws:

ResourceNotFoundException - A specified resource could not be found.

AccessDeniedException - You do not have sufficient access to perform this action.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

listProfilePermissions

public ListProfilePermissionsResult listProfilePermissions(ListProfilePermissionsRequest request)

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

Specified by:

listProfilePermissions in interface AWSsigner

Parameters:

listProfilePermissionsRequest -

Returns:

Result of the ListProfilePermissions operation returned by the service.

Throws:

ValidationException - You signing certificate could not be validated.

ResourceNotFoundException - A specified resource could not be found.

AccessDeniedException - You do not have sufficient access to perform this action.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

listSigningJobs

public ListSigningJobsResult listSigningJobs(ListSigningJobsRequest request)

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Specified by:

listSigningJobs in interface AWSsigner

Parameters:

listSigningJobsRequest -

Returns:

Result of the ListSigningJobs operation returned by the service.

Throws:

ValidationException - You signing certificate could not be validated.

AccessDeniedException - You do not have sufficient access to perform this action.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

listSigningPlatforms

public ListSigningPlatformsResult listSigningPlatforms(ListSigningPlatformsRequest request)

Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Specified by:

listSigningPlatforms in interface AWSsigner

Parameters:

listSigningPlatformsRequest -

Returns:

Result of the ListSigningPlatforms operation returned by the service.

Throws:

ValidationException - You signing certificate could not be validated.

AccessDeniedException - You do not have sufficient access to perform this action.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

listSigningProfiles

public ListSigningProfilesResult listSigningProfiles(ListSigningProfilesRequest request)

Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Specified by:

listSigningProfiles in interface AWSsigner

Parameters:

listSigningProfilesRequest -

Returns:

Result of the ListSigningProfiles operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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

Specified by:

listTagsForResource in interface AWSsigner

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServiceErrorException - An internal error occurred.

BadRequestException - The request contains invalid parameters for the ARN or tags. This exception also occurs when you call a tagging API on a cancelled signing profile.

NotFoundException - The signing profile was not found.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

See Also:

AWS API Documentation

putSigningProfile

public PutSigningProfileResult putSigningProfile(PutSigningProfileRequest request)

Creates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.

Specified by:

putSigningProfile in interface AWSsigner

Parameters:

putSigningProfileRequest -

Returns:

Result of the PutSigningProfile operation returned by the service.

Throws:

ResourceNotFoundException - A specified resource could not be found.

AccessDeniedException - You do not have sufficient access to perform this action.

ValidationException - You signing certificate could not be validated.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

removeProfilePermission

public RemoveProfilePermissionResult removeProfilePermission(RemoveProfilePermissionRequest request)

Removes cross-account permissions from a signing profile.

Specified by:

removeProfilePermission in interface AWSsigner

Parameters:

removeProfilePermissionRequest -

Returns:

Result of the RemoveProfilePermission operation returned by the service.

Throws:

ValidationException - You signing certificate could not be validated.

ResourceNotFoundException - A specified resource could not be found.

AccessDeniedException - You do not have sufficient access to perform this action.

ConflictException - The resource encountered a conflicting state.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

revokeSignature

public RevokeSignatureResult revokeSignature(RevokeSignatureRequest request)

Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.

Specified by:

revokeSignature in interface AWSsigner

Parameters:

revokeSignatureRequest -

Returns:

Result of the RevokeSignature operation returned by the service.

Throws:

ValidationException - You signing certificate could not be validated.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - A specified resource could not be found.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

revokeSigningProfile

public RevokeSigningProfileResult revokeSigningProfile(RevokeSigningProfileRequest request)

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.

Specified by:

revokeSigningProfile in interface AWSsigner

Parameters:

revokeSigningProfileRequest -

Returns:

Result of the RevokeSigningProfile operation returned by the service.

Throws:

ValidationException - You signing certificate could not be validated.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - A specified resource could not be found.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

signPayload

public SignPayloadResult signPayload(SignPayloadRequest request)

Signs a binary payload and returns a signature envelope.

Specified by:

signPayload in interface AWSsigner

Parameters:

signPayloadRequest -

Returns:

Result of the SignPayload operation returned by the service.

Throws:

ValidationException - You signing certificate could not be validated.

ResourceNotFoundException - A specified resource could not be found.

AccessDeniedException - You do not have sufficient access to perform this action.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

startSigningJob

public StartSigningJobResult startSigningJob(StartSigningJobRequest request)

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

• You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the Amazon S3 Getting Started Guide.

• Your S3 source bucket must be version enabled.

• You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code.

• You specify the name of the source and destination buckets when calling the StartSigningJob operation.

• You must ensure the S3 buckets are from the same Region as the signing profile. Cross-Region signing isn't supported.

• You must also specify a request token that identifies your request to Signer.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see StartSigningJob.

Specified by:

startSigningJob in interface AWSsigner

Parameters:

startSigningJobRequest -

Returns:

Result of the StartSigningJob operation returned by the service.

Throws:

ValidationException - You signing certificate could not be validated.

ResourceNotFoundException - A specified resource could not be found.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

Instead of this error, TooManyRequestsException should be used.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds one or more tags to a signing profile. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. To specify the signing profile, use its Amazon Resource Name (ARN). To specify the tag, use a key-value pair.

Specified by:

tagResource in interface AWSsigner

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServiceErrorException - An internal error occurred.

BadRequestException - The request contains invalid parameters for the ARN or tags. This exception also occurs when you call a tagging API on a cancelled signing profile.

NotFoundException - The signing profile was not found.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.

Specified by:

untagResource in interface AWSsigner

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServiceErrorException - An internal error occurred.

BadRequestException - The request contains invalid parameters for the ARN or tags. This exception also occurs when you call a tagging API on a cancelled signing profile.

NotFoundException - The signing profile was not found.

TooManyRequestsException - The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSsigner

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

waiters

public AWSsignerWaiters waiters()

Specified by:

waiters in interface AWSsigner

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSsigner

Overrides:

shutdown in class AmazonWebServiceClient