/* * Copyright 2018-2023 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.services.signer.model.*; /** * Interface for accessing signer asynchronously. Each asynchronous method will return a Java Future object representing * the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive notification when * an asynchronous operation completes. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.signer.AbstractAWSsignerAsync} instead. *

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

* AWS 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 * import a third-party code signing certificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT * Device Management. *

* With code signing for containers …(TBD) *

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

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSsignerAsync extends AWSsigner { /** *

* Adds cross-account permissions to a signing profile. *

* * @param addProfilePermissionRequest * @return A Java Future containing the result of the AddProfilePermission operation returned by the service. * @sample AWSsignerAsync.AddProfilePermission * @see AWS * API Documentation */ java.util.concurrent.Future addProfilePermissionAsync(AddProfilePermissionRequest addProfilePermissionRequest); /** *

* Adds cross-account permissions to a signing profile. *

* * @param addProfilePermissionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the AddProfilePermission operation returned by the service. * @sample AWSsignerAsyncHandler.AddProfilePermission * @see AWS * API Documentation */ java.util.concurrent.Future addProfilePermissionAsync(AddProfilePermissionRequest addProfilePermissionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the CancelSigningProfile operation returned by the service. * @sample AWSsignerAsync.CancelSigningProfile * @see AWS * API Documentation */ java.util.concurrent.Future cancelSigningProfileAsync(CancelSigningProfileRequest cancelSigningProfileRequest); /** *

* * @param cancelSigningProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CancelSigningProfile operation returned by the service. * @sample AWSsignerAsyncHandler.CancelSigningProfile * @see AWS * API Documentation */ java.util.concurrent.Future cancelSigningProfileAsync(CancelSigningProfileRequest cancelSigningProfileRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the DescribeSigningJob operation returned by the service. * @sample AWSsignerAsync.DescribeSigningJob * @see AWS API * Documentation */ java.util.concurrent.Future describeSigningJobAsync(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. *

* * @param describeSigningJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeSigningJob operation returned by the service. * @sample AWSsignerAsyncHandler.DescribeSigningJob * @see AWS API * Documentation */ java.util.concurrent.Future describeSigningJobAsync(DescribeSigningJobRequest describeSigningJobRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param getRevocationStatusRequest * @return A Java Future containing the result of the GetRevocationStatus operation returned by the service. * @sample AWSsignerAsync.GetRevocationStatus * @see AWS API * Documentation */ java.util.concurrent.Future getRevocationStatusAsync(GetRevocationStatusRequest getRevocationStatusRequest); /** *

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

* * @param getRevocationStatusRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetRevocationStatus operation returned by the service. * @sample AWSsignerAsyncHandler.GetRevocationStatus * @see AWS API * Documentation */ java.util.concurrent.Future getRevocationStatusAsync(GetRevocationStatusRequest getRevocationStatusRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns information on a specific signing platform. *

* * @param getSigningPlatformRequest * @return A Java Future containing the result of the GetSigningPlatform operation returned by the service. * @sample AWSsignerAsync.GetSigningPlatform * @see AWS API * Documentation */ java.util.concurrent.Future getSigningPlatformAsync(GetSigningPlatformRequest getSigningPlatformRequest); /** *

* Returns information on a specific signing platform. *

* * @param getSigningPlatformRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetSigningPlatform operation returned by the service. * @sample AWSsignerAsyncHandler.GetSigningPlatform * @see AWS API * Documentation */ java.util.concurrent.Future getSigningPlatformAsync(GetSigningPlatformRequest getSigningPlatformRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns information on a specific signing profile. *

* * @param getSigningProfileRequest * @return A Java Future containing the result of the GetSigningProfile operation returned by the service. * @sample AWSsignerAsync.GetSigningProfile * @see AWS API * Documentation */ java.util.concurrent.Future getSigningProfileAsync(GetSigningProfileRequest getSigningProfileRequest); /** *

* Returns information on a specific signing profile. *

* * @param getSigningProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetSigningProfile operation returned by the service. * @sample AWSsignerAsyncHandler.GetSigningProfile * @see AWS API * Documentation */ java.util.concurrent.Future getSigningProfileAsync(GetSigningProfileRequest getSigningProfileRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listProfilePermissionsRequest * @return A Java Future containing the result of the ListProfilePermissions operation returned by the service. * @sample AWSsignerAsync.ListProfilePermissions * @see AWS * API Documentation */ java.util.concurrent.Future listProfilePermissionsAsync(ListProfilePermissionsRequest listProfilePermissionsRequest); /** *

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

* * @param listProfilePermissionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListProfilePermissions operation returned by the service. * @sample AWSsignerAsyncHandler.ListProfilePermissions * @see AWS * API Documentation */ java.util.concurrent.Future listProfilePermissionsAsync(ListProfilePermissionsRequest listProfilePermissionsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the ListSigningJobs operation returned by the service. * @sample AWSsignerAsync.ListSigningJobs * @see AWS API * Documentation */ java.util.concurrent.Future listSigningJobsAsync(ListSigningJobsRequest listSigningJobsRequest); /** *

* * @param listSigningJobsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSigningJobs operation returned by the service. * @sample AWSsignerAsyncHandler.ListSigningJobs * @see AWS API * Documentation */ java.util.concurrent.Future listSigningJobsAsync(ListSigningJobsRequest listSigningJobsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the ListSigningPlatforms operation returned by the service. * @sample AWSsignerAsync.ListSigningPlatforms * @see AWS * API Documentation */ java.util.concurrent.Future listSigningPlatformsAsync(ListSigningPlatformsRequest listSigningPlatformsRequest); /** *

* * @param listSigningPlatformsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSigningPlatforms operation returned by the service. * @sample AWSsignerAsyncHandler.ListSigningPlatforms * @see AWS * API Documentation */ java.util.concurrent.Future listSigningPlatformsAsync(ListSigningPlatformsRequest listSigningPlatformsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the ListSigningProfiles operation returned by the service. * @sample AWSsignerAsync.ListSigningProfiles * @see AWS API * Documentation */ java.util.concurrent.Future listSigningProfilesAsync(ListSigningProfilesRequest listSigningProfilesRequest); /** *

* * @param listSigningProfilesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListSigningProfiles operation returned by the service. * @sample AWSsignerAsyncHandler.ListSigningProfiles * @see AWS API * Documentation */ java.util.concurrent.Future listSigningProfilesAsync(ListSigningProfilesRequest listSigningProfilesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSsignerAsync.ListTagsForResource * @see AWS API * Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest); /** *

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

* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSsignerAsyncHandler.ListTagsForResource * @see AWS API * Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param putSigningProfileRequest * @return A Java Future containing the result of the PutSigningProfile operation returned by the service. * @sample AWSsignerAsync.PutSigningProfile * @see AWS API * Documentation */ java.util.concurrent.Future putSigningProfileAsync(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. *

* * @param putSigningProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the PutSigningProfile operation returned by the service. * @sample AWSsignerAsyncHandler.PutSigningProfile * @see AWS API * Documentation */ java.util.concurrent.Future putSigningProfileAsync(PutSigningProfileRequest putSigningProfileRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Removes cross-account permissions from a signing profile. *

* * @param removeProfilePermissionRequest * @return A Java Future containing the result of the RemoveProfilePermission operation returned by the service. * @sample AWSsignerAsync.RemoveProfilePermission * @see AWS * API Documentation */ java.util.concurrent.Future removeProfilePermissionAsync(RemoveProfilePermissionRequest removeProfilePermissionRequest); /** *

* Removes cross-account permissions from a signing profile. *

* * @param removeProfilePermissionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the RemoveProfilePermission operation returned by the service. * @sample AWSsignerAsyncHandler.RemoveProfilePermission * @see AWS * API Documentation */ java.util.concurrent.Future removeProfilePermissionAsync(RemoveProfilePermissionRequest removeProfilePermissionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param revokeSignatureRequest * @return A Java Future containing the result of the RevokeSignature operation returned by the service. * @sample AWSsignerAsync.RevokeSignature * @see AWS API * Documentation */ java.util.concurrent.Future revokeSignatureAsync(RevokeSignatureRequest revokeSignatureRequest); /** *

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

* * @param revokeSignatureRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the RevokeSignature operation returned by the service. * @sample AWSsignerAsyncHandler.RevokeSignature * @see AWS API * Documentation */ java.util.concurrent.Future revokeSignatureAsync(RevokeSignatureRequest revokeSignatureRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. *

* * @param revokeSigningProfileRequest * @return A Java Future containing the result of the RevokeSigningProfile operation returned by the service. * @sample AWSsignerAsync.RevokeSigningProfile * @see AWS * API Documentation */ java.util.concurrent.Future revokeSigningProfileAsync(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. *

* * @param revokeSigningProfileRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the RevokeSigningProfile operation returned by the service. * @sample AWSsignerAsyncHandler.RevokeSigningProfile * @see AWS * API Documentation */ java.util.concurrent.Future revokeSigningProfileAsync(RevokeSigningProfileRequest revokeSigningProfileRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Signs a binary payload and returns a signature envelope. *

* * @param signPayloadRequest * @return A Java Future containing the result of the SignPayload operation returned by the service. * @sample AWSsignerAsync.SignPayload * @see AWS API * Documentation */ java.util.concurrent.Future signPayloadAsync(SignPayloadRequest signPayloadRequest); /** *

* Signs a binary payload and returns a signature envelope. *

* * @param signPayloadRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the SignPayload operation returned by the service. * @sample AWSsignerAsyncHandler.SignPayload * @see AWS API * Documentation */ java.util.concurrent.Future signPayloadAsync(SignPayloadRequest signPayloadRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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. 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 StartSigningJob. *

* * @param startSigningJobRequest * @return A Java Future containing the result of the StartSigningJob operation returned by the service. * @sample AWSsignerAsync.StartSigningJob * @see AWS API * Documentation */ java.util.concurrent.Future startSigningJobAsync(StartSigningJobRequest startSigningJobRequest); /** *

*
* 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. 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 StartSigningJob. *

* * @param startSigningJobRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartSigningJob operation returned by the service. * @sample AWSsignerAsyncHandler.StartSigningJob * @see AWS API * Documentation */ java.util.concurrent.Future startSigningJobAsync(StartSigningJobRequest startSigningJobRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSsignerAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest); /** *

* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSsignerAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSsignerAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest); /** *

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

* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSsignerAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }