AWSsigner (AWS SDK for Java

All Known Subinterfaces:

AWSsignerAsync

All Known Implementing Classes:

AbstractAWSsigner, AbstractAWSsignerAsync, AWSsignerAsyncClient, AWSsignerClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSsigner
```
Interface for accessing signer.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSsigner instead.

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
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AddProfilePermissionResult`	`addProfilePermission(AddProfilePermissionRequest addProfilePermissionRequest)` Adds cross-account permissions to a signing profile.
`CancelSigningProfileResult`	`cancelSigningProfile(CancelSigningProfileRequest cancelSigningProfileRequest)` Changes the state of an `ACTIVE` signing profile to `CANCELED`.
`DescribeSigningJobResult`	`describeSigningJob(DescribeSigningJobRequest describeSigningJobRequest)` 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 getRevocationStatusRequest)` Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.
`GetSigningPlatformResult`	`getSigningPlatform(GetSigningPlatformRequest getSigningPlatformRequest)` Returns information on a specific signing platform.
`GetSigningProfileResult`	`getSigningProfile(GetSigningProfileRequest getSigningProfileRequest)` Returns information on a specific signing profile.
`ListProfilePermissionsResult`	`listProfilePermissions(ListProfilePermissionsRequest listProfilePermissionsRequest)` Lists the cross-account permissions associated with a signing profile.
`ListSigningJobsResult`	`listSigningJobs(ListSigningJobsRequest listSigningJobsRequest)` Lists all your signing jobs.
`ListSigningPlatformsResult`	`listSigningPlatforms(ListSigningPlatformsRequest listSigningPlatformsRequest)` Lists all signing platforms available in AWS Signer that match the request parameters.
`ListSigningProfilesResult`	`listSigningProfiles(ListSigningProfilesRequest listSigningProfilesRequest)` Lists all available signing profiles in your AWS account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns a list of the tags associated with a signing profile resource.
`PutSigningProfileResult`	`putSigningProfile(PutSigningProfileRequest putSigningProfileRequest)` Creates a signing profile.
`RemoveProfilePermissionResult`	`removeProfilePermission(RemoveProfilePermissionRequest removeProfilePermissionRequest)` Removes cross-account permissions from a signing profile.
`RevokeSignatureResult`	`revokeSignature(RevokeSignatureRequest revokeSignatureRequest)` Changes the state of a signing job to REVOKED.
`RevokeSigningProfileResult`	`revokeSigningProfile(RevokeSigningProfileRequest revokeSigningProfileRequest)` 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 signPayloadRequest)` Signs a binary payload and returns a signature envelope.
`StartSigningJobResult`	`startSigningJob(StartSigningJobRequest startSigningJobRequest)` Initiates a signing job to be performed on the code provided.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds one or more tags to a signing profile.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes one or more tags from a signing profile.
`AWSsignerWaiters`	`waiters()`

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - addProfilePermission
```
AddProfilePermissionResult addProfilePermission(AddProfilePermissionRequest addProfilePermissionRequest)
```
    Adds cross-account permissions to a signing profile.
    
    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
```
CancelSigningProfileResult cancelSigningProfile(CancelSigningProfileRequest cancelSigningProfileRequest)
```
    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.
    
    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
```
DescribeSigningJobResult describeSigningJob(DescribeSigningJobRequest describeSigningJobRequest)
```
    Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.
    
    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
```
GetRevocationStatusResult getRevocationStatus(GetRevocationStatusRequest getRevocationStatusRequest)
```
    Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.
    
    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
```
GetSigningPlatformResult getSigningPlatform(GetSigningPlatformRequest getSigningPlatformRequest)
```
    Returns information on a specific signing platform.
    
    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
```
GetSigningProfileResult getSigningProfile(GetSigningProfileRequest getSigningProfileRequest)
```
    Returns information on a specific signing profile.
    
    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
```
ListProfilePermissionsResult listProfilePermissions(ListProfilePermissionsRequest listProfilePermissionsRequest)
```
    Lists the cross-account permissions associated with a signing profile.
    
    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
```
ListSigningJobsResult listSigningJobs(ListSigningJobsRequest listSigningJobsRequest)
```
    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.
    
    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
```
ListSigningPlatformsResult listSigningPlatforms(ListSigningPlatformsRequest listSigningPlatformsRequest)
```
    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.
    
    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
```
ListSigningProfilesResult listSigningProfiles(ListSigningProfilesRequest listSigningProfilesRequest)
```
    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.
    
    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
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns a list of the tags associated with a signing profile resource.
    
    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
```
PutSigningProfileResult putSigningProfile(PutSigningProfileRequest putSigningProfileRequest)
```
    Creates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.
    
    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
```
RemoveProfilePermissionResult removeProfilePermission(RemoveProfilePermissionRequest removeProfilePermissionRequest)
```
    Removes cross-account permissions from a signing profile.
    
    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
```
RevokeSignatureResult revokeSignature(RevokeSignatureRequest revokeSignatureRequest)
```
    Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.
    
    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
```
RevokeSigningProfileResult revokeSigningProfile(RevokeSigningProfileRequest revokeSigningProfileRequest)
```
    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.
    
    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
```
SignPayloadResult signPayload(SignPayloadRequest signPayloadRequest)
```
    Signs a binary payload and returns a signature envelope.
    
    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
```
StartSigningJobResult startSigningJob(StartSigningJobRequest startSigningJobRequest)
```
    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.
    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
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    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.
    
    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
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.
    
    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
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
AWSsignerWaiters waiters()
```

AWS SDK for Java 1.x API Reference - 1.12.793

Interface AWSsigner

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

addProfilePermission

cancelSigningProfile

describeSigningJob

getRevocationStatus

getSigningPlatform

getSigningProfile

listProfilePermissions

listSigningJobs

listSigningPlatforms

listSigningProfiles

listTagsForResource

putSigningProfile

removeProfilePermission

revokeSignature

revokeSigningProfile

signPayload

startSigningJob

tagResource

untagResource

shutdown

getCachedResponseMetadata

waiters