{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.signer#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.signer#ErrorMessage" }, "code": { "target": "com.amazonaws.signer#ErrorCode" } }, "traits": { "smithy.api#documentation": "
You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.signer#AccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.signer#AddProfilePermission": { "type": "operation", "input": { "target": "com.amazonaws.signer#AddProfilePermissionRequest" }, "output": { "target": "com.amazonaws.signer#AddProfilePermissionResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#ConflictException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#ServiceLimitExceededException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" }, { "target": "com.amazonaws.signer#ValidationException" } ], "traits": { "smithy.api#documentation": "Adds cross-account permissions to a signing profile.
", "smithy.api#http": { "method": "POST", "uri": "/signing-profiles/{profileName}/permissions", "code": 200 } } }, "com.amazonaws.signer#AddProfilePermissionRequest": { "type": "structure", "members": { "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "The human-readable name of the signing profile.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "profileVersion": { "target": "com.amazonaws.signer#ProfileVersion", "traits": { "smithy.api#documentation": "The version of the signing profile.
" } }, "action": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "For cross-account signing. Grant a designated account permission to perform one or more of the following actions. Each action is associated with a specific API's operations. For more information about cross-account signing, see Using cross-account signing with signing profiles in the AWS Signer Developer Guide.
\nYou can designate the following actions to an account.
\n\n signer:StartSigningJob. This action isn't supported for container image workflows. For details, see StartSigningJob.
\n signer:SignPayload. This action isn't supported for AWS Lambda workflows. For details, see SignPayload\n
\n signer:GetSigningProfile. For details, see GetSigningProfile.
\n signer:RevokeSignature. For details, see RevokeSignature.
The AWS principal receiving cross-account permissions. This may be an IAM role or another\n\t\t\tAWS account ID.
", "smithy.api#required": {} } }, "revisionId": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "A unique identifier for the current profile revision.
" } }, "statementId": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "A unique identifier for the cross-account permission statement.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#AddProfilePermissionResponse": { "type": "structure", "members": { "revisionId": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "A unique identifier for the current profile revision.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 } } }, "com.amazonaws.signer#BadRequestException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.signer#ErrorMessage" }, "code": { "target": "com.amazonaws.signer#ErrorCode" } }, "traits": { "smithy.api#documentation": "The request contains invalid parameters for the ARN or tags. This exception also\n\t\t\toccurs when you call a tagging API on a cancelled signing profile.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.signer#Blob": { "type": "blob" }, "com.amazonaws.signer#BucketName": { "type": "string" }, "com.amazonaws.signer#CancelSigningProfile": { "type": "operation", "input": { "target": "com.amazonaws.signer#CancelSigningProfileRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Changes the state of an ACTIVE signing profile to CANCELED.\n\t\t\tA canceled profile is still viewable with the ListSigningProfiles\n\t\t\t\toperation, but it cannot perform new signing jobs. See Data Retention for more information on scheduled deletion of a canceled signing profile.
The name of the signing profile to be canceled.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#Category": { "type": "enum", "members": { "AWSIoT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWSIoT" } } } }, "com.amazonaws.signer#CertificateArn": { "type": "string" }, "com.amazonaws.signer#CertificateHashes": { "type": "list", "member": { "target": "com.amazonaws.signer#String" } }, "com.amazonaws.signer#ClientRequestToken": { "type": "string" }, "com.amazonaws.signer#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.signer#ErrorMessage" }, "code": { "target": "com.amazonaws.signer#ErrorCode" } }, "traits": { "smithy.api#documentation": "The resource encountered a conflicting state.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.signer#DescribeSigningJob": { "type": "operation", "input": { "target": "com.amazonaws.signer#DescribeSigningJobRequest" }, "output": { "target": "com.amazonaws.signer#DescribeSigningJobResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns information about a specific code signing job. You specify the job by using the\n\t\t\t\tjobId value that is returned by the StartSigningJob\n\t\t\toperation.
The ID of the signing job on input.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#DescribeSigningJobResponse": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.signer#JobId", "traits": { "smithy.api#documentation": "The ID of the signing job on output.
" } }, "source": { "target": "com.amazonaws.signer#Source", "traits": { "smithy.api#documentation": "The object that contains the name of your S3 bucket or your raw code.
" } }, "signingMaterial": { "target": "com.amazonaws.signer#SigningMaterial", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of your code signing certificate.
" } }, "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { "smithy.api#documentation": "The microcontroller platform to which your signed code image will be\n\t\t\tdistributed.
" } }, "platformDisplayName": { "target": "com.amazonaws.signer#DisplayName", "traits": { "smithy.api#documentation": "A human-readable name for the signing platform associated with the signing job.
" } }, "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "The name of the profile that initiated the signing operation.
" } }, "profileVersion": { "target": "com.amazonaws.signer#ProfileVersion", "traits": { "smithy.api#documentation": "The version of the signing profile used to initiate the signing job.
" } }, "overrides": { "target": "com.amazonaws.signer#SigningPlatformOverrides", "traits": { "smithy.api#documentation": "A list of any overrides that were applied to the signing operation.
" } }, "signingParameters": { "target": "com.amazonaws.signer#SigningParameters", "traits": { "smithy.api#documentation": "Map of user-assigned key-value pairs used during signing. These values contain any\n\t\t\tinformation that you specified for use in your signing job.
" } }, "createdAt": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "Date and time that the signing job was created.
" } }, "completedAt": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "Date and time that the signing job was completed.
" } }, "signatureExpiresAt": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "Thr expiration timestamp for the signature generated by the signing job.
" } }, "requestedBy": { "target": "com.amazonaws.signer#RequestedBy", "traits": { "smithy.api#documentation": "The IAM principal that requested the signing job.
" } }, "status": { "target": "com.amazonaws.signer#SigningStatus", "traits": { "smithy.api#documentation": "Status of the signing job.
" } }, "statusReason": { "target": "com.amazonaws.signer#StatusReason", "traits": { "smithy.api#documentation": "String value that contains the status reason.
" } }, "revocationRecord": { "target": "com.amazonaws.signer#SigningJobRevocationRecord", "traits": { "smithy.api#documentation": "A revocation record if the signature generated by the signing job has been revoked.\n\t\t\tContains a timestamp and the ID of the IAM entity that revoked the signature.
" } }, "signedObject": { "target": "com.amazonaws.signer#SignedObject", "traits": { "smithy.api#documentation": "Name of the S3 bucket where the signed code image is saved by AWS Signer.
" } }, "jobOwner": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the job owner.
" } }, "jobInvoker": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "The IAM entity that initiated the signing job.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#Destination": { "type": "structure", "members": { "s3": { "target": "com.amazonaws.signer#S3Destination", "traits": { "smithy.api#documentation": "The S3Destination object.
Points to an S3Destination object that contains information about your S3\n\t\t\tbucket.
The set of accepted encryption algorithms that are allowed in a code-signing job.
", "smithy.api#required": {} } }, "defaultValue": { "target": "com.amazonaws.signer#EncryptionAlgorithm", "traits": { "smithy.api#documentation": "The default encryption algorithm that is used by a code-signing job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The encryption algorithm options that are available to a code-signing job.
" } }, "com.amazonaws.signer#EncryptionAlgorithms": { "type": "list", "member": { "target": "com.amazonaws.signer#EncryptionAlgorithm" } }, "com.amazonaws.signer#ErrorCode": { "type": "string" }, "com.amazonaws.signer#ErrorMessage": { "type": "string" }, "com.amazonaws.signer#GetRevocationStatus": { "type": "operation", "input": { "target": "com.amazonaws.signer#GetRevocationStatusRequest" }, "output": { "target": "com.amazonaws.signer#GetRevocationStatusResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" }, { "target": "com.amazonaws.signer#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the revocation status of one or more of the signing profile, signing job,\n\t\t\tand signing certificate.
", "smithy.api#endpoint": { "hostPrefix": "data-" }, "smithy.api#http": { "method": "GET", "uri": "/revocations", "code": 200 } } }, "com.amazonaws.signer#GetRevocationStatusRequest": { "type": "structure", "members": { "signatureTimestamp": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of the signature that validates the profile or job.
", "smithy.api#httpQuery": "signatureTimestamp", "smithy.api#required": {} } }, "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { "smithy.api#documentation": "The ID of a signing platform.
", "smithy.api#httpQuery": "platformId", "smithy.api#required": {} } }, "profileVersionArn": { "target": "com.amazonaws.signer#Arn", "traits": { "smithy.api#documentation": "The version of a signing profile.
", "smithy.api#httpQuery": "profileVersionArn", "smithy.api#required": {} } }, "jobArn": { "target": "com.amazonaws.signer#Arn", "traits": { "smithy.api#documentation": "The ARN of a signing job.
", "smithy.api#httpQuery": "jobArn", "smithy.api#required": {} } }, "certificateHashes": { "target": "com.amazonaws.signer#CertificateHashes", "traits": { "smithy.api#documentation": "A list of composite signed hashes that identify certificates.
\nA certificate identifier consists of a subject certificate TBS hash (signed by the\n\t\t\tparent CA) combined with a parent CA TBS hash (signed by the parent CA\u2019s CA). Root\n\t\t\tcertificates are defined as their own CA.
\nThe following example shows how to calculate a hash for this parameter using OpenSSL\n\t\t\tcommands:
\n\n openssl asn1parse -in childCert.pem -strparse 4 -out childCert.tbs\n
\n openssl sha384 < childCert.tbs -binary > childCertTbsHash\n
\n openssl asn1parse -in parentCert.pem -strparse 4 -out parentCert.tbs\n
\n openssl sha384 < parentCert.tbs -binary > parentCertTbsHash xxd -p\n\t\t\t\tchildCertTbsHash > certificateHash.hex xxd -p parentCertTbsHash >>\n\t\t\t\tcertificateHash.hex\n
\n cat certificateHash.hex | tr -d '\\n'\n
A list of revoked entities (including zero or more of the signing profile ARN, signing job\n\t\t\tARN, and certificate hashes) supplied as input to the API.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#GetSigningPlatform": { "type": "operation", "input": { "target": "com.amazonaws.signer#GetSigningPlatformRequest" }, "output": { "target": "com.amazonaws.signer#GetSigningPlatformResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns information on a specific signing platform.
", "smithy.api#http": { "method": "GET", "uri": "/signing-platforms/{platformId}", "code": 200 } } }, "com.amazonaws.signer#GetSigningPlatformRequest": { "type": "structure", "members": { "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { "smithy.api#documentation": "The ID of the target signing platform.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#GetSigningPlatformResponse": { "type": "structure", "members": { "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { "smithy.api#documentation": "The ID of the target signing platform.
" } }, "displayName": { "target": "com.amazonaws.signer#DisplayName", "traits": { "smithy.api#documentation": "The display name of the target signing platform.
" } }, "partner": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "A list of partner entities that use the target signing platform.
" } }, "target": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The validation template that is used by the target signing platform.
" } }, "category": { "target": "com.amazonaws.signer#Category", "traits": { "smithy.api#documentation": "The category type of the target signing platform.
" } }, "signingConfiguration": { "target": "com.amazonaws.signer#SigningConfiguration", "traits": { "smithy.api#documentation": "A list of configurations applied to the target platform at signing.
" } }, "signingImageFormat": { "target": "com.amazonaws.signer#SigningImageFormat", "traits": { "smithy.api#documentation": "The format of the target platform's signing image.
" } }, "maxSizeInMB": { "target": "com.amazonaws.signer#MaxSizeInMB", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum size (in MB) of the payload that can be signed by the target\n\t\t\tplatform.
" } }, "revocationSupported": { "target": "com.amazonaws.signer#bool", "traits": { "smithy.api#default": false, "smithy.api#documentation": "A flag indicating whether signatures generated for the signing platform can be\n\t\t\trevoked.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#GetSigningProfile": { "type": "operation", "input": { "target": "com.amazonaws.signer#GetSigningProfileRequest" }, "output": { "target": "com.amazonaws.signer#GetSigningProfileResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns information on a specific signing profile.
", "smithy.api#http": { "method": "GET", "uri": "/signing-profiles/{profileName}", "code": 200 } } }, "com.amazonaws.signer#GetSigningProfileRequest": { "type": "structure", "members": { "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "The name of the target signing profile.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "profileOwner": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the profile owner.
", "smithy.api#httpQuery": "profileOwner" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#GetSigningProfileResponse": { "type": "structure", "members": { "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "The name of the target signing profile.
" } }, "profileVersion": { "target": "com.amazonaws.signer#ProfileVersion", "traits": { "smithy.api#documentation": "The current version of the signing profile.
" } }, "profileVersionArn": { "target": "com.amazonaws.signer#Arn", "traits": { "smithy.api#documentation": "The signing profile ARN, including the profile version.
" } }, "revocationRecord": { "target": "com.amazonaws.signer#SigningProfileRevocationRecord" }, "signingMaterial": { "target": "com.amazonaws.signer#SigningMaterial", "traits": { "smithy.api#documentation": "The ARN of the certificate that the target profile uses for signing operations.
" } }, "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { "smithy.api#documentation": "The ID of the platform that is used by the target signing profile.
" } }, "platformDisplayName": { "target": "com.amazonaws.signer#DisplayName", "traits": { "smithy.api#documentation": "A human-readable name for the signing platform associated with the signing\n\t\t\tprofile.
" } }, "signatureValidityPeriod": { "target": "com.amazonaws.signer#SignatureValidityPeriod" }, "overrides": { "target": "com.amazonaws.signer#SigningPlatformOverrides", "traits": { "smithy.api#documentation": "A list of overrides applied by the target signing profile for signing\n\t\t\toperations.
" } }, "signingParameters": { "target": "com.amazonaws.signer#SigningParameters", "traits": { "smithy.api#documentation": "A map of key-value pairs for signing operations that is attached to the target signing\n\t\t\tprofile.
" } }, "status": { "target": "com.amazonaws.signer#SigningProfileStatus", "traits": { "smithy.api#documentation": "The status of the target signing profile.
" } }, "statusReason": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "Reason for the status of the target signing profile.
" } }, "arn": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the signing profile.
" } }, "tags": { "target": "com.amazonaws.signer#TagMap", "traits": { "smithy.api#documentation": "A list of tags associated with the signing profile.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#HashAlgorithm": { "type": "enum", "members": { "SHA1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA1" } }, "SHA256": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHA256" } } } }, "com.amazonaws.signer#HashAlgorithmOptions": { "type": "structure", "members": { "allowedValues": { "target": "com.amazonaws.signer#HashAlgorithms", "traits": { "smithy.api#documentation": "The set of accepted hash algorithms allowed in a code-signing job.
", "smithy.api#required": {} } }, "defaultValue": { "target": "com.amazonaws.signer#HashAlgorithm", "traits": { "smithy.api#documentation": "The default hash algorithm that is used in a code-signing job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The hash algorithms that are available to a code-signing job.
" } }, "com.amazonaws.signer#HashAlgorithms": { "type": "list", "member": { "target": "com.amazonaws.signer#HashAlgorithm" } }, "com.amazonaws.signer#ImageFormat": { "type": "enum", "members": { "JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSON" } }, "JSONEmbedded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSONEmbedded" } }, "JSONDetached": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSONDetached" } } } }, "com.amazonaws.signer#ImageFormats": { "type": "list", "member": { "target": "com.amazonaws.signer#ImageFormat" } }, "com.amazonaws.signer#Integer": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.signer#InternalServiceErrorException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.signer#ErrorMessage" }, "code": { "target": "com.amazonaws.signer#ErrorCode" } }, "traits": { "smithy.api#documentation": "An internal error occurred.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.signer#JobId": { "type": "string" }, "com.amazonaws.signer#Key": { "type": "string" }, "com.amazonaws.signer#ListProfilePermissions": { "type": "operation", "input": { "target": "com.amazonaws.signer#ListProfilePermissionsRequest" }, "output": { "target": "com.amazonaws.signer#ListProfilePermissionsResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" }, { "target": "com.amazonaws.signer#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the cross-account permissions associated with a signing profile.
", "smithy.api#http": { "method": "GET", "uri": "/signing-profiles/{profileName}/permissions", "code": 200 } } }, "com.amazonaws.signer#ListProfilePermissionsRequest": { "type": "structure", "members": { "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "Name of the signing profile containing the cross-account permissions.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "String for specifying the next set of paginated results.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#ListProfilePermissionsResponse": { "type": "structure", "members": { "revisionId": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The identifier for the current revision of profile permissions.
" } }, "policySizeBytes": { "target": "com.amazonaws.signer#PolicySizeBytes", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "Total size of the policy associated with the Signing Profile in bytes.
" } }, "permissions": { "target": "com.amazonaws.signer#Permissions", "traits": { "smithy.api#documentation": "List of permissions associated with the Signing Profile.
" } }, "nextToken": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "String for specifying the next set of paginated results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#ListSigningJobs": { "type": "operation", "input": { "target": "com.amazonaws.signer#ListSigningJobsRequest" }, "output": { "target": "com.amazonaws.signer#ListSigningJobsResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" }, { "target": "com.amazonaws.signer#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all your signing jobs. You can use the maxResults parameter to limit the\n\t\t\tnumber of signing jobs that are returned in the response. If additional jobs remain to\n\t\t\tbe listed, AWS Signer returns a nextToken value. Use this value in\n\t\t\tsubsequent calls to ListSigningJobs to fetch the remaining values. You can\n\t\t\tcontinue calling ListSigningJobs with your maxResults\n\t\t\tparameter and with new values that Signer returns in the nextToken\n\t\t\tparameter until all of your signing jobs have been returned.
A status value with which to filter your results.
", "smithy.api#httpQuery": "status" } }, "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { "smithy.api#documentation": "The ID of microcontroller platform that you specified for the distribution of your\n\t\t\tcode image.
", "smithy.api#httpQuery": "platformId" } }, "requestedBy": { "target": "com.amazonaws.signer#RequestedBy", "traits": { "smithy.api#documentation": "The IAM principal that requested the signing job.
", "smithy.api#httpQuery": "requestedBy" } }, "maxResults": { "target": "com.amazonaws.signer#MaxResults", "traits": { "smithy.api#documentation": "Specifies the maximum number of items to return in the response. Use this parameter\n\t\t\twhen paginating results. If additional items exist beyond the number you specify, the\n\t\t\t\tnextToken element is set in the response. Use the\n\t\t\t\tnextToken value in a subsequent request to retrieve additional items.\n\t\t
String for specifying the next set of paginated results to return. After you receive a\n\t\t\tresponse with truncated results, use this parameter in a subsequent request. Set it to\n\t\t\tthe value of nextToken from the response that you just received.
Filters results to return only signing jobs with revoked signatures.
", "smithy.api#httpQuery": "isRevoked" } }, "signatureExpiresBefore": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "Filters results to return only signing jobs with signatures expiring before a\n\t\t\tspecified timestamp.
", "smithy.api#httpQuery": "signatureExpiresBefore" } }, "signatureExpiresAfter": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "Filters results to return only signing jobs with signatures expiring after a specified\n\t\t\ttimestamp.
", "smithy.api#httpQuery": "signatureExpiresAfter" } }, "jobInvoker": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "Filters results to return only signing jobs initiated by a specified IAM\n\t\t\tentity.
", "smithy.api#httpQuery": "jobInvoker" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#ListSigningJobsResponse": { "type": "structure", "members": { "jobs": { "target": "com.amazonaws.signer#SigningJobs", "traits": { "smithy.api#documentation": "A list of your signing jobs.
" } }, "nextToken": { "target": "com.amazonaws.signer#NextToken", "traits": { "smithy.api#documentation": "String for specifying the next set of paginated results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#ListSigningPlatforms": { "type": "operation", "input": { "target": "com.amazonaws.signer#ListSigningPlatformsRequest" }, "output": { "target": "com.amazonaws.signer#ListSigningPlatformsResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" }, { "target": "com.amazonaws.signer#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all signing platforms available in AWS Signer that match the request parameters. If\n\t\t\tadditional jobs remain to be listed, Signer returns a nextToken value.\n\t\t\tUse this value in subsequent calls to ListSigningJobs to fetch the\n\t\t\tremaining values. You can continue calling ListSigningJobs with your\n\t\t\t\tmaxResults parameter and with new values that Signer returns in the\n\t\t\t\tnextToken parameter until all of your signing jobs have been\n\t\t\treturned.
The category type of a signing platform.
", "smithy.api#httpQuery": "category" } }, "partner": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "Any partner entities connected to a signing platform.
", "smithy.api#httpQuery": "partner" } }, "target": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The validation template that is used by the target signing platform.
", "smithy.api#httpQuery": "target" } }, "maxResults": { "target": "com.amazonaws.signer#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be returned by this operation.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "Value for specifying the next set of paginated results to return. After you receive a\n\t\t\tresponse with truncated results, use this parameter in a subsequent request. Set it to\n\t\t\tthe value of nextToken from the response that you just received.
A list of all platforms that match the request parameters.
" } }, "nextToken": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "Value for specifying the next set of paginated results to return.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#ListSigningProfiles": { "type": "operation", "input": { "target": "com.amazonaws.signer#ListSigningProfilesRequest" }, "output": { "target": "com.amazonaws.signer#ListSigningProfilesResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Lists all available signing profiles in your AWS account. Returns only profiles with an\n\t\t\t\tACTIVE status unless the includeCanceled request field is\n\t\t\tset to true. If additional jobs remain to be listed, AWS Signer returns a\n\t\t\t\tnextToken value. Use this value in subsequent calls to\n\t\t\t\tListSigningJobs to fetch the remaining values. You can continue calling\n\t\t\t\tListSigningJobs with your maxResults parameter and with\n\t\t\tnew values that Signer returns in the nextToken parameter until all of\n\t\t\tyour signing jobs have been returned.
Designates whether to include profiles with the status of\n\t\t\tCANCELED.
The maximum number of profiles to be returned.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.signer#NextToken", "traits": { "smithy.api#documentation": "Value for specifying the next set of paginated results to return. After you receive a\n\t\t\tresponse with truncated results, use this parameter in a subsequent request. Set it to\n\t\t\tthe value of nextToken from the response that you just received.
Filters results to return only signing jobs initiated for a specified signing\n\t\t\tplatform.
", "smithy.api#httpQuery": "platformId" } }, "statuses": { "target": "com.amazonaws.signer#Statuses", "traits": { "smithy.api#documentation": "Filters results to return only signing jobs with statuses in the specified\n\t\t\tlist.
", "smithy.api#httpQuery": "statuses" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#ListSigningProfilesResponse": { "type": "structure", "members": { "profiles": { "target": "com.amazonaws.signer#SigningProfiles", "traits": { "smithy.api#documentation": "A list of profiles that are available in the AWS account. This includes profiles with\n\t\t\tthe status of CANCELED if the includeCanceled parameter is set\n\t\t\tto true.
Value for specifying the next set of paginated results to return.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.signer#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.signer#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.signer#BadRequestException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#NotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Returns a list of the tags associated with a signing profile resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.signer#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the signing profile.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.signer#TagMap", "traits": { "smithy.api#documentation": "A list of tags associated with the signing profile.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 25 } } }, "com.amazonaws.signer#MaxSizeInMB": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.signer#Metadata": { "type": "map", "key": { "target": "com.amazonaws.signer#String" }, "value": { "target": "com.amazonaws.signer#String" } }, "com.amazonaws.signer#NextToken": { "type": "string" }, "com.amazonaws.signer#NotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.signer#ErrorMessage" }, "code": { "target": "com.amazonaws.signer#ErrorCode" } }, "traits": { "smithy.api#documentation": "The signing profile was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.signer#Payload": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "com.amazonaws.signer#Permission": { "type": "structure", "members": { "action": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "An AWS Signer action permitted as part of cross-account permissions.
" } }, "principal": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The AWS principal that has been granted a cross-account permission.
" } }, "statementId": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "A unique identifier for a cross-account permission statement.
" } }, "profileVersion": { "target": "com.amazonaws.signer#ProfileVersion", "traits": { "smithy.api#documentation": "The signing profile version that a permission applies to.
" } } }, "traits": { "smithy.api#documentation": "A cross-account permission for a signing profile.
" } }, "com.amazonaws.signer#Permissions": { "type": "list", "member": { "target": "com.amazonaws.signer#Permission" } }, "com.amazonaws.signer#PlatformId": { "type": "string" }, "com.amazonaws.signer#PolicySizeBytes": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.signer#Prefix": { "type": "string" }, "com.amazonaws.signer#ProfileName": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9_]{2,}$" } }, "com.amazonaws.signer#ProfileVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 10 }, "smithy.api#pattern": "^[a-zA-Z0-9]{10}$" } }, "com.amazonaws.signer#PutSigningProfile": { "type": "operation", "input": { "target": "com.amazonaws.signer#PutSigningProfileRequest" }, "output": { "target": "com.amazonaws.signer#PutSigningProfileResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" }, { "target": "com.amazonaws.signer#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a signing profile. A signing profile is a code-signing template that can be used to\n\t\t\tcarry out a pre-defined signing job.\n\t\t\t
", "smithy.api#http": { "method": "PUT", "uri": "/signing-profiles/{profileName}", "code": 200 } } }, "com.amazonaws.signer#PutSigningProfileRequest": { "type": "structure", "members": { "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "The name of the signing profile to be created.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "signingMaterial": { "target": "com.amazonaws.signer#SigningMaterial", "traits": { "smithy.api#documentation": "The AWS Certificate Manager certificate that will be used to sign code with the new signing\n\t\t\tprofile.
" } }, "signatureValidityPeriod": { "target": "com.amazonaws.signer#SignatureValidityPeriod", "traits": { "smithy.api#documentation": "The default validity period override for any signature generated using this signing\n\t\t\tprofile. If unspecified, the default is 135 months.
" } }, "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { "smithy.api#documentation": "The ID of the signing platform to be created.
", "smithy.api#required": {} } }, "overrides": { "target": "com.amazonaws.signer#SigningPlatformOverrides", "traits": { "smithy.api#documentation": "A subfield of platform. This specifies any different configuration\n\t\t\toptions that you want to apply to the chosen platform (such as a different\n\t\t\t\thash-algorithm or signing-algorithm).
Map of key-value pairs for signing. These can include any information that you want to\n\t\t\tuse during signing.
" } }, "tags": { "target": "com.amazonaws.signer#TagMap", "traits": { "smithy.api#documentation": "Tags to be associated with the signing profile that is being created.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#PutSigningProfileResponse": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the signing profile created.
" } }, "profileVersion": { "target": "com.amazonaws.signer#ProfileVersion", "traits": { "smithy.api#documentation": "The version of the signing profile being created.
" } }, "profileVersionArn": { "target": "com.amazonaws.signer#Arn", "traits": { "smithy.api#documentation": "The signing profile ARN, including the profile version.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#RemoveProfilePermission": { "type": "operation", "input": { "target": "com.amazonaws.signer#RemoveProfilePermissionRequest" }, "output": { "target": "com.amazonaws.signer#RemoveProfilePermissionResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#ConflictException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" }, { "target": "com.amazonaws.signer#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes cross-account permissions from a signing profile.
", "smithy.api#http": { "method": "DELETE", "uri": "/signing-profiles/{profileName}/permissions/{statementId}", "code": 200 } } }, "com.amazonaws.signer#RemoveProfilePermissionRequest": { "type": "structure", "members": { "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "A human-readable name for the signing profile with permissions to be removed.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "revisionId": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "An identifier for the current revision of the signing profile permissions.
", "smithy.api#httpQuery": "revisionId", "smithy.api#required": {} } }, "statementId": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "A unique identifier for the cross-account permissions statement.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#RemoveProfilePermissionResponse": { "type": "structure", "members": { "revisionId": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "An identifier for the current revision of the profile permissions.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#RequestedBy": { "type": "string" }, "com.amazonaws.signer#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.signer#ErrorMessage" }, "code": { "target": "com.amazonaws.signer#ErrorCode" } }, "traits": { "smithy.api#documentation": "A specified resource could not be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.signer#RevocationReasonString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.signer#RevokeSignature": { "type": "operation", "input": { "target": "com.amazonaws.signer#RevokeSignatureRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" }, { "target": "com.amazonaws.signer#ValidationException" } ], "traits": { "smithy.api#documentation": "Changes the state of a signing job to REVOKED. This indicates that the signature is no\n\t\t\tlonger valid.
ID of the signing job to be revoked.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "jobOwner": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "AWS account ID of the job owner.
" } }, "reason": { "target": "com.amazonaws.signer#RevocationReasonString", "traits": { "smithy.api#documentation": "The reason for revoking the signing job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#RevokeSigningProfile": { "type": "operation", "input": { "target": "com.amazonaws.signer#RevokeSigningProfileRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" }, { "target": "com.amazonaws.signer#ValidationException" } ], "traits": { "smithy.api#documentation": "Changes the state of a signing profile to REVOKED. This indicates that signatures\n\t\t\tgenerated using the signing profile after an effective start date are no longer\n\t\t\tvalid. A revoked profile is still viewable with the ListSigningProfiles\n\t\t\t\toperation, but it cannot perform new signing jobs. See Data Retention\n\t\t\t\t\tfor more information on scheduled deletion of a revoked signing profile.
The name of the signing profile to be revoked.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "profileVersion": { "target": "com.amazonaws.signer#ProfileVersion", "traits": { "smithy.api#documentation": "The version of the signing profile to be revoked.
", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.signer#RevocationReasonString", "traits": { "smithy.api#documentation": "The reason for revoking a signing profile.
", "smithy.api#required": {} } }, "effectiveTime": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "A timestamp for when revocation of a Signing Profile should become effective.\n\t\t\tSignatures generated using the signing profile after this timestamp are not\n\t\t\ttrusted.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#RevokedEntities": { "type": "list", "member": { "target": "com.amazonaws.signer#String" } }, "com.amazonaws.signer#S3Destination": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.signer#BucketName", "traits": { "smithy.api#documentation": "Name of the S3 bucket.
" } }, "prefix": { "target": "com.amazonaws.signer#Prefix", "traits": { "smithy.api#documentation": "An S3 prefix that you can use to limit responses to those that begin with the specified\n\t\t\tprefix.
" } } }, "traits": { "smithy.api#documentation": "The name and prefix of the Amazon S3 bucket where AWS Signer saves your signed objects.
" } }, "com.amazonaws.signer#S3SignedObject": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.signer#BucketName", "traits": { "smithy.api#documentation": "Name of the S3 bucket.
" } }, "key": { "target": "com.amazonaws.signer#Key", "traits": { "smithy.api#documentation": "Key name that uniquely identifies a signed code image in your bucket.
" } } }, "traits": { "smithy.api#documentation": "The Amazon S3 bucket name and key where Signer saved your signed code image.
" } }, "com.amazonaws.signer#S3Source": { "type": "structure", "members": { "bucketName": { "target": "com.amazonaws.signer#BucketName", "traits": { "smithy.api#documentation": "Name of the S3 bucket.
", "smithy.api#required": {} } }, "key": { "target": "com.amazonaws.signer#Key", "traits": { "smithy.api#documentation": "Key name of the bucket object that contains your unsigned code.
", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.signer#Version", "traits": { "smithy.api#documentation": "Version of your source image in your version enabled S3 bucket.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about the Amazon S3 bucket where you saved your unsigned code.
" } }, "com.amazonaws.signer#ServiceLimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.signer#ErrorMessage" }, "code": { "target": "com.amazonaws.signer#ErrorCode" } }, "traits": { "smithy.api#documentation": "The client is making a request that exceeds service limits.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.signer#SignPayload": { "type": "operation", "input": { "target": "com.amazonaws.signer#SignPayloadRequest" }, "output": { "target": "com.amazonaws.signer#SignPayloadResponse" }, "errors": [ { "target": "com.amazonaws.signer#AccessDeniedException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#ResourceNotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" }, { "target": "com.amazonaws.signer#ValidationException" } ], "traits": { "smithy.api#documentation": "Signs a binary payload and returns a signature envelope.
", "smithy.api#http": { "method": "POST", "uri": "/signing-jobs/with-payload", "code": 200 } } }, "com.amazonaws.signer#SignPayloadRequest": { "type": "structure", "members": { "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "The name of the signing profile.
", "smithy.api#required": {} } }, "profileOwner": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the profile owner.
" } }, "payload": { "target": "com.amazonaws.signer#Payload", "traits": { "smithy.api#documentation": "Specifies the object digest (hash) to sign.
", "smithy.api#required": {} } }, "payloadFormat": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "Payload content type. The single valid type is\n\t\t\t\tapplication/vnd.cncf.notary.payload.v1+json.
Unique identifier of the signing job.
" } }, "jobOwner": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the job owner.
" } }, "metadata": { "target": "com.amazonaws.signer#Metadata", "traits": { "smithy.api#documentation": "Information including the signing profile ARN and the signing job ID.
" } }, "signature": { "target": "com.amazonaws.signer#Blob", "traits": { "smithy.api#documentation": "A cryptographic signature.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#SignatureValidityPeriod": { "type": "structure", "members": { "value": { "target": "com.amazonaws.signer#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The numerical value of the time unit for signature validity.
" } }, "type": { "target": "com.amazonaws.signer#ValidityType", "traits": { "smithy.api#documentation": "The time unit for signature validity.
" } } }, "traits": { "smithy.api#documentation": "The validity period for a signing job.
" } }, "com.amazonaws.signer#SignedObject": { "type": "structure", "members": { "s3": { "target": "com.amazonaws.signer#S3SignedObject", "traits": { "smithy.api#documentation": "The S3SignedObject.
Points to an S3SignedObject object that contains information about your\n\t\t\tsigned code image.
The encryption algorithm options that are available for a code-signing job.
", "smithy.api#required": {} } }, "hashAlgorithmOptions": { "target": "com.amazonaws.signer#HashAlgorithmOptions", "traits": { "smithy.api#documentation": "The hash algorithm options that are available for a code-signing job.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The configuration of a signing operation.
" } }, "com.amazonaws.signer#SigningConfigurationOverrides": { "type": "structure", "members": { "encryptionAlgorithm": { "target": "com.amazonaws.signer#EncryptionAlgorithm", "traits": { "smithy.api#documentation": "A specified override of the default encryption algorithm that is used in a code-signing\n\t\t\tjob.
" } }, "hashAlgorithm": { "target": "com.amazonaws.signer#HashAlgorithm", "traits": { "smithy.api#documentation": "A specified override of the default hash algorithm that is used in a code-signing\n\t\t\tjob.
" } } }, "traits": { "smithy.api#documentation": "A signing configuration that overrides the default encryption or hash algorithm of a\n\t\t\tsigning job.
" } }, "com.amazonaws.signer#SigningImageFormat": { "type": "structure", "members": { "supportedFormats": { "target": "com.amazonaws.signer#ImageFormats", "traits": { "smithy.api#documentation": "The supported formats of a signing image.
", "smithy.api#required": {} } }, "defaultFormat": { "target": "com.amazonaws.signer#ImageFormat", "traits": { "smithy.api#documentation": "The default format of a signing image.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The image format of a AWS Signer platform or profile.
" } }, "com.amazonaws.signer#SigningJob": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.signer#JobId", "traits": { "smithy.api#documentation": "The ID of the signing job.
" } }, "source": { "target": "com.amazonaws.signer#Source", "traits": { "smithy.api#documentation": "A Source that contains information about a signing job's code image\n\t\t\tsource.
A SignedObject structure that contains information about a signing job's\n\t\t\tsigned code image.
A SigningMaterial object that contains the Amazon Resource Name (ARN) of\n\t\t\tthe certificate used for the signing job.
The date and time that the signing job was created.
" } }, "status": { "target": "com.amazonaws.signer#SigningStatus", "traits": { "smithy.api#documentation": "The status of the signing job.
" } }, "isRevoked": { "target": "com.amazonaws.signer#bool", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Indicates whether the signing job is revoked.
" } }, "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "The name of the signing profile that created a signing job.
" } }, "profileVersion": { "target": "com.amazonaws.signer#ProfileVersion", "traits": { "smithy.api#documentation": "The version of the signing profile that created a signing job.
" } }, "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { "smithy.api#documentation": "The unique identifier for a signing platform.
" } }, "platformDisplayName": { "target": "com.amazonaws.signer#DisplayName", "traits": { "smithy.api#documentation": "The name of a signing platform.
" } }, "signatureExpiresAt": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "The time when the signature of a signing job expires.
" } }, "jobOwner": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the job owner.
" } }, "jobInvoker": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the job invoker.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a signing job.
" } }, "com.amazonaws.signer#SigningJobRevocationRecord": { "type": "structure", "members": { "reason": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "A caller-supplied reason for revocation.
" } }, "revokedAt": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "The time of revocation.
" } }, "revokedBy": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The identity of the revoker.
" } } }, "traits": { "smithy.api#documentation": "Revocation information for a signing job.
" } }, "com.amazonaws.signer#SigningJobs": { "type": "list", "member": { "target": "com.amazonaws.signer#SigningJob" } }, "com.amazonaws.signer#SigningMaterial": { "type": "structure", "members": { "certificateArn": { "target": "com.amazonaws.signer#CertificateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the certificates that is used to sign your\n\t\t\tcode.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The ACM certificate that is used to sign your code.
" } }, "com.amazonaws.signer#SigningParameterKey": { "type": "string" }, "com.amazonaws.signer#SigningParameterValue": { "type": "string" }, "com.amazonaws.signer#SigningParameters": { "type": "map", "key": { "target": "com.amazonaws.signer#SigningParameterKey" }, "value": { "target": "com.amazonaws.signer#SigningParameterValue" } }, "com.amazonaws.signer#SigningPlatform": { "type": "structure", "members": { "platformId": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The ID of a signing platform.
" } }, "displayName": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The display name of a signing platform.
" } }, "partner": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "Any partner entities linked to a signing platform.
" } }, "target": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The types of targets that can be signed by a signing platform.
" } }, "category": { "target": "com.amazonaws.signer#Category", "traits": { "smithy.api#documentation": "The category of a signing platform.
" } }, "signingConfiguration": { "target": "com.amazonaws.signer#SigningConfiguration", "traits": { "smithy.api#documentation": "The configuration of a signing platform. This includes the designated hash algorithm and\n\t\t\tencryption algorithm of a signing platform.
" } }, "signingImageFormat": { "target": "com.amazonaws.signer#SigningImageFormat" }, "maxSizeInMB": { "target": "com.amazonaws.signer#MaxSizeInMB", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum size (in MB) of code that can be signed by a signing platform.
" } }, "revocationSupported": { "target": "com.amazonaws.signer#bool", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Indicates whether revocation is supported for the platform.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the signing configurations and parameters that are used to\n\t\t\tperform a code-signing job.
" } }, "com.amazonaws.signer#SigningPlatformOverrides": { "type": "structure", "members": { "signingConfiguration": { "target": "com.amazonaws.signer#SigningConfigurationOverrides", "traits": { "smithy.api#documentation": "A signing configuration that overrides the default encryption or hash algorithm of a\n\t\t\tsigning job.
" } }, "signingImageFormat": { "target": "com.amazonaws.signer#ImageFormat", "traits": { "smithy.api#documentation": "A signed image is a JSON object. When overriding the default signing platform\n\t\t\tconfiguration, a customer can select either of two signing formats,\n\t\t\t\tJSONEmbedded or JSONDetached. (A third format value,\n\t\t\t\tJSON, is reserved for future use.) With JSONEmbedded, the\n\t\t\tsigning image has the payload embedded in it. With JSONDetached, the\n\t\t\tpayload is not be embedded in the signing image.
Any overrides that are applied to the signing configuration of a signing platform.
" } }, "com.amazonaws.signer#SigningPlatforms": { "type": "list", "member": { "target": "com.amazonaws.signer#SigningPlatform" } }, "com.amazonaws.signer#SigningProfile": { "type": "structure", "members": { "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "The name of the signing profile.
" } }, "profileVersion": { "target": "com.amazonaws.signer#ProfileVersion", "traits": { "smithy.api#documentation": "The version of a signing profile.
" } }, "profileVersionArn": { "target": "com.amazonaws.signer#Arn", "traits": { "smithy.api#documentation": "The ARN of a signing profile, including the profile version.
" } }, "signingMaterial": { "target": "com.amazonaws.signer#SigningMaterial", "traits": { "smithy.api#documentation": "The ACM certificate that is available for use by a signing profile.
" } }, "signatureValidityPeriod": { "target": "com.amazonaws.signer#SignatureValidityPeriod", "traits": { "smithy.api#documentation": "The validity period for a signing job created using this signing profile.
" } }, "platformId": { "target": "com.amazonaws.signer#PlatformId", "traits": { "smithy.api#documentation": "The ID of a platform that is available for use by a signing profile.
" } }, "platformDisplayName": { "target": "com.amazonaws.signer#DisplayName", "traits": { "smithy.api#documentation": "The name of the signing platform.
" } }, "signingParameters": { "target": "com.amazonaws.signer#SigningParameters", "traits": { "smithy.api#documentation": "The parameters that are available for use by a Signer user.
" } }, "status": { "target": "com.amazonaws.signer#SigningProfileStatus", "traits": { "smithy.api#documentation": "The status of a signing profile.
" } }, "arn": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the signing profile.
" } }, "tags": { "target": "com.amazonaws.signer#TagMap", "traits": { "smithy.api#documentation": "A list of tags associated with the signing profile.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the ACM certificates and signing configuration parameters that\n\t\t\tcan be used by a given code signing user.
" } }, "com.amazonaws.signer#SigningProfileRevocationRecord": { "type": "structure", "members": { "revocationEffectiveFrom": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "The time when revocation becomes effective.
" } }, "revokedAt": { "target": "com.amazonaws.signer#Timestamp", "traits": { "smithy.api#documentation": "The time when the signing profile was revoked.
" } }, "revokedBy": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The identity of the revoker.
" } } }, "traits": { "smithy.api#documentation": "Revocation information for a signing profile.
" } }, "com.amazonaws.signer#SigningProfileStatus": { "type": "enum", "members": { "Active": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Active" } }, "Canceled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Canceled" } }, "Revoked": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Revoked" } } } }, "com.amazonaws.signer#SigningProfiles": { "type": "list", "member": { "target": "com.amazonaws.signer#SigningProfile" } }, "com.amazonaws.signer#SigningStatus": { "type": "enum", "members": { "InProgress": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InProgress" } }, "Failed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Failed" } }, "Succeeded": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Succeeded" } } } }, "com.amazonaws.signer#Source": { "type": "structure", "members": { "s3": { "target": "com.amazonaws.signer#S3Source", "traits": { "smithy.api#documentation": "The S3Source object.
An S3Source object that contains information about the S3 bucket where\n\t\t\tyou saved your unsigned code.
Initiates a signing job to be performed on the code provided. Signing jobs are\n\t\t\tviewable by the ListSigningJobs operation. Note the following requirements:
You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the\n\t\t\t\t\t\tAmazon S3 Getting Started Guide.
\nYour S3 source bucket must be version enabled.
\nYou must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to\n\t\t\t\t\twrite your signed code.
\nYou specify the name of the source and destination buckets when calling the\n\t\t\t\t\t\tStartSigningJob operation.
You must ensure the S3 buckets are from the same Region as the signing profile. Cross-Region signing isn't supported.
\nYou must also specify a request token that identifies your request to Signer.
\nYou can call the DescribeSigningJob and the ListSigningJobs actions after you call\n\t\t\tStartSigningJob.
For a Java example that shows how to use this action, see StartSigningJob.
", "smithy.api#http": { "method": "POST", "uri": "/signing-jobs", "code": 200 } } }, "com.amazonaws.signer#StartSigningJobRequest": { "type": "structure", "members": { "source": { "target": "com.amazonaws.signer#Source", "traits": { "smithy.api#documentation": "The S3 bucket that contains the object to sign or a BLOB that contains your raw\n\t\t\tcode.
", "smithy.api#required": {} } }, "destination": { "target": "com.amazonaws.signer#Destination", "traits": { "smithy.api#documentation": "The S3 bucket in which to save your signed object. The destination contains the name\n\t\t\tof your bucket and an optional prefix.
", "smithy.api#required": {} } }, "profileName": { "target": "com.amazonaws.signer#ProfileName", "traits": { "smithy.api#documentation": "The name of the signing profile.
", "smithy.api#required": {} } }, "clientRequestToken": { "target": "com.amazonaws.signer#ClientRequestToken", "traits": { "smithy.api#documentation": "String that identifies the signing request. All calls after the first that use this\n\t\t\ttoken return the same response as the first call.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "profileOwner": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the signing profile owner.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#StartSigningJobResponse": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.signer#JobId", "traits": { "smithy.api#documentation": "The ID of your signing job.
" } }, "jobOwner": { "target": "com.amazonaws.signer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the signing job owner.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#StatusReason": { "type": "string" }, "com.amazonaws.signer#Statuses": { "type": "list", "member": { "target": "com.amazonaws.signer#SigningProfileStatus" } }, "com.amazonaws.signer#String": { "type": "string" }, "com.amazonaws.signer#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.signer#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.signer#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.signer#TagMap": { "type": "map", "key": { "target": "com.amazonaws.signer#TagKey" }, "value": { "target": "com.amazonaws.signer#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.signer#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.signer#TagResourceRequest" }, "output": { "target": "com.amazonaws.signer#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.signer#BadRequestException" }, { "target": "com.amazonaws.signer#InternalServiceErrorException" }, { "target": "com.amazonaws.signer#NotFoundException" }, { "target": "com.amazonaws.signer#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "Adds one or more tags to a signing profile. Tags are labels that you can use to\n\t\t\tidentify and organize your AWS resources. Each tag consists of a key and an optional\n\t\t\tvalue. To specify the signing profile, use its Amazon Resource Name (ARN). To specify\n\t\t\tthe tag, use a key-value pair.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.signer#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the signing profile.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.signer#TagMap", "traits": { "smithy.api#documentation": "One or more tags to be associated with the signing profile.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.signer#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.signer#ErrorMessage" }, "code": { "target": "com.amazonaws.signer#ErrorCode" } }, "traits": { "smithy.api#deprecated": { "message": "Instead of this error, TooManyRequestsException should be used." }, "smithy.api#documentation": "The request was denied due to request throttling.
\nInstead of this error, TooManyRequestsException should be used.
The allowed number of job-signing requests has been exceeded.
\nThis error supersedes the error ThrottlingException.
Removes one or more tags from a signing profile. To remove the tags, specify a list of\n\t\t\ttag keys.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.signer#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.signer#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the signing profile.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.signer#TagKeyList", "traits": { "smithy.api#documentation": "A list of tag keys to be removed from the signing profile.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.signer#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.signer#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.signer#ErrorMessage" }, "code": { "target": "com.amazonaws.signer#ErrorCode" } }, "traits": { "smithy.api#documentation": "You signing certificate could not be validated.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.signer#ValidityType": { "type": "enum", "members": { "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAYS" } }, "MONTHS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MONTHS" } }, "YEARS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "YEARS" } } } }, "com.amazonaws.signer#Version": { "type": "string" }, "com.amazonaws.signer#WallabyService": { "type": "service", "version": "2017-08-25", "operations": [ { "target": "com.amazonaws.signer#AddProfilePermission" }, { "target": "com.amazonaws.signer#CancelSigningProfile" }, { "target": "com.amazonaws.signer#DescribeSigningJob" }, { "target": "com.amazonaws.signer#GetRevocationStatus" }, { "target": "com.amazonaws.signer#GetSigningPlatform" }, { "target": "com.amazonaws.signer#GetSigningProfile" }, { "target": "com.amazonaws.signer#ListProfilePermissions" }, { "target": "com.amazonaws.signer#ListSigningJobs" }, { "target": "com.amazonaws.signer#ListSigningPlatforms" }, { "target": "com.amazonaws.signer#ListSigningProfiles" }, { "target": "com.amazonaws.signer#ListTagsForResource" }, { "target": "com.amazonaws.signer#PutSigningProfile" }, { "target": "com.amazonaws.signer#RemoveProfilePermission" }, { "target": "com.amazonaws.signer#RevokeSignature" }, { "target": "com.amazonaws.signer#RevokeSigningProfile" }, { "target": "com.amazonaws.signer#SignPayload" }, { "target": "com.amazonaws.signer#StartSigningJob" }, { "target": "com.amazonaws.signer#TagResource" }, { "target": "com.amazonaws.signer#UntagResource" } ], "traits": { "aws.api#service": { "sdkId": "signer", "arnNamespace": "signer", "cloudFormationName": "Signer", "cloudTrailEventSource": "signer.amazonaws.com", "endpointPrefix": "signer" }, "aws.auth#sigv4": { "name": "signer" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "AWS Signer is a fully managed code-signing service to help you ensure the trust and\n\t\t\tintegrity of your code.
\nSigner supports the following applications:
\nWith code signing for AWS Lambda, you can sign AWS\n\t\t\t\tLambda deployment packages. Integrated support is provided for Amazon S3, Amazon\n\t\t\t\tCloudWatch, and AWS CloudTrail. In order\n\t\t\tto sign code, you create a signing profile and then use Signer to sign Lambda zip\n\t\t\tfiles in S3.
\nWith code signing for IoT, you can sign code for any IoT device that is supported by AWS.\n\t\t\tIoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code-signing\n\t\t\tcertificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management.
\nWith Signer and the Notation CLI from the Notary\u2028\n\t\t\t\tProject, you can sign container images stored in a container registry such\n\t\t\tas Amazon Elastic Container Registry (ECR). The signatures are stored in the registry\n\t\t\talongside the images, where they are available for verifying image authenticity and\n\t\t\tintegrity.
\nFor more information about Signer, see the AWS Signer Developer\n\t\t\tGuide.
", "smithy.api#title": "AWS Signer", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://signer-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://signer-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://signer.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://signer.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://signer-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://signer-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://signer.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://signer.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://signer-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://signer-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://signer.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://signer.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://signer-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://signer-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://signer.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://signer.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://signer-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://signer-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://signer.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://signer.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://signer-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://signer.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://signer-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://signer.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.signer#bool": { "type": "boolean", "traits": { "smithy.api#default": false } } } }