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.

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

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
`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.
`GetSigningPlatformResult`	`getSigningPlatform(GetSigningPlatformRequest getSigningPlatformRequest)` Returns information on a specific signing platform.
`GetSigningProfileResult`	`getSigningProfile(GetSigningProfileRequest getSigningProfileRequest)` Returns information on a specific signing profile.
`ListSigningJobsResult`	`listSigningJobs(ListSigningJobsRequest listSigningJobsRequest)` Lists all your signing jobs.
`ListSigningPlatformsResult`	`listSigningPlatforms(ListSigningPlatformsRequest listSigningPlatformsRequest)` Lists all signing platforms available in code signing 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.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`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
  - 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.
    
    ThrottlingException - The signing job has been throttled.
    
    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.
    
    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.
    
    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.
    
    ThrottlingException - The signing job has been throttled.
    
    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, 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.
    
    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
```
ListSigningPlatformsResult listSigningPlatforms(ListSigningPlatformsRequest listSigningPlatformsRequest)
```
    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.
    
    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
```
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, 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.
    
    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
```
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.
    
    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. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html
    
    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
```
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 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/
    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
```
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.
    
    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.
    
    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()
```

Did this page help you?

Interface AWSsigner

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

cancelSigningProfile

describeSigningJob

getSigningPlatform

getSigningProfile

listSigningJobs

listSigningPlatforms

listSigningProfiles

listTagsForResource

putSigningProfile

startSigningJob

tagResource

untagResource

shutdown

getCachedResponseMetadata

waiters