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.

With code signing for IoT, you can sign code that you create for any IoT device that is supported by Amazon Web Services (AWS). Code signing is available through Amazon FreeRTOS and AWS IoT Device Management, and integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code signing certificate with ACM that is used to sign updates in Amazon FreeRTOS and AWS IoT Device Management. For general information about using code signing, see the Code Signing for IoT Developer Guide.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
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.
GetSigningPlatformResult	getSigningPlatform(GetSigningPlatformRequest request) Returns information on a specific signing platform.
GetSigningProfileResult	getSigningProfile(GetSigningProfileRequest request) Returns information on a specific signing profile.
ListSigningJobsResult	listSigningJobs(ListSigningJobsRequest request) Lists all your signing jobs.
ListSigningPlatformsResult	listSigningPlatforms(ListSigningPlatformsRequest request) Lists all signing platforms available in code signing 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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
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) Remove one or more tags from a signing profile.
AWSsignerWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSsignerClientBuilder builder()

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.

ThrottlingException - The signing job has been throttled.

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.

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.

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.

ThrottlingException - The signing job has been throttled.

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, code signing 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 code signing 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.

ThrottlingException - The signing job has been throttled.

InternalServiceErrorException - An internal error occurred.

See Also:

AWS API Documentation

listSigningPlatforms

public ListSigningPlatformsResult listSigningPlatforms(ListSigningPlatformsRequest request)

Lists all signing platforms available in code signing that match the request parameters. If additional jobs remain to be listed, code signing 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 code signing 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.

ThrottlingException - The signing job has been throttled.

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, code signing 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 code signing 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.

ThrottlingException - The signing job has been throttled.

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.

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. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html

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.

ThrottlingException - The signing job has been throttled.

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 Create a Bucket in the Amazon S3 Getting Started Guide.

• Your S3 source bucket must be version enabled.

• You must create an S3 destination bucket. Code signing 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 also specify a request token that identifies your request to code signing.

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 http://docs.aws.amazon.com/acm/latest/userguide/

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 signing job has been throttled.

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. You specify the signing profile using its Amazon Resource Name (ARN). You specify the tag by using 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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Remove one or more tags from a signing profile. Specify a list of tag keys to remove the tags.

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.

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 interface: AWSsigner

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. 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