"documentation":"<p>Changes the state of an <code>ACTIVE</code> signing profile to <code>CANCELED</code>. A canceled profile is still viewable with the <code>ListSigningProfiles</code> operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.</p>"
},
"DescribeSigningJob":{
"name":"DescribeSigningJob",
"http":{
"method":"GET",
"requestUri":"/signing-jobs/{jobId}"
},
"input":{"shape":"DescribeSigningJobRequest"},
"output":{"shape":"DescribeSigningJobResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"}
],
"documentation":"<p>Returns information about a specific code signing job. You specify the job by using the <code>jobId</code> value that is returned by the <a>StartSigningJob</a> operation. </p>"
},
"GetSigningPlatform":{
"name":"GetSigningPlatform",
"http":{
"method":"GET",
"requestUri":"/signing-platforms/{platformId}"
},
"input":{"shape":"GetSigningPlatformRequest"},
"output":{"shape":"GetSigningPlatformResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"}
],
"documentation":"<p>Returns information on a specific signing platform.</p>"
},
"GetSigningProfile":{
"name":"GetSigningProfile",
"http":{
"method":"GET",
"requestUri":"/signing-profiles/{profileName}"
},
"input":{"shape":"GetSigningProfileRequest"},
"output":{"shape":"GetSigningProfileResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"InternalServiceErrorException"}
],
"documentation":"<p>Returns information on a specific signing profile.</p>"
"documentation":"<p>Lists all your signing jobs. You can use the <code>maxResults</code> 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 <code>nextToken</code> value. Use this value in subsequent calls to <code>ListSigningJobs</code> to fetch the remaining values. You can continue calling <code>ListSigningJobs</code> with your <code>maxResults</code> parameter and with new values that code signing returns in the <code>nextToken</code> parameter until all of your signing jobs have been returned. </p>"
"documentation":"<p>Lists all signing platforms available in code signing that match the request parameters. If additional jobs remain to be listed, code signing returns a <code>nextToken</code> value. Use this value in subsequent calls to <code>ListSigningJobs</code> to fetch the remaining values. You can continue calling <code>ListSigningJobs</code> with your <code>maxResults</code> parameter and with new values that code signing returns in the <code>nextToken</code> parameter until all of your signing jobs have been returned.</p>"
"documentation":"<p>Lists all available signing profiles in your AWS account. Returns only profiles with an <code>ACTIVE</code> status unless the <code>includeCanceled</code> request field is set to <code>true</code>. If additional jobs remain to be listed, code signing returns a <code>nextToken</code> value. Use this value in subsequent calls to <code>ListSigningJobs</code> to fetch the remaining values. You can continue calling <code>ListSigningJobs</code> with your <code>maxResults</code> parameter and with new values that code signing returns in the <code>nextToken</code> parameter until all of your signing jobs have been returned.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags/{resourceArn}"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InternalServiceErrorException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Returns a list of the tags associated with a signing profile resource.</p>"
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html\">http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html</a> </p>"
"documentation":"<p>Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the <code>ListSigningJobs</code> operation for two years after they are performed. Note the following requirements: </p> <ul> <li> <p> You must create an Amazon S3 source bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html\">Create a Bucket</a> in the <i>Amazon S3 Getting Started Guide</i>. </p> </li> <li> <p>Your S3 source bucket must be version enabled.</p> </li> <li> <p>You must create an S3 destination bucket. Code signing uses your S3 destination bucket to write your signed code.</p> </li> <li> <p>You specify the name of the source and destination buckets when calling the <code>StartSigningJob</code> operation.</p> </li> <li> <p>You must also specify a request token that identifies your request to code signing.</p> </li> </ul> <p>You can call the <a>DescribeSigningJob</a> and the <a>ListSigningJobs</a> actions after you call <code>StartSigningJob</code>.</p> <p>For a Java example that shows how to use this action, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\">http://docs.aws.amazon.com/acm/latest/userguide/</a> </p>"
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>",
"documentation":"<p>The microcontroller platform to which your signed code image will be distributed.</p>"
},
"profileName":{
"shape":"ProfileName",
"documentation":"<p>The name of the profile that initiated the signing operation.</p>"
},
"overrides":{
"shape":"SigningPlatformOverrides",
"documentation":"<p>A list of any overrides that were applied to the signing operation.</p>"
},
"signingParameters":{
"shape":"SigningParameters",
"documentation":"<p>Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job. </p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>Date and time that the signing job was created.</p>"
},
"completedAt":{
"shape":"CompletedAt",
"documentation":"<p>Date and time that the signing job was completed.</p>"
},
"requestedBy":{
"shape":"RequestedBy",
"documentation":"<p>The IAM principal that requested the signing job.</p>"
},
"status":{
"shape":"SigningStatus",
"documentation":"<p>Status of the signing job.</p>"
},
"statusReason":{
"shape":"StatusReason",
"documentation":"<p>String value that contains the status reason.</p>"
"documentation":"<p>A status value with which to filter your results.</p>",
"location":"querystring",
"locationName":"status"
},
"platformId":{
"shape":"PlatformId",
"documentation":"<p>The ID of microcontroller platform that you specified for the distribution of your code image.</p>",
"location":"querystring",
"locationName":"platformId"
},
"requestedBy":{
"shape":"RequestedBy",
"documentation":"<p>The IAM principal that requested the signing job.</p>",
"location":"querystring",
"locationName":"requestedBy"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>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 <code>nextToken</code> element is set in the response. Use the <code>nextToken</code> value in a subsequent request to retrieve additional items. </p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>nextToken</code> from the response that you just received.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListSigningJobsResponse":{
"type":"structure",
"members":{
"jobs":{
"shape":"SigningJobs",
"documentation":"<p>A list of your signing jobs.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>String for specifying the next set of paginated results.</p>"
}
}
},
"ListSigningPlatformsRequest":{
"type":"structure",
"members":{
"category":{
"shape":"String",
"documentation":"<p>The category type of a signing platform.</p>",
"location":"querystring",
"locationName":"category"
},
"partner":{
"shape":"String",
"documentation":"<p>Any partner entities connected to a signing platform.</p>",
"location":"querystring",
"locationName":"partner"
},
"target":{
"shape":"String",
"documentation":"<p>The validation template that is used by the target signing platform.</p>",
"location":"querystring",
"locationName":"target"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned by this operation.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>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 <code>nextToken</code> from the response that you just received.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListSigningPlatformsResponse":{
"type":"structure",
"members":{
"platforms":{
"shape":"SigningPlatforms",
"documentation":"<p>A list of all platforms that match the request parameters.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>Value for specifying the next set of paginated results to return.</p>"
}
}
},
"ListSigningProfilesRequest":{
"type":"structure",
"members":{
"includeCanceled":{
"shape":"bool",
"documentation":"<p>Designates whether to include profiles with the status of <code>CANCELED</code>.</p>",
"location":"querystring",
"locationName":"includeCanceled"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of profiles to be returned.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>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 <code>nextToken</code> from the response that you just received.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListSigningProfilesResponse":{
"type":"structure",
"members":{
"profiles":{
"shape":"SigningProfiles",
"documentation":"<p>A list of profiles that are available in the AWS account. This includes profiles with the status of <code>CANCELED</code> if the <code>includeCanceled</code> parameter is set to <code>true</code>.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>Value for specifying the next set of paginated results to return.</p>"
"documentation":"<p>A subfield of <code>platform</code>. This specifies any different configuration options that you want to apply to the chosen platform (such as a different <code>hash-algorithm</code> or <code>signing-algorithm</code>).</p>"
},
"signingParameters":{
"shape":"SigningParameters",
"documentation":"<p>Map of key-value pairs for signing. These can include any information that you want to use during signing.</p>"
"documentation":"<p>The ID of the signing job.</p>"
},
"source":{
"shape":"Source",
"documentation":"<p>A <code>Source</code> that contains information about a signing job's code image source.</p>"
},
"signedObject":{
"shape":"SignedObject",
"documentation":"<p>A <code>SignedObject</code> structure that contains information about a signing job's signed code image.</p>"
},
"signingMaterial":{
"shape":"SigningMaterial",
"documentation":"<p>A <code>SigningMaterial</code> object that contains the Amazon Resource Name (ARN) of the certificate used for the signing job.</p>"
},
"createdAt":{
"shape":"CreatedAt",
"documentation":"<p>The date and time that the signing job was created.</p>"
},
"status":{
"shape":"SigningStatus",
"documentation":"<p>The status of the signing job.</p>"
}
},
"documentation":"<p>Contains information about a signing job.</p>"
},
"SigningJobs":{
"type":"list",
"member":{"shape":"SigningJob"}
},
"SigningMaterial":{
"type":"structure",
"required":["certificateArn"],
"members":{
"certificateArn":{
"shape":"CertificateArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the certificates that is used to sign your code.</p>"
}
},
"documentation":"<p>The ACM certificate that is used to sign your code.</p>"
"documentation":"<p>The configuration of a code signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.</p>"
"documentation":"<p>A signed image is a JSON object. When overriding the default signing platform configuration, a customer can select either of two signing formats, <code>JSONEmbedded</code> or <code>JSONDetached</code>. (A third format value, <code>JSON</code>, is reserved for future use.) With <code>JSONEmbedded</code>, the signing image has the payload embedded in it. With <code>JSONDetached</code>, the payload is not be embedded in the signing image.</p>"
"documentation":"<p>Contains information about the ACM certificates and code signing configuration parameters that can be used by a given code signing user.</p>"
"documentation":"<p>An <code>S3Source</code> object that contains information about the S3 bucket where you saved your unsigned code.</p>"
},
"StartSigningJobRequest":{
"type":"structure",
"required":[
"source",
"destination",
"clientRequestToken"
],
"members":{
"source":{
"shape":"Source",
"documentation":"<p>The S3 bucket that contains the object to sign or a BLOB that contains your raw code.</p>"
},
"destination":{
"shape":"Destination",
"documentation":"<p>The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.</p>"
},
"profileName":{
"shape":"ProfileName",
"documentation":"<p>The name of the signing profile.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>String that identifies the signing request. All calls after the first that use this token return the same response as the first call.</p>",
"idempotencyToken":true
}
}
},
"StartSigningJobResponse":{
"type":"structure",
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>The ID of your signing job.</p>"
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/freertos/latest/userguide/\">Amazon FreeRTOS</a> and <a href=\"http://docs.aws.amazon.com/iot/latest/developerguide/\">AWS IoT Device Management</a>, and integrated with <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\">AWS Certificate Manager (ACM)</a>. 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 <a href=\"http://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html\">Code Signing for IoT Developer Guide</a>.</p>"