UNPKG

31.6 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {WaiterConfiguration} from '../lib/service';
6import {ServiceConfigurationOptions} from '../lib/service';
7import {ConfigBase as Config} from '../lib/config';
8interface Blob {}
9declare class Signer extends Service {
10 /**
11 * Constructs a service object. This object has one method for each API operation.
12 */
13 constructor(options?: Signer.Types.ClientConfiguration)
14 config: Config & Signer.Types.ClientConfiguration;
15 /**
16 * 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.
17 */
18 cancelSigningProfile(params: Signer.Types.CancelSigningProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
19 /**
20 * 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.
21 */
22 cancelSigningProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
23 /**
24 * Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.
25 */
26 describeSigningJob(params: Signer.Types.DescribeSigningJobRequest, callback?: (err: AWSError, data: Signer.Types.DescribeSigningJobResponse) => void): Request<Signer.Types.DescribeSigningJobResponse, AWSError>;
27 /**
28 * Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.
29 */
30 describeSigningJob(callback?: (err: AWSError, data: Signer.Types.DescribeSigningJobResponse) => void): Request<Signer.Types.DescribeSigningJobResponse, AWSError>;
31 /**
32 * Returns information on a specific signing platform.
33 */
34 getSigningPlatform(params: Signer.Types.GetSigningPlatformRequest, callback?: (err: AWSError, data: Signer.Types.GetSigningPlatformResponse) => void): Request<Signer.Types.GetSigningPlatformResponse, AWSError>;
35 /**
36 * Returns information on a specific signing platform.
37 */
38 getSigningPlatform(callback?: (err: AWSError, data: Signer.Types.GetSigningPlatformResponse) => void): Request<Signer.Types.GetSigningPlatformResponse, AWSError>;
39 /**
40 * Returns information on a specific signing profile.
41 */
42 getSigningProfile(params: Signer.Types.GetSigningProfileRequest, callback?: (err: AWSError, data: Signer.Types.GetSigningProfileResponse) => void): Request<Signer.Types.GetSigningProfileResponse, AWSError>;
43 /**
44 * Returns information on a specific signing profile.
45 */
46 getSigningProfile(callback?: (err: AWSError, data: Signer.Types.GetSigningProfileResponse) => void): Request<Signer.Types.GetSigningProfileResponse, AWSError>;
47 /**
48 * 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.
49 */
50 listSigningJobs(params: Signer.Types.ListSigningJobsRequest, callback?: (err: AWSError, data: Signer.Types.ListSigningJobsResponse) => void): Request<Signer.Types.ListSigningJobsResponse, AWSError>;
51 /**
52 * 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.
53 */
54 listSigningJobs(callback?: (err: AWSError, data: Signer.Types.ListSigningJobsResponse) => void): Request<Signer.Types.ListSigningJobsResponse, AWSError>;
55 /**
56 * 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.
57 */
58 listSigningPlatforms(params: Signer.Types.ListSigningPlatformsRequest, callback?: (err: AWSError, data: Signer.Types.ListSigningPlatformsResponse) => void): Request<Signer.Types.ListSigningPlatformsResponse, AWSError>;
59 /**
60 * 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.
61 */
62 listSigningPlatforms(callback?: (err: AWSError, data: Signer.Types.ListSigningPlatformsResponse) => void): Request<Signer.Types.ListSigningPlatformsResponse, AWSError>;
63 /**
64 * 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.
65 */
66 listSigningProfiles(params: Signer.Types.ListSigningProfilesRequest, callback?: (err: AWSError, data: Signer.Types.ListSigningProfilesResponse) => void): Request<Signer.Types.ListSigningProfilesResponse, AWSError>;
67 /**
68 * 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.
69 */
70 listSigningProfiles(callback?: (err: AWSError, data: Signer.Types.ListSigningProfilesResponse) => void): Request<Signer.Types.ListSigningProfilesResponse, AWSError>;
71 /**
72 * Returns a list of the tags associated with a signing profile resource.
73 */
74 listTagsForResource(params: Signer.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Signer.Types.ListTagsForResourceResponse) => void): Request<Signer.Types.ListTagsForResourceResponse, AWSError>;
75 /**
76 * Returns a list of the tags associated with a signing profile resource.
77 */
78 listTagsForResource(callback?: (err: AWSError, data: Signer.Types.ListTagsForResourceResponse) => void): Request<Signer.Types.ListTagsForResourceResponse, AWSError>;
79 /**
80 * 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
81 */
82 putSigningProfile(params: Signer.Types.PutSigningProfileRequest, callback?: (err: AWSError, data: Signer.Types.PutSigningProfileResponse) => void): Request<Signer.Types.PutSigningProfileResponse, AWSError>;
83 /**
84 * 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
85 */
86 putSigningProfile(callback?: (err: AWSError, data: Signer.Types.PutSigningProfileResponse) => void): Request<Signer.Types.PutSigningProfileResponse, AWSError>;
87 /**
88 * 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/
89 */
90 startSigningJob(params: Signer.Types.StartSigningJobRequest, callback?: (err: AWSError, data: Signer.Types.StartSigningJobResponse) => void): Request<Signer.Types.StartSigningJobResponse, AWSError>;
91 /**
92 * 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/
93 */
94 startSigningJob(callback?: (err: AWSError, data: Signer.Types.StartSigningJobResponse) => void): Request<Signer.Types.StartSigningJobResponse, AWSError>;
95 /**
96 * 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.
97 */
98 tagResource(params: Signer.Types.TagResourceRequest, callback?: (err: AWSError, data: Signer.Types.TagResourceResponse) => void): Request<Signer.Types.TagResourceResponse, AWSError>;
99 /**
100 * 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.
101 */
102 tagResource(callback?: (err: AWSError, data: Signer.Types.TagResourceResponse) => void): Request<Signer.Types.TagResourceResponse, AWSError>;
103 /**
104 * Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.
105 */
106 untagResource(params: Signer.Types.UntagResourceRequest, callback?: (err: AWSError, data: Signer.Types.UntagResourceResponse) => void): Request<Signer.Types.UntagResourceResponse, AWSError>;
107 /**
108 * Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.
109 */
110 untagResource(callback?: (err: AWSError, data: Signer.Types.UntagResourceResponse) => void): Request<Signer.Types.UntagResourceResponse, AWSError>;
111 /**
112 * Waits for the successfulSigningJob state by periodically calling the underlying Signer.describeSigningJoboperation every 20 seconds (at most 25 times).
113 */
114 waitFor(state: "successfulSigningJob", params: Signer.Types.DescribeSigningJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Signer.Types.DescribeSigningJobResponse) => void): Request<Signer.Types.DescribeSigningJobResponse, AWSError>;
115 /**
116 * Waits for the successfulSigningJob state by periodically calling the underlying Signer.describeSigningJoboperation every 20 seconds (at most 25 times).
117 */
118 waitFor(state: "successfulSigningJob", callback?: (err: AWSError, data: Signer.Types.DescribeSigningJobResponse) => void): Request<Signer.Types.DescribeSigningJobResponse, AWSError>;
119}
120declare namespace Signer {
121 export type key = string;
122 export type BucketName = string;
123 export interface CancelSigningProfileRequest {
124 /**
125 * The name of the signing profile to be canceled.
126 */
127 profileName: ProfileName;
128 }
129 export type Category = "AWSIoT"|string;
130 export type CertificateArn = string;
131 export type ClientRequestToken = string;
132 export type CompletedAt = Date;
133 export type CreatedAt = Date;
134 export interface DescribeSigningJobRequest {
135 /**
136 * The ID of the signing job on input.
137 */
138 jobId: JobId;
139 }
140 export interface DescribeSigningJobResponse {
141 /**
142 * The ID of the signing job on output.
143 */
144 jobId?: JobId;
145 /**
146 * The object that contains the name of your S3 bucket or your raw code.
147 */
148 source?: Source;
149 /**
150 * The Amazon Resource Name (ARN) of your code signing certificate.
151 */
152 signingMaterial?: SigningMaterial;
153 /**
154 * The microcontroller platform to which your signed code image will be distributed.
155 */
156 platformId?: PlatformId;
157 /**
158 * The name of the profile that initiated the signing operation.
159 */
160 profileName?: ProfileName;
161 /**
162 * A list of any overrides that were applied to the signing operation.
163 */
164 overrides?: SigningPlatformOverrides;
165 /**
166 * Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job.
167 */
168 signingParameters?: SigningParameters;
169 /**
170 * Date and time that the signing job was created.
171 */
172 createdAt?: CreatedAt;
173 /**
174 * Date and time that the signing job was completed.
175 */
176 completedAt?: CompletedAt;
177 /**
178 * The IAM principal that requested the signing job.
179 */
180 requestedBy?: RequestedBy;
181 /**
182 * Status of the signing job.
183 */
184 status?: SigningStatus;
185 /**
186 * String value that contains the status reason.
187 */
188 statusReason?: StatusReason;
189 /**
190 * Name of the S3 bucket where the signed code image is saved by code signing.
191 */
192 signedObject?: SignedObject;
193 }
194 export interface Destination {
195 /**
196 * The S3Destination object.
197 */
198 s3?: S3Destination;
199 }
200 export type DisplayName = string;
201 export type EncryptionAlgorithm = "RSA"|"ECDSA"|string;
202 export interface EncryptionAlgorithmOptions {
203 /**
204 * The set of accepted encryption algorithms that are allowed in a code signing job.
205 */
206 allowedValues: EncryptionAlgorithms;
207 /**
208 * The default encryption algorithm that is used by a code signing job.
209 */
210 defaultValue: EncryptionAlgorithm;
211 }
212 export type EncryptionAlgorithms = EncryptionAlgorithm[];
213 export interface GetSigningPlatformRequest {
214 /**
215 * The ID of the target signing platform.
216 */
217 platformId: PlatformId;
218 }
219 export interface GetSigningPlatformResponse {
220 /**
221 * The ID of the target signing platform.
222 */
223 platformId?: PlatformId;
224 /**
225 * The display name of the target signing platform.
226 */
227 displayName?: DisplayName;
228 /**
229 * A list of partner entities that use the target signing platform.
230 */
231 partner?: String;
232 /**
233 * The validation template that is used by the target signing platform.
234 */
235 target?: String;
236 /**
237 * The category type of the target signing platform.
238 */
239 category?: Category;
240 /**
241 * A list of configurations applied to the target platform at signing.
242 */
243 signingConfiguration?: SigningConfiguration;
244 /**
245 * The format of the target platform's signing image.
246 */
247 signingImageFormat?: SigningImageFormat;
248 /**
249 * The maximum size (in MB) of the payload that can be signed by the target platform.
250 */
251 maxSizeInMB?: MaxSizeInMB;
252 }
253 export interface GetSigningProfileRequest {
254 /**
255 * The name of the target signing profile.
256 */
257 profileName: ProfileName;
258 }
259 export interface GetSigningProfileResponse {
260 /**
261 * The name of the target signing profile.
262 */
263 profileName?: ProfileName;
264 /**
265 * The ARN of the certificate that the target profile uses for signing operations.
266 */
267 signingMaterial?: SigningMaterial;
268 /**
269 * The ID of the platform that is used by the target signing profile.
270 */
271 platformId?: PlatformId;
272 /**
273 * A list of overrides applied by the target signing profile for signing operations.
274 */
275 overrides?: SigningPlatformOverrides;
276 /**
277 * A map of key-value pairs for signing operations that is attached to the target signing profile.
278 */
279 signingParameters?: SigningParameters;
280 /**
281 * The status of the target signing profile.
282 */
283 status?: SigningProfileStatus;
284 /**
285 * The Amazon Resource Name (ARN) for the signing profile.
286 */
287 arn?: string;
288 /**
289 * A list of tags associated with the signing profile.
290 */
291 tags?: TagMap;
292 }
293 export type HashAlgorithm = "SHA1"|"SHA256"|string;
294 export interface HashAlgorithmOptions {
295 /**
296 * The set of accepted hash algorithms allowed in a code signing job.
297 */
298 allowedValues: HashAlgorithms;
299 /**
300 * The default hash algorithm that is used in a code signing job.
301 */
302 defaultValue: HashAlgorithm;
303 }
304 export type HashAlgorithms = HashAlgorithm[];
305 export type ImageFormat = "JSON"|"JSONEmbedded"|"JSONDetached"|string;
306 export type ImageFormats = ImageFormat[];
307 export type JobId = string;
308 export type Key = string;
309 export interface ListSigningJobsRequest {
310 /**
311 * A status value with which to filter your results.
312 */
313 status?: SigningStatus;
314 /**
315 * The ID of microcontroller platform that you specified for the distribution of your code image.
316 */
317 platformId?: PlatformId;
318 /**
319 * The IAM principal that requested the signing job.
320 */
321 requestedBy?: RequestedBy;
322 /**
323 * Specifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the nextToken element is set in the response. Use the nextToken value in a subsequent request to retrieve additional items.
324 */
325 maxResults?: MaxResults;
326 /**
327 * String for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.
328 */
329 nextToken?: NextToken;
330 }
331 export interface ListSigningJobsResponse {
332 /**
333 * A list of your signing jobs.
334 */
335 jobs?: SigningJobs;
336 /**
337 * String for specifying the next set of paginated results.
338 */
339 nextToken?: NextToken;
340 }
341 export interface ListSigningPlatformsRequest {
342 /**
343 * The category type of a signing platform.
344 */
345 category?: String;
346 /**
347 * Any partner entities connected to a signing platform.
348 */
349 partner?: String;
350 /**
351 * The validation template that is used by the target signing platform.
352 */
353 target?: String;
354 /**
355 * The maximum number of results to be returned by this operation.
356 */
357 maxResults?: MaxResults;
358 /**
359 * Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.
360 */
361 nextToken?: String;
362 }
363 export interface ListSigningPlatformsResponse {
364 /**
365 * A list of all platforms that match the request parameters.
366 */
367 platforms?: SigningPlatforms;
368 /**
369 * Value for specifying the next set of paginated results to return.
370 */
371 nextToken?: String;
372 }
373 export interface ListSigningProfilesRequest {
374 /**
375 * Designates whether to include profiles with the status of CANCELED.
376 */
377 includeCanceled?: bool;
378 /**
379 * The maximum number of profiles to be returned.
380 */
381 maxResults?: MaxResults;
382 /**
383 * Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.
384 */
385 nextToken?: NextToken;
386 }
387 export interface ListSigningProfilesResponse {
388 /**
389 * A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true.
390 */
391 profiles?: SigningProfiles;
392 /**
393 * Value for specifying the next set of paginated results to return.
394 */
395 nextToken?: NextToken;
396 }
397 export interface ListTagsForResourceRequest {
398 /**
399 * The Amazon Resource Name (ARN) for the signing profile.
400 */
401 resourceArn: String;
402 }
403 export interface ListTagsForResourceResponse {
404 /**
405 * A list of tags associated with the signing profile.
406 */
407 tags?: TagMap;
408 }
409 export type MaxResults = number;
410 export type MaxSizeInMB = number;
411 export type NextToken = string;
412 export type PlatformId = string;
413 export type Prefix = string;
414 export type ProfileName = string;
415 export interface PutSigningProfileRequest {
416 /**
417 * The name of the signing profile to be created.
418 */
419 profileName: ProfileName;
420 /**
421 * The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.
422 */
423 signingMaterial: SigningMaterial;
424 /**
425 * The ID of the signing platform to be created.
426 */
427 platformId: PlatformId;
428 /**
429 * A subfield of platform. This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm).
430 */
431 overrides?: SigningPlatformOverrides;
432 /**
433 * Map of key-value pairs for signing. These can include any information that you want to use during signing.
434 */
435 signingParameters?: SigningParameters;
436 /**
437 * Tags to be associated with the signing profile that is being created.
438 */
439 tags?: TagMap;
440 }
441 export interface PutSigningProfileResponse {
442 /**
443 * The Amazon Resource Name (ARN) of the signing profile created.
444 */
445 arn?: string;
446 }
447 export type RequestedBy = string;
448 export interface S3Destination {
449 /**
450 * Name of the S3 bucket.
451 */
452 bucketName?: BucketName;
453 /**
454 * An Amazon S3 prefix that you can use to limit responses to those that begin with the specified prefix.
455 */
456 prefix?: Prefix;
457 }
458 export interface S3SignedObject {
459 /**
460 * Name of the S3 bucket.
461 */
462 bucketName?: BucketName;
463 /**
464 * Key name that uniquely identifies a signed code image in your bucket.
465 */
466 key?: key;
467 }
468 export interface S3Source {
469 /**
470 * Name of the S3 bucket.
471 */
472 bucketName: BucketName;
473 /**
474 * Key name of the bucket object that contains your unsigned code.
475 */
476 key: Key;
477 /**
478 * Version of your source image in your version enabled S3 bucket.
479 */
480 version: Version;
481 }
482 export interface SignedObject {
483 /**
484 * The S3SignedObject.
485 */
486 s3?: S3SignedObject;
487 }
488 export interface SigningConfiguration {
489 /**
490 * The encryption algorithm options that are available for a code signing job.
491 */
492 encryptionAlgorithmOptions: EncryptionAlgorithmOptions;
493 /**
494 * The hash algorithm options that are available for a code signing job.
495 */
496 hashAlgorithmOptions: HashAlgorithmOptions;
497 }
498 export interface SigningConfigurationOverrides {
499 /**
500 * A specified override of the default encryption algorithm that is used in a code signing job.
501 */
502 encryptionAlgorithm?: EncryptionAlgorithm;
503 /**
504 * A specified override of the default hash algorithm that is used in a code signing job.
505 */
506 hashAlgorithm?: HashAlgorithm;
507 }
508 export interface SigningImageFormat {
509 /**
510 * The supported formats of a code signing image.
511 */
512 supportedFormats: ImageFormats;
513 /**
514 * The default format of a code signing image.
515 */
516 defaultFormat: ImageFormat;
517 }
518 export interface SigningJob {
519 /**
520 * The ID of the signing job.
521 */
522 jobId?: JobId;
523 /**
524 * A Source that contains information about a signing job's code image source.
525 */
526 source?: Source;
527 /**
528 * A SignedObject structure that contains information about a signing job's signed code image.
529 */
530 signedObject?: SignedObject;
531 /**
532 * A SigningMaterial object that contains the Amazon Resource Name (ARN) of the certificate used for the signing job.
533 */
534 signingMaterial?: SigningMaterial;
535 /**
536 * The date and time that the signing job was created.
537 */
538 createdAt?: CreatedAt;
539 /**
540 * The status of the signing job.
541 */
542 status?: SigningStatus;
543 }
544 export type SigningJobs = SigningJob[];
545 export interface SigningMaterial {
546 /**
547 * The Amazon Resource Name (ARN) of the certificates that is used to sign your code.
548 */
549 certificateArn: CertificateArn;
550 }
551 export type SigningParameterKey = string;
552 export type SigningParameterValue = string;
553 export type SigningParameters = {[key: string]: SigningParameterValue};
554 export interface SigningPlatform {
555 /**
556 * The ID of a code signing; platform.
557 */
558 platformId?: String;
559 /**
560 * The display name of a code signing platform.
561 */
562 displayName?: String;
563 /**
564 * Any partner entities linked to a code signing platform.
565 */
566 partner?: String;
567 /**
568 * The types of targets that can be signed by a code signing platform.
569 */
570 target?: String;
571 /**
572 * The category of a code signing platform.
573 */
574 category?: Category;
575 /**
576 * The configuration of a code signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.
577 */
578 signingConfiguration?: SigningConfiguration;
579 signingImageFormat?: SigningImageFormat;
580 /**
581 * The maximum size (in MB) of code that can be signed by a code signing platform.
582 */
583 maxSizeInMB?: MaxSizeInMB;
584 }
585 export interface SigningPlatformOverrides {
586 /**
587 * A signing configuration that overrides the default encryption or hash algorithm of a signing job.
588 */
589 signingConfiguration?: SigningConfigurationOverrides;
590 /**
591 * A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, JSONEmbedded or JSONDetached. (A third format value, JSON, is reserved for future use.) With JSONEmbedded, the signing image has the payload embedded in it. With JSONDetached, the payload is not be embedded in the signing image.
592 */
593 signingImageFormat?: ImageFormat;
594 }
595 export type SigningPlatforms = SigningPlatform[];
596 export interface SigningProfile {
597 /**
598 * The name of the signing profile.
599 */
600 profileName?: ProfileName;
601 /**
602 * The ACM certificate that is available for use by a signing profile.
603 */
604 signingMaterial?: SigningMaterial;
605 /**
606 * The ID of a platform that is available for use by a signing profile.
607 */
608 platformId?: PlatformId;
609 /**
610 * The parameters that are available for use by a code signing user.
611 */
612 signingParameters?: SigningParameters;
613 /**
614 * The status of a code signing profile.
615 */
616 status?: SigningProfileStatus;
617 /**
618 * The Amazon Resource Name (ARN) for the signing profile.
619 */
620 arn?: string;
621 /**
622 * A list of tags associated with the signing profile.
623 */
624 tags?: TagMap;
625 }
626 export type SigningProfileStatus = "Active"|"Canceled"|string;
627 export type SigningProfiles = SigningProfile[];
628 export type SigningStatus = "InProgress"|"Failed"|"Succeeded"|string;
629 export interface Source {
630 /**
631 * The S3Source object.
632 */
633 s3?: S3Source;
634 }
635 export interface StartSigningJobRequest {
636 /**
637 * The S3 bucket that contains the object to sign or a BLOB that contains your raw code.
638 */
639 source: Source;
640 /**
641 * The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.
642 */
643 destination: Destination;
644 /**
645 * The name of the signing profile.
646 */
647 profileName?: ProfileName;
648 /**
649 * String that identifies the signing request. All calls after the first that use this token return the same response as the first call.
650 */
651 clientRequestToken: ClientRequestToken;
652 }
653 export interface StartSigningJobResponse {
654 /**
655 * The ID of your signing job.
656 */
657 jobId?: JobId;
658 }
659 export type StatusReason = string;
660 export type String = string;
661 export type TagKey = string;
662 export type TagKeyList = TagKey[];
663 export type TagMap = {[key: string]: TagValue};
664 export interface TagResourceRequest {
665 /**
666 * The Amazon Resource Name (ARN) for the signing profile.
667 */
668 resourceArn: String;
669 /**
670 * One or more tags to be associated with the signing profile.
671 */
672 tags: TagMap;
673 }
674 export interface TagResourceResponse {
675 }
676 export type TagValue = string;
677 export interface UntagResourceRequest {
678 /**
679 * The Amazon Resource Name (ARN) for the signing profile.
680 */
681 resourceArn: String;
682 /**
683 * A list of tag keys to be removed from the signing profile.
684 */
685 tagKeys: TagKeyList;
686 }
687 export interface UntagResourceResponse {
688 }
689 export type Version = string;
690 export type bool = boolean;
691 /**
692 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
693 */
694 export type apiVersion = "2017-08-25"|"latest"|string;
695 export interface ClientApiVersions {
696 /**
697 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
698 */
699 apiVersion?: apiVersion;
700 }
701 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
702 /**
703 * Contains interfaces for use with the Signer client.
704 */
705 export import Types = Signer;
706}
707export = Signer;