/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the signer-2017-08-25.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.Signer.Model;
namespace Amazon.Signer
{
///
/// Interface for accessing Signer
///
/// 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.
///
///
public partial interface IAmazonSigner : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
ISignerPaginatorFactory Paginators { get; }
#endif
#region AddProfilePermission
///
/// Adds cross-account permissions to a signing profile.
///
/// Container for the necessary parameters to execute the AddProfilePermission service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AddProfilePermission service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// The resource encountered a conflicting state.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The client is making a request that exceeds service limits.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for AddProfilePermission Operation
Task AddProfilePermissionAsync(AddProfilePermissionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CancelSigningProfile
///
/// 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.
///
/// Container for the necessary parameters to execute the CancelSigningProfile service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CancelSigningProfile service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
/// REST API Reference for CancelSigningProfile Operation
Task CancelSigningProfileAsync(CancelSigningProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeSigningJob
///
/// Returns information about a specific code signing job. You specify the job by using
/// the jobId
value that is returned by the StartSigningJob operation.
///
/// Container for the necessary parameters to execute the DescribeSigningJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeSigningJob service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
/// REST API Reference for DescribeSigningJob Operation
Task DescribeSigningJobAsync(DescribeSigningJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetRevocationStatus
///
/// Retrieves the revocation status of one or more of the signing profile, signing job,
/// and signing certificate.
///
/// Container for the necessary parameters to execute the GetRevocationStatus service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetRevocationStatus service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for GetRevocationStatus Operation
Task GetRevocationStatusAsync(GetRevocationStatusRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetSigningPlatform
///
/// Returns information on a specific signing platform.
///
/// Container for the necessary parameters to execute the GetSigningPlatform service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetSigningPlatform service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
/// REST API Reference for GetSigningPlatform Operation
Task GetSigningPlatformAsync(GetSigningPlatformRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region GetSigningProfile
///
/// Returns information on a specific signing profile.
///
/// Container for the necessary parameters to execute the GetSigningProfile service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the GetSigningProfile service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
/// REST API Reference for GetSigningProfile Operation
Task GetSigningProfileAsync(GetSigningProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListProfilePermissions
///
/// Lists the cross-account permissions associated with a signing profile.
///
/// Container for the necessary parameters to execute the ListProfilePermissions service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListProfilePermissions service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for ListProfilePermissions Operation
Task ListProfilePermissionsAsync(ListProfilePermissionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListSigningJobs
///
/// 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.
///
/// Container for the necessary parameters to execute the ListSigningJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListSigningJobs service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for ListSigningJobs Operation
Task ListSigningJobsAsync(ListSigningJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListSigningPlatforms
///
/// 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.
///
/// Container for the necessary parameters to execute the ListSigningPlatforms service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListSigningPlatforms service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for ListSigningPlatforms Operation
Task ListSigningPlatformsAsync(ListSigningPlatformsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListSigningProfiles
///
/// 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.
///
/// Container for the necessary parameters to execute the ListSigningProfiles service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListSigningProfiles service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
/// REST API Reference for ListSigningProfiles Operation
Task ListSigningProfilesAsync(ListSigningProfilesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Returns a list of the tags associated with a signing profile resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by Signer.
///
/// 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.
///
///
/// An internal error occurred.
///
///
/// The signing profile was not found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region PutSigningProfile
///
/// Creates a signing profile. A signing profile is a code signing template that can be
/// used to carry out a pre-defined signing job.
///
/// Container for the necessary parameters to execute the PutSigningProfile service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the PutSigningProfile service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for PutSigningProfile Operation
Task PutSigningProfileAsync(PutSigningProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RemoveProfilePermission
///
/// Removes cross-account permissions from a signing profile.
///
/// Container for the necessary parameters to execute the RemoveProfilePermission service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RemoveProfilePermission service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// The resource encountered a conflicting state.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for RemoveProfilePermission Operation
Task RemoveProfilePermissionAsync(RemoveProfilePermissionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RevokeSignature
///
/// Changes the state of a signing job to REVOKED. This indicates that the signature is
/// no longer valid.
///
/// Container for the necessary parameters to execute the RevokeSignature service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RevokeSignature service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for RevokeSignature Operation
Task RevokeSignatureAsync(RevokeSignatureRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region RevokeSigningProfile
///
/// 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.
///
/// Container for the necessary parameters to execute the RevokeSigningProfile service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the RevokeSigningProfile service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for RevokeSigningProfile Operation
Task RevokeSigningProfileAsync(RevokeSigningProfileRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region SignPayload
///
/// Signs a binary payload and returns a signature envelope.
///
/// Container for the necessary parameters to execute the SignPayload service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the SignPayload service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for SignPayload Operation
Task SignPayloadAsync(SignPayloadRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartSigningJob
///
/// 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.
///
///
/// Container for the necessary parameters to execute the StartSigningJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartSigningJob service method, as returned by Signer.
///
/// You do not have sufficient access to perform this action.
///
///
/// An internal error occurred.
///
///
/// A specified resource could not be found.
///
///
/// The request was denied due to request throttling.
///
///
///
/// Instead of this error, TooManyRequestsException
should be used.
///
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
///
/// You signing certificate could not be validated.
///
/// REST API Reference for StartSigningJob Operation
Task StartSigningJobAsync(StartSigningJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// 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.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by Signer.
///
/// 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.
///
///
/// An internal error occurred.
///
///
/// The signing profile was not found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Removes one or more tags from a signing profile. To remove the tags, specify a list
/// of tag keys.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by Signer.
///
/// 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.
///
///
/// An internal error occurred.
///
///
/// The signing profile was not found.
///
///
/// The allowed number of job-signing requests has been exceeded.
///
///
///
/// This error supersedes the error ThrottlingException
.
///
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}