openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 81.3 kB

JSON

{"openapi":"3.0.0","info":{"version":"2017-08-25","x-release":"v4","title":"AWS Signer","description":"AWS Signer is a fully managed code signing service to help you ensure the trust and integrity of your code. AWS Signer supports the following applications: With code signing for AWS Lambda, you can sign <a href=\"http://docs.aws.amazon.com/lambda/latest/dg/\">AWS Lambda</a> deployment packages. Integrated support is provided for <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/gsg/\">Amazon S3</a>, <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/\">Amazon CloudWatch</a>, and <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/\">AWS CloudTrail</a>. In order to sign code, you create a signing profile and then use Signer to sign Lambda zip files in S3. With code signing for IoT, you can sign code for any IoT device that is supported by AWS. IoT code signing is available for <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. With code signing for containers …(TBD) For more information about AWS Signer, see the <a href=\"https://docs.aws.amazon.com/signer/latest/developerguide/Welcome.html\">AWS Signer Developer Guide</a>.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"signer","x-aws-signingName":"signer","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/signer-2017-08-25.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/signer/"},"servers":[{"url":"http://signer.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The signer multi-region endpoint"},{"url":"https://signer.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The signer multi-region endpoint"},{"url":"http://signer.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The signer endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://signer.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The signer endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/signing-profiles/{profileName}/permissions":{"post":{"operationId":"AddProfilePermission","description":"Adds cross-account permissions to a signing profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddProfilePermissionResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ServiceLimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceLimitExceededException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"486":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"profileName","in":"path","required":true,"description":"The human-readable name of the signing profile.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_]{2,}","minLength":2,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action","principal","statementId"],"properties":{"profileVersion":{"description":"The version of the signing profile.","type":"string","pattern":"^[a-zA-Z0-9]{10}$","minLength":10,"maxLength":10},"action":{"description":"The AWS Signer action permitted as part of cross-account permissions.","type":"string"},"principal":{"description":"The AWS principal receiving cross-account permissions. This may be an IAM role or another AWS account ID.","type":"string"},"revisionId":{"description":"A unique identifier for the current profile revision.","type":"string"},"statementId":{"description":"A unique identifier for the cross-account permission statement.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListProfilePermissions","description":"Lists the cross-account permissions associated with a signing profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProfilePermissionsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"484":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"profileName","in":"path","required":true,"description":"Name of the signing profile containing the cross-account permissions.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_]{2,}","minLength":2,"maxLength":64}},{"name":"nextToken","in":"query","required":false,"description":"String for specifying the next set of paginated results.","schema":{"type":"string"}}]}},"/signing-profiles/{profileName}":{"delete":{"operationId":"CancelSigningProfile","description":"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.","responses":{"200":{"description":"Success"},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"profileName","in":"path","required":true,"description":"The name of the signing profile to be canceled.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_]{2,}","minLength":2,"maxLength":64}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetSigningProfile","description":"Returns information on a specific signing profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSigningProfileResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"profileName","in":"path","required":true,"description":"The name of the target signing profile.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_]{2,}","minLength":2,"maxLength":64}},{"name":"profileOwner","in":"query","required":false,"description":"The AWS account ID of the profile owner.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}}]},"put":{"operationId":"PutSigningProfile","description":"Creates a signing profile. A signing profile is a code signing template that can be used to carry out a pre-defined signing job. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutSigningProfileResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"484":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"profileName","in":"path","required":true,"description":"The name of the signing profile to be created.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_]{2,}","minLength":2,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["platformId"],"properties":{"signingMaterial":{"description":"The ACM certificate that is used to sign your code.","type":"object","properties":{"certificateArn":{"allOf":[{"$ref":"#/components/schemas/CertificateArn"},{"description":"The Amazon Resource Name (ARN) of the certificates that is used to sign your code."}]}}},"signatureValidityPeriod":{"description":"The validity period for a signing job.","type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/Integer"},{"description":"The numerical value of the time unit for signature validity."}]},"type":{"allOf":[{"$ref":"#/components/schemas/ValidityType"},{"description":"The time unit for signature validity."}]}}},"platformId":{"description":"The ID of the signing platform to be created.","type":"string"},"overrides":{"description":"Any overrides that are applied to the signing configuration of a code signing platform.","type":"object","properties":{"signingConfiguration":{"allOf":[{"$ref":"#/components/schemas/SigningConfigurationOverrides"},{"description":"A signing configuration that overrides the default encryption or hash algorithm of a signing job."}]},"signingImageFormat":{"allOf":[{"$ref":"#/components/schemas/ImageFormat"},{"description":"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."}]}}},"signingParameters":{"description":"Map of key-value pairs for signing. These can include any information that you want to use during signing.","type":"object","additionalProperties":{"$ref":"#/components/schemas/SigningParameterValue"}},"tags":{"description":"Tags to be associated with the signing profile that is being created.","type":"object","minProperties":1,"maxProperties":200,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}}},"/signing-jobs/{jobId}":{"get":{"operationId":"DescribeSigningJob","description":"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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeSigningJobResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"jobId","in":"path","required":true,"description":"The ID of the signing job on input.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/revocations#signatureTimestamp&platformId&profileVersionArn&jobArn&certificateHashes":{"get":{"operationId":"GetRevocationStatus","description":"Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRevocationStatusResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"signatureTimestamp","in":"query","required":true,"description":"The timestamp of the signature that validates the profile or job.","schema":{"type":"string","format":"date-time"}},{"name":"platformId","in":"query","required":true,"description":"The ID of a signing platform. ","schema":{"type":"string"}},{"name":"profileVersionArn","in":"query","required":true,"description":"The version of a signing profile.","schema":{"type":"string","minLength":20,"maxLength":2048}},{"name":"jobArn","in":"query","required":true,"description":"The ARN of a signing job.","schema":{"type":"string","minLength":20,"maxLength":2048}},{"name":"certificateHashes","in":"query","required":true,"description":"A list of composite signed hashes that identify certificates. A certificate identifier consists of a subject certificate TBS hash (signed by the parent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root certificates are defined as their own CA.","schema":{"type":"array","items":{"$ref":"#/components/schemas/String"}}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/signing-platforms/{platformId}":{"get":{"operationId":"GetSigningPlatform","description":"Returns information on a specific signing platform.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSigningPlatformResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"platformId","in":"path","required":true,"description":"The ID of the target signing platform.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/signing-jobs":{"get":{"operationId":"ListSigningJobs","description":"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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSigningJobsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"status","in":"query","required":false,"description":"A status value with which to filter your results.","schema":{"type":"string","enum":["InProgress","Failed","Succeeded"]}},{"name":"platformId","in":"query","required":false,"description":"The ID of microcontroller platform that you specified for the distribution of your code image.","schema":{"type":"string"}},{"name":"requestedBy","in":"query","required":false,"description":"The IAM principal that requested the signing job.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"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. ","schema":{"type":"integer","minimum":1,"maximum":25}},{"name":"nextToken","in":"query","required":false,"description":"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.","schema":{"type":"string"}},{"name":"isRevoked","in":"query","required":false,"description":"Filters results to return only signing jobs with revoked signatures.","schema":{"type":"boolean"}},{"name":"signatureExpiresBefore","in":"query","required":false,"description":"Filters results to return only signing jobs with signatures expiring before a specified timestamp.","schema":{"type":"string","format":"date-time"}},{"name":"signatureExpiresAfter","in":"query","required":false,"description":"Filters results to return only signing jobs with signatures expiring after a specified timestamp.","schema":{"type":"string","format":"date-time"}},{"name":"jobInvoker","in":"query","required":false,"description":"Filters results to return only signing jobs initiated by a specified IAM entity.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"StartSigningJob","description":"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: <ul> <li> You must create an Amazon S3 source bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html\">Creating a Bucket</a> in the Amazon S3 Getting Started Guide. </li> <li> Your S3 source bucket must be version enabled. </li> <li> You must create an S3 destination bucket. Code signing uses your S3 destination bucket to write your signed code. </li> <li> You specify the name of the source and destination buckets when calling the <code>StartSigningJob</code> operation. </li> <li> You must also specify a request token that identifies your request to code signing. </li> </ul> You can call the <a>DescribeSigningJob</a> and the <a>ListSigningJobs</a> actions after you call <code>StartSigningJob</code>. For a Java example that shows how to use this action, see <a href=\"https://docs.aws.amazon.com/signer/latest/developerguide/api-startsigningjob.html\">StartSigningJob</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartSigningJobResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source","destination","profileName","clientRequestToken"],"properties":{"source":{"description":"An <code>S3Source</code> object that contains information about the S3 bucket where you saved your unsigned code.","type":"object","properties":{"s3":{"allOf":[{"$ref":"#/components/schemas/S3Source"},{"description":"The <code>S3Source</code> object."}]}}},"destination":{"description":"Points to an <code>S3Destination</code> object that contains information about your S3 bucket.","type":"object","properties":{"s3":{"allOf":[{"$ref":"#/components/schemas/S3Destination"},{"description":"The <code>S3Destination</code> object."}]}}},"profileName":{"description":"The name of the signing profile.","type":"string","pattern":"^[a-zA-Z0-9_]{2,}","minLength":2,"maxLength":64},"clientRequestToken":{"description":"String that identifies the signing request. All calls after the first that use this token return the same response as the first call.","type":"string"},"profileOwner":{"description":"The AWS account ID of the signing profile owner.","type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}}}}}}}},"/signing-platforms":{"get":{"operationId":"ListSigningPlatforms","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSigningPlatformsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"category","in":"query","required":false,"description":"The category type of a signing platform.","schema":{"type":"string"}},{"name":"partner","in":"query","required":false,"description":"Any partner entities connected to a signing platform.","schema":{"type":"string"}},{"name":"target","in":"query","required":false,"description":"The validation template that is used by the target signing platform.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to be returned by this operation.","schema":{"type":"integer","minimum":1,"maximum":25}},{"name":"nextToken","in":"query","required":false,"description":"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.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/signing-profiles":{"get":{"operationId":"ListSigningProfiles","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSigningProfilesResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"482":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"includeCanceled","in":"query","required":false,"description":"Designates whether to include profiles with the status of <code>CANCELED</code>.","schema":{"type":"boolean"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of profiles to be returned.","schema":{"type":"integer","minimum":1,"maximum":25}},{"name":"nextToken","in":"query","required":false,"description":"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.","schema":{"type":"string"}},{"name":"platformId","in":"query","required":false,"description":"Filters results to return only signing jobs initiated for a specified signing platform.","schema":{"type":"string"}},{"name":"statuses","in":"query","required":false,"description":"Filters results to return only signing jobs with statuses in the specified list.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SigningProfileStatus"}}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{resourceArn}":{"get":{"operationId":"ListTagsForResource","description":"Returns a list of the tags associated with a signing profile resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsForResourceResponse"}}}},"480":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) for the signing profile.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"TagResource","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResourceResponse"}}}},"480":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) for the signing profile.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tags"],"properties":{"tags":{"description":"One or more tags to be associated with the signing profile.","type":"object","minProperties":1,"maxProperties":200,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}}},"/signing-profiles/{profileName}/permissions/{statementId}#revisionId":{"delete":{"operationId":"RemoveProfilePermission","description":"Removes cross-account permissions from a signing profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveProfilePermissionResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"485":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"profileName","in":"path","required":true,"description":"A human-readable name for the signing profile with permissions to be removed.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_]{2,}","minLength":2,"maxLength":64}},{"name":"revisionId","in":"query","required":true,"description":"An identifier for the current revision of the signing profile permissions.","schema":{"type":"string"}},{"name":"statementId","in":"path","required":true,"description":"A unique identifier for the cross-account permissions statement.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/signing-jobs/{jobId}/revoke":{"put":{"operationId":"RevokeSignature","description":"Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.","responses":{"200":{"description":"Success"},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"484":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"jobId","in":"path","required":true,"description":"ID of the signing job to be revoked.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["reason"],"properties":{"jobOwner":{"description":"AWS account ID of the job owner.","type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12},"reason":{"description":"The reason for revoking the signing job.","type":"string","minLength":1,"maxLength":500}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/signing-profiles/{profileName}/revoke":{"put":{"operationId":"RevokeSigningProfile","description":"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.","responses":{"200":{"description":"Success"},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"484":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[{"name":"profileName","in":"path","required":true,"description":"The name of the signing profile to be revoked.","schema":{"type":"string","pattern":"^[a-zA-Z0-9_]{2,}","minLength":2,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileVersion","reason","effectiveTime"],"properties":{"profileVersion":{"description":"The version of the signing profile to be revoked.","type":"string","pattern":"^[a-zA-Z0-9]{10}$","minLength":10,"maxLength":10},"reason":{"description":"The reason for revoking a signing profile.","type":"string","minLength":1,"maxLength":500},"effectiveTime":{"description":"A timestamp for when revocation of a Signing Profile should become effective. Signatures generated using the signing profile after this timestamp are not trusted.","type":"string","format":"date-time"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/signing-jobs/with-payload":{"post":{"operationId":"SignPayload","description":"Signs a binary payload and returns a signature envelope.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignPayloadResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}},"484":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["profileName","payload","payloadFormat"],"properties":{"profileName":{"description":"The name of the signing profile.","type":"string","pattern":"^[a-zA-Z0-9_]{2,}","minLength":2,"maxLength":64},"profileOwner":{"description":"The AWS account ID of the profile owner.","type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12},"payload":{"description":"Specifies the object digest (hash) to sign.","type":"string","minLength":1,"maxLength":4096},"payloadFormat":{"description":"Payload content type","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{resourceArn}#tagKeys":{"delete":{"operationId":"UntagResource","description":"Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UntagResourceResponse"}}}},"480":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}},"481":{"description":"BadRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"TooManyRequestsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) for the signing profile.","schema":{"type":"string"}},{"name":"tagKeys","in":"query","required":true,"description":"A list of tag keys to be removed from the signing profile.","schema":{"type":"array","items":{"$ref":"#/components/schemas/TagKey"},"minItems":1,"maxItems":200}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"AddProfilePermissionResponse":{"type":"object","properties":{"revisionId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"A unique identifier for the current profile revision."}]}}},"ValidationException":{},"ResourceNotFoundException":{},"AccessDeniedException":{},"ServiceLimitExceededException":{},"ConflictException":{},"TooManyRequestsException":{},"InternalServiceErrorException":{},"DescribeSigningJobResponse":{"type":"object","properties":{"jobId":{"allOf":[{"$ref":"#/components/schemas/JobId"},{"description":"The ID of the signing job on output."}]},"source":{"allOf":[{"$ref":"#/components/schemas/Source"},{"description":"The object that contains the name of your S3 bucket or your raw code."}]},"signingMaterial":{"allOf":[{"$ref":"#/components/schemas/SigningMaterial"},{"description":"The Amazon Resource Name (ARN) of your code signing certificate."}]},"platformId":{"allOf":[{"$ref":"#/components/schemas/PlatformId"},{"description":"The microcontroller platform to which your signed code image will be distributed."}]},"platformDisplayName":{"allOf":[{"$ref":"#/components/schemas/DisplayName"},{"description":"A human-readable name for the signing platform associated with the signing job."}]},"profileName":{"allOf":[{"$ref":"#/components/schemas/ProfileName"},{"description":"The name of the profile that initiated the signing operation."}]},"profileVersion":{"allOf":[{"$ref":"#/components/schemas/ProfileVersion"},{"description":"The version of the signing profile used to initiate the signing job."}]},"overrides":{"allOf":[{"$ref":"#/components/schemas/SigningPlatformOverrides"},{"description":"A list of any overrides that were applied to the signing operation."}]},"signingParameters":{"allOf":[{"$ref":"#/components/schemas/SigningParameters"},{"description":"Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job. "}]},"createdAt":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"Date and time that the signing job was created."}]},"completedAt":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"Date and time that the signing job was completed."}]},"signatureExpiresAt":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"Thr expiration timestamp for the signature generated by the signing job."}]},"requestedBy":{"allOf":[{"$ref":"#/components/schemas/RequestedBy"},{"description":"The IAM principal that requested the signing job."}]},"status":{"allOf":[{"$ref":"#/components/schemas/SigningStatus"},{"description":"Status of the signing job."}]},"statusReason":{"allOf":[{"$ref":"#/components/schemas/StatusReason"},{"description":"String value that contains the status reason."}]},"revocationRecord":{"allOf":[{"$ref":"#/components/schemas/SigningJobRevocationRecord"},{"description":"A revocation record if th