com.amazonaws.services.signer.AWSsigner Maven / Gradle / Ivy
Show all versions of aws-java-sdk-signer Show documentation
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.signer;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.signer.model.*;
import com.amazonaws.services.signer.waiters.AWSsignerWaiters;
/**
* Interface for accessing signer.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.signer.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSsigner {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "signer";
/**
*
* 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.
*
*
* @param cancelSigningProfileRequest
* @return Result of the CancelSigningProfile operation returned by the service.
* @throws ResourceNotFoundException
* A specified resource could not be found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The signing job has been throttled.
* @throws InternalServiceErrorException
* An internal error occurred.
* @sample AWSsigner.CancelSigningProfile
* @see AWS
* API Documentation
*/
CancelSigningProfileResult cancelSigningProfile(CancelSigningProfileRequest cancelSigningProfileRequest);
/**
*
* Returns information about a specific code signing job. You specify the job by using the jobId value
* that is returned by the StartSigningJob operation.
*
*
* @param describeSigningJobRequest
* @return Result of the DescribeSigningJob operation returned by the service.
* @throws ResourceNotFoundException
* A specified resource could not be found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InternalServiceErrorException
* An internal error occurred.
* @sample AWSsigner.DescribeSigningJob
* @see AWS API
* Documentation
*/
DescribeSigningJobResult describeSigningJob(DescribeSigningJobRequest describeSigningJobRequest);
/**
*
* Returns information on a specific signing platform.
*
*
* @param getSigningPlatformRequest
* @return Result of the GetSigningPlatform operation returned by the service.
* @throws ResourceNotFoundException
* A specified resource could not be found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws InternalServiceErrorException
* An internal error occurred.
* @sample AWSsigner.GetSigningPlatform
* @see AWS API
* Documentation
*/
GetSigningPlatformResult getSigningPlatform(GetSigningPlatformRequest getSigningPlatformRequest);
/**
*
* Returns information on a specific signing profile.
*
*
* @param getSigningProfileRequest
* @return Result of the GetSigningProfile operation returned by the service.
* @throws ResourceNotFoundException
* A specified resource could not be found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The signing job has been throttled.
* @throws InternalServiceErrorException
* An internal error occurred.
* @sample AWSsigner.GetSigningProfile
* @see AWS API
* Documentation
*/
GetSigningProfileResult getSigningProfile(GetSigningProfileRequest getSigningProfileRequest);
/**
*
* 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.
*
*
* @param listSigningJobsRequest
* @return Result of the ListSigningJobs operation returned by the service.
* @throws ValidationException
* You signing certificate could not be validated.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The signing job has been throttled.
* @throws InternalServiceErrorException
* An internal error occurred.
* @sample AWSsigner.ListSigningJobs
* @see AWS API
* Documentation
*/
ListSigningJobsResult listSigningJobs(ListSigningJobsRequest listSigningJobsRequest);
/**
*
* 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.
*
*
* @param listSigningPlatformsRequest
* @return Result of the ListSigningPlatforms operation returned by the service.
* @throws ValidationException
* You signing certificate could not be validated.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The signing job has been throttled.
* @throws InternalServiceErrorException
* An internal error occurred.
* @sample AWSsigner.ListSigningPlatforms
* @see AWS
* API Documentation
*/
ListSigningPlatformsResult listSigningPlatforms(ListSigningPlatformsRequest listSigningPlatformsRequest);
/**
*
* 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.
*
*
* @param listSigningProfilesRequest
* @return Result of the ListSigningProfiles operation returned by the service.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The signing job has been throttled.
* @throws InternalServiceErrorException
* An internal error occurred.
* @sample AWSsigner.ListSigningProfiles
* @see AWS API
* Documentation
*/
ListSigningProfilesResult listSigningProfiles(ListSigningProfilesRequest listSigningProfilesRequest);
/**
*
* Returns a list of the tags associated with a signing profile resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServiceErrorException
* An internal error occurred.
* @throws 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.
* @throws NotFoundException
* The signing profile was not found.
* @sample AWSsigner.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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
*
*
* @param putSigningProfileRequest
* @return Result of the PutSigningProfile operation returned by the service.
* @throws ResourceNotFoundException
* A specified resource could not be found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ValidationException
* You signing certificate could not be validated.
* @throws ThrottlingException
* The signing job has been throttled.
* @throws InternalServiceErrorException
* An internal error occurred.
* @sample AWSsigner.PutSigningProfile
* @see AWS API
* Documentation
*/
PutSigningProfileResult putSigningProfile(PutSigningProfileRequest putSigningProfileRequest);
/**
*
* 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/
*
*
* @param startSigningJobRequest
* @return Result of the StartSigningJob operation returned by the service.
* @throws ValidationException
* You signing certificate could not be validated.
* @throws ResourceNotFoundException
* A specified resource could not be found.
* @throws AccessDeniedException
* You do not have sufficient access to perform this action.
* @throws ThrottlingException
* The signing job has been throttled.
* @throws InternalServiceErrorException
* An internal error occurred.
* @sample AWSsigner.StartSigningJob
* @see AWS API
* Documentation
*/
StartSigningJobResult startSigningJob(StartSigningJobRequest startSigningJobRequest);
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServiceErrorException
* An internal error occurred.
* @throws 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.
* @throws NotFoundException
* The signing profile was not found.
* @sample AWSsigner.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServiceErrorException
* An internal error occurred.
* @throws 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.
* @throws NotFoundException
* The signing profile was not found.
* @sample AWSsigner.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
AWSsignerWaiters waiters();
}