2018-10-04 08:50:52 +02:00
{
"version" : "2.0" ,
"metadata" : {
"apiVersion" : "2017-08-25" ,
"endpointPrefix" : "signer" ,
"jsonVersion" : "1.1" ,
"protocol" : "rest-json" ,
"serviceAbbreviation" : "signer" ,
"serviceFullName" : "AWS Signer" ,
"serviceId" : "signer" ,
"signatureVersion" : "v4" ,
"signingName" : "signer" ,
"uid" : "signer-2017-08-25"
} ,
"operations" : {
2021-01-26 16:12:20 +01:00
"AddProfilePermission" : {
"name" : "AddProfilePermission" ,
"http" : {
"method" : "POST" ,
"requestUri" : "/signing-profiles/{profileName}/permissions"
} ,
"input" : { "shape" : "AddProfilePermissionRequest" } ,
"output" : { "shape" : "AddProfilePermissionResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "ResourceNotFoundException" } ,
{ "shape" : "AccessDeniedException" } ,
{ "shape" : "ServiceLimitExceededException" } ,
{ "shape" : "ConflictException" } ,
{ "shape" : "TooManyRequestsException" } ,
{ "shape" : "InternalServiceErrorException" }
] ,
"documentation" : "<p>Adds cross-account permissions to a signing profile.</p>"
} ,
2018-10-04 08:50:52 +02:00
"CancelSigningProfile" : {
"name" : "CancelSigningProfile" ,
"http" : {
"method" : "DELETE" ,
"requestUri" : "/signing-profiles/{profileName}"
} ,
"input" : { "shape" : "CancelSigningProfileRequest" } ,
"errors" : [
{ "shape" : "ResourceNotFoundException" } ,
{ "shape" : "AccessDeniedException" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "TooManyRequestsException" } ,
2018-10-04 08:50:52 +02:00
{ "shape" : "InternalServiceErrorException" }
] ,
"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" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "TooManyRequestsException" } ,
2018-10-04 08:50:52 +02:00
{ "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" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "TooManyRequestsException" } ,
2018-10-04 08:50:52 +02:00
{ "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" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "TooManyRequestsException" } ,
2018-10-04 08:50:52 +02:00
{ "shape" : "InternalServiceErrorException" }
] ,
"documentation" : "<p>Returns information on a specific signing profile.</p>"
} ,
2021-01-26 16:12:20 +01:00
"ListProfilePermissions" : {
"name" : "ListProfilePermissions" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/signing-profiles/{profileName}/permissions"
} ,
"input" : { "shape" : "ListProfilePermissionsRequest" } ,
"output" : { "shape" : "ListProfilePermissionsResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "ResourceNotFoundException" } ,
{ "shape" : "AccessDeniedException" } ,
{ "shape" : "TooManyRequestsException" } ,
{ "shape" : "InternalServiceErrorException" }
] ,
"documentation" : "<p>Lists the cross-account permissions associated with a signing profile.</p>"
} ,
2018-10-04 08:50:52 +02:00
"ListSigningJobs" : {
"name" : "ListSigningJobs" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/signing-jobs"
} ,
"input" : { "shape" : "ListSigningJobsRequest" } ,
"output" : { "shape" : "ListSigningJobsResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "AccessDeniedException" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "TooManyRequestsException" } ,
2018-10-04 08:50:52 +02:00
{ "shape" : "InternalServiceErrorException" }
] ,
2019-11-18 09:46:14 +01:00
"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>"
2018-10-04 08:50:52 +02:00
} ,
"ListSigningPlatforms" : {
"name" : "ListSigningPlatforms" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/signing-platforms"
} ,
"input" : { "shape" : "ListSigningPlatformsRequest" } ,
"output" : { "shape" : "ListSigningPlatformsResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "AccessDeniedException" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "TooManyRequestsException" } ,
2018-10-04 08:50:52 +02:00
{ "shape" : "InternalServiceErrorException" }
] ,
2019-11-18 09:46:14 +01:00
"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>"
2018-10-04 08:50:52 +02:00
} ,
"ListSigningProfiles" : {
"name" : "ListSigningProfiles" ,
"http" : {
"method" : "GET" ,
"requestUri" : "/signing-profiles"
} ,
"input" : { "shape" : "ListSigningProfilesRequest" } ,
"output" : { "shape" : "ListSigningProfilesResponse" } ,
"errors" : [
{ "shape" : "AccessDeniedException" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "TooManyRequestsException" } ,
2018-10-04 08:50:52 +02:00
{ "shape" : "InternalServiceErrorException" }
] ,
2019-11-18 09:46:14 +01:00
"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" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "NotFoundException" } ,
{ "shape" : "TooManyRequestsException" }
2019-11-18 09:46:14 +01:00
] ,
"documentation" : "<p>Returns a list of the tags associated with a signing profile resource.</p>"
2018-10-04 08:50:52 +02:00
} ,
"PutSigningProfile" : {
"name" : "PutSigningProfile" ,
"http" : {
"method" : "PUT" ,
"requestUri" : "/signing-profiles/{profileName}"
} ,
"input" : { "shape" : "PutSigningProfileRequest" } ,
"output" : { "shape" : "PutSigningProfileResponse" } ,
"errors" : [
{ "shape" : "ResourceNotFoundException" } ,
{ "shape" : "AccessDeniedException" } ,
{ "shape" : "ValidationException" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "TooManyRequestsException" } ,
2018-10-04 08:50:52 +02:00
{ "shape" : "InternalServiceErrorException" }
] ,
2019-11-18 09:46:14 +01:00
"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>"
2018-10-04 08:50:52 +02:00
} ,
2021-01-26 16:12:20 +01:00
"RemoveProfilePermission" : {
"name" : "RemoveProfilePermission" ,
"http" : {
"method" : "DELETE" ,
"requestUri" : "/signing-profiles/{profileName}/permissions/{statementId}"
} ,
"input" : { "shape" : "RemoveProfilePermissionRequest" } ,
"output" : { "shape" : "RemoveProfilePermissionResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "ResourceNotFoundException" } ,
{ "shape" : "AccessDeniedException" } ,
{ "shape" : "ConflictException" } ,
{ "shape" : "TooManyRequestsException" } ,
{ "shape" : "InternalServiceErrorException" }
] ,
"documentation" : "<p>Removes cross-account permissions from a signing profile.</p>"
} ,
"RevokeSignature" : {
"name" : "RevokeSignature" ,
"http" : {
"method" : "PUT" ,
"requestUri" : "/signing-jobs/{jobId}/revoke"
} ,
"input" : { "shape" : "RevokeSignatureRequest" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "AccessDeniedException" } ,
{ "shape" : "ResourceNotFoundException" } ,
{ "shape" : "TooManyRequestsException" } ,
{ "shape" : "InternalServiceErrorException" }
] ,
"documentation" : "<p>Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.</p>"
} ,
"RevokeSigningProfile" : {
"name" : "RevokeSigningProfile" ,
"http" : {
"method" : "PUT" ,
"requestUri" : "/signing-profiles/{profileName}/revoke"
} ,
"input" : { "shape" : "RevokeSigningProfileRequest" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "AccessDeniedException" } ,
{ "shape" : "ResourceNotFoundException" } ,
{ "shape" : "TooManyRequestsException" } ,
{ "shape" : "InternalServiceErrorException" }
] ,
"documentation" : "<p>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.</p>"
} ,
2018-10-04 08:50:52 +02:00
"StartSigningJob" : {
"name" : "StartSigningJob" ,
"http" : {
"method" : "POST" ,
"requestUri" : "/signing-jobs"
} ,
"input" : { "shape" : "StartSigningJobRequest" } ,
"output" : { "shape" : "StartSigningJobResponse" } ,
"errors" : [
{ "shape" : "ValidationException" } ,
{ "shape" : "ResourceNotFoundException" } ,
{ "shape" : "AccessDeniedException" } ,
{ "shape" : "ThrottlingException" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "TooManyRequestsException" } ,
2018-10-04 08:50:52 +02:00
{ "shape" : "InternalServiceErrorException" }
] ,
2019-11-18 09:46:14 +01:00
"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>"
} ,
"TagResource" : {
"name" : "TagResource" ,
"http" : {
"method" : "POST" ,
"requestUri" : "/tags/{resourceArn}"
} ,
"input" : { "shape" : "TagResourceRequest" } ,
"output" : { "shape" : "TagResourceResponse" } ,
"errors" : [
{ "shape" : "InternalServiceErrorException" } ,
{ "shape" : "BadRequestException" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "NotFoundException" } ,
{ "shape" : "TooManyRequestsException" }
2019-11-18 09:46:14 +01:00
] ,
2020-03-22 13:12:42 +01:00
"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>"
2019-11-18 09:46:14 +01:00
} ,
"UntagResource" : {
"name" : "UntagResource" ,
"http" : {
"method" : "DELETE" ,
"requestUri" : "/tags/{resourceArn}"
} ,
"input" : { "shape" : "UntagResourceRequest" } ,
"output" : { "shape" : "UntagResourceResponse" } ,
"errors" : [
{ "shape" : "InternalServiceErrorException" } ,
{ "shape" : "BadRequestException" } ,
2021-01-26 16:12:20 +01:00
{ "shape" : "NotFoundException" } ,
{ "shape" : "TooManyRequestsException" }
2019-11-18 09:46:14 +01:00
] ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.</p>"
2018-10-04 08:50:52 +02:00
}
} ,
"shapes" : {
"AccessDeniedException" : {
"type" : "structure" ,
"members" : {
2021-01-26 16:12:20 +01:00
"message" : { "shape" : "ErrorMessage" } ,
"code" : { "shape" : "ErrorCode" }
2018-10-04 08:50:52 +02:00
} ,
"documentation" : "<p>You do not have sufficient access to perform this action.</p>" ,
"error" : { "httpStatusCode" : 403 } ,
"exception" : true
} ,
2021-01-26 16:12:20 +01:00
"AccountId" : {
"type" : "string" ,
"max" : 12 ,
"min" : 12 ,
"pattern" : "^[0-9]{12}$"
} ,
"AddProfilePermissionRequest" : {
"type" : "structure" ,
"required" : [
"action" ,
"principal" ,
"statementId" ,
"profileName"
] ,
"members" : {
"profileName" : {
"shape" : "ProfileName" ,
"documentation" : "<p>The human-readable name of the signing profile.</p>" ,
"location" : "uri" ,
"locationName" : "profileName"
} ,
"profileVersion" : {
"shape" : "ProfileVersion" ,
"documentation" : "<p>The version of the signing profile.</p>"
} ,
"action" : {
"shape" : "String" ,
"documentation" : "<p>The AWS Signer action permitted as part of cross-account permissions.</p>"
} ,
"principal" : {
"shape" : "String" ,
"documentation" : "<p>The AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account ID.</p>"
} ,
"revisionId" : {
"shape" : "String" ,
"documentation" : "<p>A unique identifier for the current profile revision.</p>"
} ,
"statementId" : {
"shape" : "String" ,
"documentation" : "<p>A unique identifier for the cross-account permission statement.</p>"
}
}
} ,
"AddProfilePermissionResponse" : {
"type" : "structure" ,
"members" : {
"revisionId" : {
"shape" : "String" ,
"documentation" : "<p>A unique identifier for the current profile revision.</p>"
}
}
} ,
"Arn" : {
"type" : "string" ,
"max" : 2048 ,
"min" : 20
} ,
2019-11-18 09:46:14 +01:00
"BadRequestException" : {
"type" : "structure" ,
"members" : {
2021-01-26 16:12:20 +01:00
"message" : { "shape" : "ErrorMessage" } ,
"code" : { "shape" : "ErrorCode" }
2019-11-18 09:46:14 +01:00
} ,
"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>" ,
"error" : { "httpStatusCode" : 400 } ,
"exception" : true
} ,
2018-10-04 08:50:52 +02:00
"BucketName" : { "type" : "string" } ,
"CancelSigningProfileRequest" : {
"type" : "structure" ,
"required" : [ "profileName" ] ,
"members" : {
"profileName" : {
"shape" : "ProfileName" ,
"documentation" : "<p>The name of the signing profile to be canceled.</p>" ,
"location" : "uri" ,
"locationName" : "profileName"
}
}
} ,
"Category" : {
"type" : "string" ,
"enum" : [ "AWSIoT" ]
} ,
"CertificateArn" : { "type" : "string" } ,
"ClientRequestToken" : { "type" : "string" } ,
2021-01-26 16:12:20 +01:00
"ConflictException" : {
"type" : "structure" ,
"members" : {
"message" : { "shape" : "ErrorMessage" } ,
"code" : { "shape" : "ErrorCode" }
} ,
"documentation" : "<p>The resource encountered a conflicting state.</p>" ,
"error" : { "httpStatusCode" : 409 } ,
"exception" : true
} ,
2018-10-04 08:50:52 +02:00
"DescribeSigningJobRequest" : {
"type" : "structure" ,
"required" : [ "jobId" ] ,
"members" : {
"jobId" : {
"shape" : "JobId" ,
"documentation" : "<p>The ID of the signing job on input.</p>" ,
"location" : "uri" ,
"locationName" : "jobId"
}
}
} ,
"DescribeSigningJobResponse" : {
"type" : "structure" ,
"members" : {
"jobId" : {
"shape" : "JobId" ,
"documentation" : "<p>The ID of the signing job on output.</p>"
} ,
"source" : {
"shape" : "Source" ,
"documentation" : "<p>The object that contains the name of your S3 bucket or your raw code.</p>"
} ,
"signingMaterial" : {
"shape" : "SigningMaterial" ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>The Amazon Resource Name (ARN) of your code signing certificate.</p>"
2018-10-04 08:50:52 +02:00
} ,
"platformId" : {
"shape" : "PlatformId" ,
"documentation" : "<p>The microcontroller platform to which your signed code image will be distributed.</p>"
} ,
2021-01-26 16:12:20 +01:00
"platformDisplayName" : {
"shape" : "DisplayName" ,
"documentation" : "<p>A human-readable name for the signing platform associated with the signing job.</p>"
} ,
2018-10-04 08:50:52 +02:00
"profileName" : {
"shape" : "ProfileName" ,
"documentation" : "<p>The name of the profile that initiated the signing operation.</p>"
} ,
2021-01-26 16:12:20 +01:00
"profileVersion" : {
"shape" : "ProfileVersion" ,
"documentation" : "<p>The version of the signing profile used to initiate the signing job.</p>"
} ,
2018-10-04 08:50:52 +02:00
"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" : {
2021-01-26 16:12:20 +01:00
"shape" : "Timestamp" ,
2018-10-04 08:50:52 +02:00
"documentation" : "<p>Date and time that the signing job was created.</p>"
} ,
"completedAt" : {
2021-01-26 16:12:20 +01:00
"shape" : "Timestamp" ,
2018-10-04 08:50:52 +02:00
"documentation" : "<p>Date and time that the signing job was completed.</p>"
} ,
2021-01-26 16:12:20 +01:00
"signatureExpiresAt" : {
"shape" : "Timestamp" ,
"documentation" : "<p>Thr expiration timestamp for the signature generated by the signing job.</p>"
} ,
2018-10-04 08:50:52 +02:00
"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>"
} ,
2021-01-26 16:12:20 +01:00
"revocationRecord" : {
"shape" : "SigningJobRevocationRecord" ,
"documentation" : "<p>A revocation record if the signature generated by the signing job has been revoked. Contains a timestamp and the ID of the IAM entity that revoked the signature.</p>"
} ,
2018-10-04 08:50:52 +02:00
"signedObject" : {
"shape" : "SignedObject" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>Name of the S3 bucket where the signed code image is saved by code signing.</p>"
2021-01-26 16:12:20 +01:00
} ,
"jobOwner" : {
"shape" : "AccountId" ,
"documentation" : "<p>The AWS account ID of the job owner.</p>"
} ,
"jobInvoker" : {
"shape" : "AccountId" ,
"documentation" : "<p>The IAM entity that initiated the signing job.</p>"
2018-10-04 08:50:52 +02:00
}
}
} ,
"Destination" : {
"type" : "structure" ,
"members" : {
"s3" : {
"shape" : "S3Destination" ,
"documentation" : "<p>The <code>S3Destination</code> object.</p>"
}
} ,
"documentation" : "<p>Points to an <code>S3Destination</code> object that contains information about your S3 bucket.</p>"
} ,
"DisplayName" : { "type" : "string" } ,
"EncryptionAlgorithm" : {
"type" : "string" ,
"enum" : [
"RSA" ,
"ECDSA"
]
} ,
"EncryptionAlgorithmOptions" : {
"type" : "structure" ,
"required" : [
"allowedValues" ,
"defaultValue"
] ,
"members" : {
"allowedValues" : {
"shape" : "EncryptionAlgorithms" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The set of accepted encryption algorithms that are allowed in a code signing job.</p>"
2018-10-04 08:50:52 +02:00
} ,
"defaultValue" : {
"shape" : "EncryptionAlgorithm" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The default encryption algorithm that is used by a code signing job.</p>"
2018-10-04 08:50:52 +02:00
}
} ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The encryption algorithm options that are available to a code signing job.</p>"
2018-10-04 08:50:52 +02:00
} ,
"EncryptionAlgorithms" : {
"type" : "list" ,
"member" : { "shape" : "EncryptionAlgorithm" }
} ,
2021-01-26 16:12:20 +01:00
"ErrorCode" : { "type" : "string" } ,
2018-10-04 08:50:52 +02:00
"ErrorMessage" : { "type" : "string" } ,
"GetSigningPlatformRequest" : {
"type" : "structure" ,
"required" : [ "platformId" ] ,
"members" : {
"platformId" : {
"shape" : "PlatformId" ,
"documentation" : "<p>The ID of the target signing platform.</p>" ,
"location" : "uri" ,
"locationName" : "platformId"
}
}
} ,
"GetSigningPlatformResponse" : {
"type" : "structure" ,
"members" : {
"platformId" : {
"shape" : "PlatformId" ,
"documentation" : "<p>The ID of the target signing platform.</p>"
} ,
"displayName" : {
"shape" : "DisplayName" ,
"documentation" : "<p>The display name of the target signing platform.</p>"
} ,
"partner" : {
"shape" : "String" ,
"documentation" : "<p>A list of partner entities that use the target signing platform.</p>"
} ,
"target" : {
"shape" : "String" ,
"documentation" : "<p>The validation template that is used by the target signing platform.</p>"
} ,
"category" : {
"shape" : "Category" ,
"documentation" : "<p>The category type of the target signing platform.</p>"
} ,
"signingConfiguration" : {
"shape" : "SigningConfiguration" ,
"documentation" : "<p>A list of configurations applied to the target platform at signing.</p>"
} ,
"signingImageFormat" : {
"shape" : "SigningImageFormat" ,
"documentation" : "<p>The format of the target platform's signing image.</p>"
} ,
"maxSizeInMB" : {
"shape" : "MaxSizeInMB" ,
"documentation" : "<p>The maximum size (in MB) of the payload that can be signed by the target platform.</p>"
2021-01-26 16:12:20 +01:00
} ,
"revocationSupported" : {
"shape" : "bool" ,
"documentation" : "<p>A flag indicating whether signatures generated for the signing platform can be revoked.</p>"
2018-10-04 08:50:52 +02:00
}
}
} ,
"GetSigningProfileRequest" : {
"type" : "structure" ,
"required" : [ "profileName" ] ,
"members" : {
"profileName" : {
"shape" : "ProfileName" ,
"documentation" : "<p>The name of the target signing profile.</p>" ,
"location" : "uri" ,
"locationName" : "profileName"
2021-01-26 16:12:20 +01:00
} ,
"profileOwner" : {
"shape" : "AccountId" ,
"documentation" : "<p>The AWS account ID of the profile owner.</p>" ,
"location" : "querystring" ,
"locationName" : "profileOwner"
2018-10-04 08:50:52 +02:00
}
}
} ,
"GetSigningProfileResponse" : {
"type" : "structure" ,
"members" : {
"profileName" : {
"shape" : "ProfileName" ,
"documentation" : "<p>The name of the target signing profile.</p>"
} ,
2021-01-26 16:12:20 +01:00
"profileVersion" : {
"shape" : "ProfileVersion" ,
"documentation" : "<p>The current version of the signing profile.</p>"
} ,
"profileVersionArn" : {
"shape" : "Arn" ,
"documentation" : "<p>The signing profile ARN, including the profile version.</p>"
} ,
"revocationRecord" : { "shape" : "SigningProfileRevocationRecord" } ,
2018-10-04 08:50:52 +02:00
"signingMaterial" : {
"shape" : "SigningMaterial" ,
"documentation" : "<p>The ARN of the certificate that the target profile uses for signing operations.</p>"
} ,
"platformId" : {
"shape" : "PlatformId" ,
"documentation" : "<p>The ID of the platform that is used by the target signing profile.</p>"
} ,
2021-01-26 16:12:20 +01:00
"platformDisplayName" : {
"shape" : "DisplayName" ,
"documentation" : "<p>A human-readable name for the signing platform associated with the signing profile.</p>"
} ,
"signatureValidityPeriod" : { "shape" : "SignatureValidityPeriod" } ,
2018-10-04 08:50:52 +02:00
"overrides" : {
"shape" : "SigningPlatformOverrides" ,
"documentation" : "<p>A list of overrides applied by the target signing profile for signing operations.</p>"
} ,
"signingParameters" : {
"shape" : "SigningParameters" ,
"documentation" : "<p>A map of key-value pairs for signing operations that is attached to the target signing profile.</p>"
} ,
"status" : {
"shape" : "SigningProfileStatus" ,
"documentation" : "<p>The status of the target signing profile.</p>"
2019-11-18 09:46:14 +01:00
} ,
2021-01-26 16:12:20 +01:00
"statusReason" : {
"shape" : "String" ,
"documentation" : "<p>Reason for the status of the target signing profile.</p>"
} ,
2019-11-18 09:46:14 +01:00
"arn" : {
"shape" : "string" ,
"documentation" : "<p>The Amazon Resource Name (ARN) for the signing profile.</p>"
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>A list of tags associated with the signing profile.</p>"
2018-10-04 08:50:52 +02:00
}
}
} ,
"HashAlgorithm" : {
"type" : "string" ,
"enum" : [
"SHA1" ,
"SHA256"
]
} ,
"HashAlgorithmOptions" : {
"type" : "structure" ,
"required" : [
"allowedValues" ,
"defaultValue"
] ,
"members" : {
"allowedValues" : {
"shape" : "HashAlgorithms" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The set of accepted hash algorithms allowed in a code signing job.</p>"
2018-10-04 08:50:52 +02:00
} ,
"defaultValue" : {
"shape" : "HashAlgorithm" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The default hash algorithm that is used in a code signing job.</p>"
2018-10-04 08:50:52 +02:00
}
} ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The hash algorithms that are available to a code signing job.</p>"
2018-10-04 08:50:52 +02:00
} ,
"HashAlgorithms" : {
"type" : "list" ,
"member" : { "shape" : "HashAlgorithm" }
} ,
"ImageFormat" : {
"type" : "string" ,
2020-03-22 13:12:42 +01:00
"enum" : [
"JSON" ,
"JSONEmbedded" ,
"JSONDetached"
]
2018-10-04 08:50:52 +02:00
} ,
"ImageFormats" : {
"type" : "list" ,
"member" : { "shape" : "ImageFormat" }
} ,
2021-01-26 16:12:20 +01:00
"Integer" : { "type" : "integer" } ,
2018-10-04 08:50:52 +02:00
"InternalServiceErrorException" : {
"type" : "structure" ,
"members" : {
2021-01-26 16:12:20 +01:00
"message" : { "shape" : "ErrorMessage" } ,
"code" : { "shape" : "ErrorCode" }
2018-10-04 08:50:52 +02:00
} ,
"documentation" : "<p>An internal error occurred.</p>" ,
"error" : { "httpStatusCode" : 500 } ,
"exception" : true
} ,
"JobId" : { "type" : "string" } ,
"Key" : { "type" : "string" } ,
2021-01-26 16:12:20 +01:00
"ListProfilePermissionsRequest" : {
"type" : "structure" ,
"required" : [ "profileName" ] ,
"members" : {
"profileName" : {
"shape" : "ProfileName" ,
"documentation" : "<p>Name of the signing profile containing the cross-account permissions.</p>" ,
"location" : "uri" ,
"locationName" : "profileName"
} ,
"nextToken" : {
"shape" : "String" ,
"documentation" : "<p>String for specifying the next set of paginated results.</p>" ,
"location" : "querystring" ,
"locationName" : "nextToken"
}
}
} ,
"ListProfilePermissionsResponse" : {
"type" : "structure" ,
"members" : {
"revisionId" : {
"shape" : "String" ,
"documentation" : "<p>The identifier for the current revision of profile permissions.</p>"
} ,
"policySizeBytes" : {
"shape" : "PolicySizeBytes" ,
"documentation" : "<p>Total size of the policy associated with the Signing Profile in bytes.</p>"
} ,
"permissions" : {
"shape" : "Permissions" ,
"documentation" : "<p>List of permissions associated with the Signing Profile.</p>"
} ,
"nextToken" : {
"shape" : "String" ,
"documentation" : "<p>String for specifying the next set of paginated results.</p>"
}
}
} ,
2018-10-04 08:50:52 +02:00
"ListSigningJobsRequest" : {
"type" : "structure" ,
"members" : {
"status" : {
"shape" : "SigningStatus" ,
"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"
2021-01-26 16:12:20 +01:00
} ,
"isRevoked" : {
"shape" : "bool" ,
"documentation" : "<p>Filters results to return only signing jobs with revoked signatures.</p>" ,
"location" : "querystring" ,
"locationName" : "isRevoked"
} ,
"signatureExpiresBefore" : {
"shape" : "Timestamp" ,
"documentation" : "<p>Filters results to return only signing jobs with signatures expiring before a specified timestamp.</p>" ,
"location" : "querystring" ,
"locationName" : "signatureExpiresBefore"
} ,
"signatureExpiresAfter" : {
"shape" : "Timestamp" ,
"documentation" : "<p>Filters results to return only signing jobs with signatures expiring after a specified timestamp.</p>" ,
"location" : "querystring" ,
"locationName" : "signatureExpiresAfter"
} ,
"jobInvoker" : {
"shape" : "AccountId" ,
"documentation" : "<p>Filters results to return only signing jobs initiated by a specified IAM entity.</p>" ,
"location" : "querystring" ,
"locationName" : "jobInvoker"
2018-10-04 08:50:52 +02:00
}
}
} ,
"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"
2021-01-26 16:12:20 +01:00
} ,
"platformId" : {
"shape" : "PlatformId" ,
"documentation" : "<p>Filters results to return only signing jobs initiated for a specified signing platform.</p>" ,
"location" : "querystring" ,
"locationName" : "platformId"
} ,
"statuses" : {
"shape" : "Statuses" ,
"documentation" : "<p>Filters results to return only signing jobs with statuses in the specified list.</p>" ,
"location" : "querystring" ,
"locationName" : "statuses"
2018-10-04 08:50:52 +02:00
}
}
} ,
"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>"
}
}
} ,
2019-11-18 09:46:14 +01:00
"ListTagsForResourceRequest" : {
"type" : "structure" ,
"required" : [ "resourceArn" ] ,
"members" : {
"resourceArn" : {
"shape" : "String" ,
"documentation" : "<p>The Amazon Resource Name (ARN) for the signing profile.</p>" ,
"location" : "uri" ,
"locationName" : "resourceArn"
}
}
} ,
"ListTagsForResourceResponse" : {
"type" : "structure" ,
"members" : {
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>A list of tags associated with the signing profile.</p>"
}
}
} ,
2018-10-04 08:50:52 +02:00
"MaxResults" : {
"type" : "integer" ,
"box" : true ,
"max" : 25 ,
"min" : 1
} ,
"MaxSizeInMB" : { "type" : "integer" } ,
"NextToken" : { "type" : "string" } ,
2019-11-18 09:46:14 +01:00
"NotFoundException" : {
"type" : "structure" ,
"members" : {
2021-01-26 16:12:20 +01:00
"message" : { "shape" : "ErrorMessage" } ,
"code" : { "shape" : "ErrorCode" }
2019-11-18 09:46:14 +01:00
} ,
"documentation" : "<p>The signing profile was not found.</p>" ,
"error" : { "httpStatusCode" : 404 } ,
"exception" : true
} ,
2021-01-26 16:12:20 +01:00
"Permission" : {
"type" : "structure" ,
"members" : {
"action" : {
"shape" : "String" ,
"documentation" : "<p>An AWS Signer action permitted as part of cross-account permissions.</p>"
} ,
"principal" : {
"shape" : "String" ,
"documentation" : "<p>The AWS principal that has been granted a cross-account permission.</p>"
} ,
"statementId" : {
"shape" : "String" ,
"documentation" : "<p>A unique identifier for a cross-account permission statement.</p>"
} ,
"profileVersion" : {
"shape" : "ProfileVersion" ,
"documentation" : "<p>The signing profile version that a permission applies to.</p>"
}
} ,
"documentation" : "<p>A cross-account permission for a signing profile.</p>"
} ,
"Permissions" : {
"type" : "list" ,
"member" : { "shape" : "Permission" }
} ,
2018-10-04 08:50:52 +02:00
"PlatformId" : { "type" : "string" } ,
2021-01-26 16:12:20 +01:00
"PolicySizeBytes" : { "type" : "integer" } ,
2018-10-04 08:50:52 +02:00
"Prefix" : { "type" : "string" } ,
"ProfileName" : {
"type" : "string" ,
2020-03-22 13:12:42 +01:00
"max" : 64 ,
2018-10-04 08:50:52 +02:00
"min" : 2 ,
"pattern" : "^[a-zA-Z0-9_]{2,}"
} ,
2021-01-26 16:12:20 +01:00
"ProfileVersion" : {
"type" : "string" ,
"max" : 10 ,
"min" : 10 ,
"pattern" : "^[a-zA-Z0-9]{10}$"
} ,
2018-10-04 08:50:52 +02:00
"PutSigningProfileRequest" : {
"type" : "structure" ,
"required" : [
"profileName" ,
"platformId"
] ,
"members" : {
"profileName" : {
"shape" : "ProfileName" ,
"documentation" : "<p>The name of the signing profile to be created.</p>" ,
"location" : "uri" ,
"locationName" : "profileName"
} ,
"signingMaterial" : {
"shape" : "SigningMaterial" ,
"documentation" : "<p>The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.</p>"
} ,
2021-01-26 16:12:20 +01:00
"signatureValidityPeriod" : {
"shape" : "SignatureValidityPeriod" ,
"documentation" : "<p>The default validity period override for any signature generated using this signing profile. If unspecified, the default is 135 months.</p>"
} ,
2018-10-04 08:50:52 +02:00
"platformId" : {
"shape" : "PlatformId" ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>The ID of the signing platform to be created.</p>"
2018-10-04 08:50:52 +02:00
} ,
"overrides" : {
"shape" : "SigningPlatformOverrides" ,
"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>"
2019-11-18 09:46:14 +01:00
} ,
"tags" : {
"shape" : "TagMap" ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>Tags to be associated with the signing profile that is being created.</p>"
2018-10-04 08:50:52 +02:00
}
}
} ,
"PutSigningProfileResponse" : {
"type" : "structure" ,
"members" : {
"arn" : {
"shape" : "string" ,
"documentation" : "<p>The Amazon Resource Name (ARN) of the signing profile created.</p>"
2021-01-26 16:12:20 +01:00
} ,
"profileVersion" : {
"shape" : "ProfileVersion" ,
"documentation" : "<p>The version of the signing profile being created.</p>"
} ,
"profileVersionArn" : {
"shape" : "Arn" ,
"documentation" : "<p>The signing profile ARN, including the profile version.</p>"
}
}
} ,
"RemoveProfilePermissionRequest" : {
"type" : "structure" ,
"required" : [
"revisionId" ,
"profileName" ,
"statementId"
] ,
"members" : {
"profileName" : {
"shape" : "ProfileName" ,
"documentation" : "<p>A human-readable name for the signing profile with permissions to be removed.</p>" ,
"location" : "uri" ,
"locationName" : "profileName"
} ,
"revisionId" : {
"shape" : "String" ,
"documentation" : "<p>An identifier for the current revision of the signing profile permissions.</p>" ,
"location" : "querystring" ,
"locationName" : "revisionId"
} ,
"statementId" : {
"shape" : "String" ,
"documentation" : "<p>A unique identifier for the cross-account permissions statement.</p>" ,
"location" : "uri" ,
"locationName" : "statementId"
}
}
} ,
"RemoveProfilePermissionResponse" : {
"type" : "structure" ,
"members" : {
"revisionId" : {
"shape" : "String" ,
"documentation" : "<p>An identifier for the current revision of the profile permissions.</p>"
2018-10-04 08:50:52 +02:00
}
}
} ,
"RequestedBy" : { "type" : "string" } ,
"ResourceNotFoundException" : {
"type" : "structure" ,
"members" : {
2021-01-26 16:12:20 +01:00
"message" : { "shape" : "ErrorMessage" } ,
"code" : { "shape" : "ErrorCode" }
2018-10-04 08:50:52 +02:00
} ,
"documentation" : "<p>A specified resource could not be found.</p>" ,
"error" : { "httpStatusCode" : 404 } ,
"exception" : true
} ,
2021-01-26 16:12:20 +01:00
"RevocationReasonString" : {
"type" : "string" ,
"max" : 500 ,
"min" : 1
} ,
"RevokeSignatureRequest" : {
"type" : "structure" ,
"required" : [
"reason" ,
"jobId"
] ,
"members" : {
"jobId" : {
"shape" : "JobId" ,
"documentation" : "<p>ID of the signing job to be revoked.</p>" ,
"location" : "uri" ,
"locationName" : "jobId"
} ,
"jobOwner" : {
"shape" : "AccountId" ,
"documentation" : "<p>AWS account ID of the job owner.</p>"
} ,
"reason" : {
"shape" : "RevocationReasonString" ,
"documentation" : "<p>The reason for revoking the signing job.</p>"
}
}
} ,
"RevokeSigningProfileRequest" : {
"type" : "structure" ,
"required" : [
"profileVersion" ,
"reason" ,
"effectiveTime" ,
"profileName"
] ,
"members" : {
"profileName" : {
"shape" : "ProfileName" ,
"documentation" : "<p>The name of the signing profile to be revoked.</p>" ,
"location" : "uri" ,
"locationName" : "profileName"
} ,
"profileVersion" : {
"shape" : "ProfileVersion" ,
"documentation" : "<p>The version of the signing profile to be revoked.</p>"
} ,
"reason" : {
"shape" : "RevocationReasonString" ,
"documentation" : "<p>The reason for revoking a signing profile.</p>"
} ,
"effectiveTime" : {
"shape" : "Timestamp" ,
"documentation" : "<p>A timestamp for when revocation of a Signing Profile should become effective. Signatures generated using the signing profile after this timestamp are not trusted.</p>"
}
}
} ,
2018-10-04 08:50:52 +02:00
"S3Destination" : {
"type" : "structure" ,
"members" : {
"bucketName" : {
"shape" : "BucketName" ,
"documentation" : "<p>Name of the S3 bucket.</p>"
} ,
"prefix" : {
"shape" : "Prefix" ,
"documentation" : "<p>An Amazon S3 prefix that you can use to limit responses to those that begin with the specified prefix.</p>"
}
} ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The name and prefix of the S3 bucket where code signing saves your signed objects.</p>"
2018-10-04 08:50:52 +02:00
} ,
"S3SignedObject" : {
"type" : "structure" ,
"members" : {
"bucketName" : {
"shape" : "BucketName" ,
"documentation" : "<p>Name of the S3 bucket.</p>"
} ,
"key" : {
2021-01-26 16:12:20 +01:00
"shape" : "Key" ,
2018-10-04 08:50:52 +02:00
"documentation" : "<p>Key name that uniquely identifies a signed code image in your bucket.</p>"
}
} ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The S3 bucket name and key where code signing saved your signed code image.</p>"
2018-10-04 08:50:52 +02:00
} ,
"S3Source" : {
"type" : "structure" ,
"required" : [
"bucketName" ,
"key" ,
"version"
] ,
"members" : {
"bucketName" : {
"shape" : "BucketName" ,
"documentation" : "<p>Name of the S3 bucket.</p>"
} ,
"key" : {
"shape" : "Key" ,
"documentation" : "<p>Key name of the bucket object that contains your unsigned code.</p>"
} ,
"version" : {
"shape" : "Version" ,
"documentation" : "<p>Version of your source image in your version enabled S3 bucket.</p>"
}
} ,
"documentation" : "<p>Information about the S3 bucket where you saved your unsigned code.</p>"
} ,
2021-01-26 16:12:20 +01:00
"ServiceLimitExceededException" : {
"type" : "structure" ,
"members" : {
"message" : { "shape" : "ErrorMessage" } ,
"code" : { "shape" : "ErrorCode" }
} ,
"documentation" : "<p>The client is making a request that exceeds service limits.</p>" ,
"error" : { "httpStatusCode" : 402 } ,
"exception" : true
} ,
"SignatureValidityPeriod" : {
"type" : "structure" ,
"members" : {
"value" : {
"shape" : "Integer" ,
"documentation" : "<p>The numerical value of the time unit for signature validity.</p>"
} ,
"type" : {
"shape" : "ValidityType" ,
"documentation" : "<p>The time unit for signature validity.</p>"
}
} ,
"documentation" : "<p>The validity period for a signing job.</p>"
} ,
2018-10-04 08:50:52 +02:00
"SignedObject" : {
"type" : "structure" ,
"members" : {
"s3" : {
"shape" : "S3SignedObject" ,
"documentation" : "<p>The <code>S3SignedObject</code>.</p>"
}
} ,
"documentation" : "<p>Points to an <code>S3SignedObject</code> object that contains information about your signed code image.</p>"
} ,
"SigningConfiguration" : {
"type" : "structure" ,
"required" : [
"encryptionAlgorithmOptions" ,
"hashAlgorithmOptions"
] ,
"members" : {
"encryptionAlgorithmOptions" : {
"shape" : "EncryptionAlgorithmOptions" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The encryption algorithm options that are available for a code signing job.</p>"
2018-10-04 08:50:52 +02:00
} ,
"hashAlgorithmOptions" : {
"shape" : "HashAlgorithmOptions" ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>The hash algorithm options that are available for a code signing job.</p>"
2018-10-04 08:50:52 +02:00
}
} ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The configuration of a code signing operation.</p>"
2018-10-04 08:50:52 +02:00
} ,
"SigningConfigurationOverrides" : {
"type" : "structure" ,
"members" : {
"encryptionAlgorithm" : {
"shape" : "EncryptionAlgorithm" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>A specified override of the default encryption algorithm that is used in a code signing job.</p>"
2018-10-04 08:50:52 +02:00
} ,
"hashAlgorithm" : {
"shape" : "HashAlgorithm" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>A specified override of the default hash algorithm that is used in a code signing job.</p>"
2018-10-04 08:50:52 +02:00
}
} ,
"documentation" : "<p>A signing configuration that overrides the default encryption or hash algorithm of a signing job.</p>"
} ,
"SigningImageFormat" : {
"type" : "structure" ,
"required" : [
"supportedFormats" ,
"defaultFormat"
] ,
"members" : {
"supportedFormats" : {
"shape" : "ImageFormats" ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>The supported formats of a code signing image.</p>"
2018-10-04 08:50:52 +02:00
} ,
"defaultFormat" : {
"shape" : "ImageFormat" ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>The default format of a code signing image.</p>"
2018-10-04 08:50:52 +02:00
}
} ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The image format of a code signing platform or profile.</p>"
2018-10-04 08:50:52 +02:00
} ,
"SigningJob" : {
"type" : "structure" ,
"members" : {
"jobId" : {
"shape" : "JobId" ,
"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" : {
2021-01-26 16:12:20 +01:00
"shape" : "Timestamp" ,
2018-10-04 08:50:52 +02:00
"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>"
2021-01-26 16:12:20 +01:00
} ,
"isRevoked" : {
"shape" : "bool" ,
"documentation" : "<p>Indicates whether the signing job is revoked.</p>"
} ,
"profileName" : {
"shape" : "ProfileName" ,
"documentation" : "<p>The name of the signing profile that created a signing job.</p>"
} ,
"profileVersion" : {
"shape" : "ProfileVersion" ,
"documentation" : "<p>The version of the signing profile that created a signing job.</p>"
} ,
"platformId" : {
"shape" : "PlatformId" ,
"documentation" : "<p>The unique identifier for a signing platform.</p>"
} ,
"platformDisplayName" : {
"shape" : "DisplayName" ,
"documentation" : "<p>The name of a signing platform.</p>"
} ,
"signatureExpiresAt" : {
"shape" : "Timestamp" ,
"documentation" : "<p>The time when the signature of a signing job expires.</p>"
} ,
"jobOwner" : {
"shape" : "AccountId" ,
"documentation" : "<p>The AWS account ID of the job owner.</p>"
} ,
"jobInvoker" : {
"shape" : "AccountId" ,
"documentation" : "<p>The AWS account ID of the job invoker.</p>"
2018-10-04 08:50:52 +02:00
}
} ,
"documentation" : "<p>Contains information about a signing job.</p>"
} ,
2021-01-26 16:12:20 +01:00
"SigningJobRevocationRecord" : {
"type" : "structure" ,
"members" : {
"reason" : {
"shape" : "String" ,
"documentation" : "<p>A caller-supplied reason for revocation.</p>"
} ,
"revokedAt" : {
"shape" : "Timestamp" ,
"documentation" : "<p>The time of revocation.</p>"
} ,
"revokedBy" : {
"shape" : "String" ,
"documentation" : "<p>The identity of the revoker.</p>"
}
} ,
"documentation" : "<p>Revocation information for a signing job.</p>"
} ,
2018-10-04 08:50:52 +02:00
"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>"
} ,
"SigningParameterKey" : { "type" : "string" } ,
"SigningParameterValue" : { "type" : "string" } ,
"SigningParameters" : {
"type" : "map" ,
"key" : { "shape" : "SigningParameterKey" } ,
"value" : { "shape" : "SigningParameterValue" }
} ,
"SigningPlatform" : {
"type" : "structure" ,
"members" : {
"platformId" : {
"shape" : "String" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The ID of a code signing; platform.</p>"
2018-10-04 08:50:52 +02:00
} ,
"displayName" : {
"shape" : "String" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The display name of a code signing platform.</p>"
2018-10-04 08:50:52 +02:00
} ,
"partner" : {
"shape" : "String" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>Any partner entities linked to a code signing platform.</p>"
2018-10-04 08:50:52 +02:00
} ,
"target" : {
"shape" : "String" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The types of targets that can be signed by a code signing platform.</p>"
2018-10-04 08:50:52 +02:00
} ,
"category" : {
"shape" : "Category" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The category of a code signing platform.</p>"
2018-10-04 08:50:52 +02:00
} ,
"signingConfiguration" : {
"shape" : "SigningConfiguration" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The configuration of a code signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.</p>"
2018-10-04 08:50:52 +02:00
} ,
2019-11-18 09:46:14 +01:00
"signingImageFormat" : { "shape" : "SigningImageFormat" } ,
2018-10-04 08:50:52 +02:00
"maxSizeInMB" : {
"shape" : "MaxSizeInMB" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The maximum size (in MB) of code that can be signed by a code signing platform.</p>"
2021-01-26 16:12:20 +01:00
} ,
"revocationSupported" : {
"shape" : "bool" ,
"documentation" : "<p>Indicates whether revocation is supported for the platform.</p>"
2018-10-04 08:50:52 +02:00
}
} ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>Contains information about the signing configurations and parameters that are used to perform a code signing job.</p>"
2018-10-04 08:50:52 +02:00
} ,
"SigningPlatformOverrides" : {
"type" : "structure" ,
"members" : {
2019-11-18 09:46:14 +01:00
"signingConfiguration" : {
"shape" : "SigningConfigurationOverrides" ,
"documentation" : "<p>A signing configuration that overrides the default encryption or hash algorithm of a signing job.</p>"
2020-03-22 13:12:42 +01:00
} ,
"signingImageFormat" : {
"shape" : "ImageFormat" ,
"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>"
2019-11-18 09:46:14 +01:00
}
2018-10-04 08:50:52 +02:00
} ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>Any overrides that are applied to the signing configuration of a code signing platform.</p>"
2018-10-04 08:50:52 +02:00
} ,
"SigningPlatforms" : {
"type" : "list" ,
"member" : { "shape" : "SigningPlatform" }
} ,
"SigningProfile" : {
"type" : "structure" ,
"members" : {
"profileName" : {
"shape" : "ProfileName" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The name of the signing profile.</p>"
2018-10-04 08:50:52 +02:00
} ,
2021-01-26 16:12:20 +01:00
"profileVersion" : {
"shape" : "ProfileVersion" ,
"documentation" : "<p>The version of a signing profile.</p>"
} ,
"profileVersionArn" : {
"shape" : "Arn" ,
"documentation" : "<p>The ARN of a signing profile, including the profile version.</p>"
} ,
2018-10-04 08:50:52 +02:00
"signingMaterial" : {
"shape" : "SigningMaterial" ,
"documentation" : "<p>The ACM certificate that is available for use by a signing profile.</p>"
} ,
2021-01-26 16:12:20 +01:00
"signatureValidityPeriod" : {
"shape" : "SignatureValidityPeriod" ,
"documentation" : "<p>The validity period for a signing job created using this signing profile.</p>"
} ,
2018-10-04 08:50:52 +02:00
"platformId" : {
"shape" : "PlatformId" ,
"documentation" : "<p>The ID of a platform that is available for use by a signing profile.</p>"
} ,
2021-01-26 16:12:20 +01:00
"platformDisplayName" : {
"shape" : "DisplayName" ,
"documentation" : "<p>The name of the signing platform.</p>"
} ,
2018-10-04 08:50:52 +02:00
"signingParameters" : {
"shape" : "SigningParameters" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The parameters that are available for use by a code signing user.</p>"
2018-10-04 08:50:52 +02:00
} ,
"status" : {
"shape" : "SigningProfileStatus" ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>The status of a code signing profile.</p>"
} ,
"arn" : {
"shape" : "string" ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>The Amazon Resource Name (ARN) for the signing profile.</p>"
2019-11-18 09:46:14 +01:00
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>A list of tags associated with the signing profile.</p>"
2018-10-04 08:50:52 +02:00
}
} ,
2019-11-18 09:46:14 +01:00
"documentation" : "<p>Contains information about the ACM certificates and code signing configuration parameters that can be used by a given code signing user.</p>"
2018-10-04 08:50:52 +02:00
} ,
2021-01-26 16:12:20 +01:00
"SigningProfileRevocationRecord" : {
"type" : "structure" ,
"members" : {
"revocationEffectiveFrom" : {
"shape" : "Timestamp" ,
"documentation" : "<p>The time when revocation becomes effective.</p>"
} ,
"revokedAt" : {
"shape" : "Timestamp" ,
"documentation" : "<p>The time when the signing profile was revoked.</p>"
} ,
"revokedBy" : {
"shape" : "String" ,
"documentation" : "<p>The identity of the revoker.</p>"
}
} ,
"documentation" : "<p>Revocation information for a signing profile.</p>"
} ,
2018-10-04 08:50:52 +02:00
"SigningProfileStatus" : {
"type" : "string" ,
"enum" : [
"Active" ,
2021-01-26 16:12:20 +01:00
"Canceled" ,
"Revoked"
2018-10-04 08:50:52 +02:00
]
} ,
"SigningProfiles" : {
"type" : "list" ,
"member" : { "shape" : "SigningProfile" }
} ,
"SigningStatus" : {
"type" : "string" ,
"enum" : [
"InProgress" ,
"Failed" ,
"Succeeded"
]
} ,
"Source" : {
"type" : "structure" ,
"members" : {
"s3" : {
"shape" : "S3Source" ,
"documentation" : "<p>The <code>S3Source</code> object.</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" ,
2021-01-26 16:12:20 +01:00
"profileName" ,
2018-10-04 08:50:52 +02:00
"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
2021-01-26 16:12:20 +01:00
} ,
"profileOwner" : {
"shape" : "AccountId" ,
"documentation" : "<p>The AWS account ID of the signing profile owner.</p>"
2018-10-04 08:50:52 +02:00
}
}
} ,
"StartSigningJobResponse" : {
"type" : "structure" ,
"members" : {
"jobId" : {
"shape" : "JobId" ,
"documentation" : "<p>The ID of your signing job.</p>"
2021-01-26 16:12:20 +01:00
} ,
"jobOwner" : {
"shape" : "AccountId" ,
"documentation" : "<p>The AWS account ID of the signing job owner.</p>"
2018-10-04 08:50:52 +02:00
}
}
} ,
"StatusReason" : { "type" : "string" } ,
2021-01-26 16:12:20 +01:00
"Statuses" : {
"type" : "list" ,
"member" : { "shape" : "SigningProfileStatus" }
} ,
2018-10-04 08:50:52 +02:00
"String" : { "type" : "string" } ,
2019-11-18 09:46:14 +01:00
"TagKey" : {
"type" : "string" ,
"max" : 128 ,
"min" : 1 ,
"pattern" : "^(?!aws:)[a-zA-Z+-=._:/]+$"
} ,
"TagKeyList" : {
"type" : "list" ,
"member" : { "shape" : "TagKey" } ,
"max" : 200 ,
"min" : 1
} ,
"TagMap" : {
"type" : "map" ,
"key" : { "shape" : "TagKey" } ,
"value" : { "shape" : "TagValue" } ,
"max" : 200 ,
"min" : 1
} ,
"TagResourceRequest" : {
"type" : "structure" ,
"required" : [
"resourceArn" ,
"tags"
] ,
"members" : {
"resourceArn" : {
"shape" : "String" ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>The Amazon Resource Name (ARN) for the signing profile.</p>" ,
2019-11-18 09:46:14 +01:00
"location" : "uri" ,
"locationName" : "resourceArn"
} ,
"tags" : {
"shape" : "TagMap" ,
"documentation" : "<p>One or more tags to be associated with the signing profile.</p>"
}
}
} ,
"TagResourceResponse" : {
"type" : "structure" ,
"members" : {
}
} ,
"TagValue" : {
"type" : "string" ,
"max" : 256
} ,
2018-10-04 08:50:52 +02:00
"ThrottlingException" : {
"type" : "structure" ,
"members" : {
2021-01-26 16:12:20 +01:00
"message" : { "shape" : "ErrorMessage" } ,
"code" : { "shape" : "ErrorCode" }
} ,
"documentation" : "<p>The request was denied due to request throttling.</p> <p>Instead of this error, <code>TooManyRequestsException</code> should be used.</p>" ,
"deprecated" : true ,
"deprecatedMessage" : "Instead of this error, TooManyRequestsException should be used." ,
"error" : { "httpStatusCode" : 429 } ,
"exception" : true
} ,
"Timestamp" : { "type" : "timestamp" } ,
"TooManyRequestsException" : {
"type" : "structure" ,
"members" : {
"message" : { "shape" : "ErrorMessage" } ,
"code" : { "shape" : "ErrorCode" }
2018-10-04 08:50:52 +02:00
} ,
2021-01-26 16:12:20 +01:00
"documentation" : "<p>The allowed number of job-signing requests has been exceeded.</p> <p>This error supersedes the error <code>ThrottlingException</code>.</p>" ,
2018-10-04 08:50:52 +02:00
"error" : { "httpStatusCode" : 429 } ,
"exception" : true
} ,
2019-11-18 09:46:14 +01:00
"UntagResourceRequest" : {
"type" : "structure" ,
"required" : [
"resourceArn" ,
"tagKeys"
] ,
"members" : {
"resourceArn" : {
"shape" : "String" ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>The Amazon Resource Name (ARN) for the signing profile.</p>" ,
2019-11-18 09:46:14 +01:00
"location" : "uri" ,
"locationName" : "resourceArn"
} ,
"tagKeys" : {
"shape" : "TagKeyList" ,
2020-03-22 13:12:42 +01:00
"documentation" : "<p>A list of tag keys to be removed from the signing profile.</p>" ,
2019-11-18 09:46:14 +01:00
"location" : "querystring" ,
"locationName" : "tagKeys"
}
}
} ,
"UntagResourceResponse" : {
"type" : "structure" ,
"members" : {
}
} ,
2018-10-04 08:50:52 +02:00
"ValidationException" : {
"type" : "structure" ,
"members" : {
2021-01-26 16:12:20 +01:00
"message" : { "shape" : "ErrorMessage" } ,
"code" : { "shape" : "ErrorCode" }
2018-10-04 08:50:52 +02:00
} ,
"documentation" : "<p>You signing certificate could not be validated.</p>" ,
"error" : { "httpStatusCode" : 400 } ,
"exception" : true
} ,
2021-01-26 16:12:20 +01:00
"ValidityType" : {
"type" : "string" ,
"enum" : [
"DAYS" ,
"MONTHS" ,
"YEARS"
]
} ,
2018-10-04 08:50:52 +02:00
"Version" : { "type" : "string" } ,
"bool" : { "type" : "boolean" } ,
"string" : { "type" : "string" }
} ,
2021-01-26 16:12:20 +01:00
"documentation" : "<p>AWS Signer is a fully managed code signing service to help you ensure the trust and integrity of your code. </p> <p>AWS Signer supports the following applications:</p> <p>With <i>code signing for AWS Lambda</i>, 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. </p> <p>With <i>code signing for IoT</i>, you can sign code for any IoT device that is supported by AWS. IoT code signing is available for <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 is 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 using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management. </p> <p>For more information about AWS Signer, see the <a href=\"http://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html\">AWS Signer Developer Guide</a>.</p> <p/>"
2018-10-04 08:50:52 +02:00
}