AddProfilePermission

$result = $client->addProfilePermission([/* ... */]);
$promise = $client->addProfilePermissionAsync([/* ... */]);

Adds cross-account permissions to a signing profile.

Parameter Syntax

$result = $client->addProfilePermission([
    'action' => '<string>', // REQUIRED
    'principal' => '<string>', // REQUIRED
    'profileName' => '<string>', // REQUIRED
    'profileVersion' => '<string>',
    'revisionId' => '<string>',
    'statementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'revisionId' => '<string>',
]

Result Details

Errors

ValidationException:

You signing certificate could not be validated.

ResourceNotFoundException:

A specified resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ServiceLimitExceededException:

The client is making a request that exceeds service limits.

ConflictException:

The resource encountered a conflicting state.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

CancelSigningProfile

$result = $client->cancelSigningProfile([/* ... */]);
$promise = $client->cancelSigningProfileAsync([/* ... */]);

Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

Parameter Syntax

$result = $client->cancelSigningProfile([
    'profileName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

A specified resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

DescribeSigningJob

$result = $client->describeSigningJob([/* ... */]);
$promise = $client->describeSigningJobAsync([/* ... */]);

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

Parameter Syntax

$result = $client->describeSigningJob([
    'jobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'completedAt' => <DateTime>,
    'createdAt' => <DateTime>,
    'jobId' => '<string>',
    'jobInvoker' => '<string>',
    'jobOwner' => '<string>',
    'overrides' => [
        'signingConfiguration' => [
            'encryptionAlgorithm' => 'RSA|ECDSA',
            'hashAlgorithm' => 'SHA1|SHA256',
        ],
        'signingImageFormat' => 'JSON|JSONEmbedded|JSONDetached',
    ],
    'platformDisplayName' => '<string>',
    'platformId' => '<string>',
    'profileName' => '<string>',
    'profileVersion' => '<string>',
    'requestedBy' => '<string>',
    'revocationRecord' => [
        'reason' => '<string>',
        'revokedAt' => <DateTime>,
        'revokedBy' => '<string>',
    ],
    'signatureExpiresAt' => <DateTime>,
    'signedObject' => [
        's3' => [
            'bucketName' => '<string>',
            'key' => '<string>',
        ],
    ],
    'signingMaterial' => [
        'certificateArn' => '<string>',
    ],
    'signingParameters' => ['<string>', ...],
    'source' => [
        's3' => [
            'bucketName' => '<string>',
            'key' => '<string>',
            'version' => '<string>',
        ],
    ],
    'status' => 'InProgress|Failed|Succeeded',
    'statusReason' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

A specified resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

GetRevocationStatus

$result = $client->getRevocationStatus([/* ... */]);
$promise = $client->getRevocationStatusAsync([/* ... */]);

Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.

Parameter Syntax

$result = $client->getRevocationStatus([
    'certificateHashes' => ['<string>', ...], // REQUIRED
    'jobArn' => '<string>', // REQUIRED
    'platformId' => '<string>', // REQUIRED
    'profileVersionArn' => '<string>', // REQUIRED
    'signatureTimestamp' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'revokedEntities' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

You signing certificate could not be validated.

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

GetSigningPlatform

$result = $client->getSigningPlatform([/* ... */]);
$promise = $client->getSigningPlatformAsync([/* ... */]);

Returns information on a specific signing platform.

Parameter Syntax

$result = $client->getSigningPlatform([
    'platformId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'category' => 'AWSIoT',
    'displayName' => '<string>',
    'maxSizeInMB' => <integer>,
    'partner' => '<string>',
    'platformId' => '<string>',
    'revocationSupported' => true || false,
    'signingConfiguration' => [
        'encryptionAlgorithmOptions' => [
            'allowedValues' => ['<string>', ...],
            'defaultValue' => 'RSA|ECDSA',
        ],
        'hashAlgorithmOptions' => [
            'allowedValues' => ['<string>', ...],
            'defaultValue' => 'SHA1|SHA256',
        ],
    ],
    'signingImageFormat' => [
        'defaultFormat' => 'JSON|JSONEmbedded|JSONDetached',
        'supportedFormats' => ['<string>', ...],
    ],
    'target' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

A specified resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

GetSigningProfile

$result = $client->getSigningProfile([/* ... */]);
$promise = $client->getSigningProfileAsync([/* ... */]);

Returns information on a specific signing profile.

Parameter Syntax

$result = $client->getSigningProfile([
    'profileName' => '<string>', // REQUIRED
    'profileOwner' => '<string>',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'overrides' => [
        'signingConfiguration' => [
            'encryptionAlgorithm' => 'RSA|ECDSA',
            'hashAlgorithm' => 'SHA1|SHA256',
        ],
        'signingImageFormat' => 'JSON|JSONEmbedded|JSONDetached',
    ],
    'platformDisplayName' => '<string>',
    'platformId' => '<string>',
    'profileName' => '<string>',
    'profileVersion' => '<string>',
    'profileVersionArn' => '<string>',
    'revocationRecord' => [
        'revocationEffectiveFrom' => <DateTime>,
        'revokedAt' => <DateTime>,
        'revokedBy' => '<string>',
    ],
    'signatureValidityPeriod' => [
        'type' => 'DAYS|MONTHS|YEARS',
        'value' => <integer>,
    ],
    'signingMaterial' => [
        'certificateArn' => '<string>',
    ],
    'signingParameters' => ['<string>', ...],
    'status' => 'Active|Canceled|Revoked',
    'statusReason' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

A specified resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

ListProfilePermissions

$result = $client->listProfilePermissions([/* ... */]);
$promise = $client->listProfilePermissionsAsync([/* ... */]);

Lists the cross-account permissions associated with a signing profile.

Parameter Syntax

$result = $client->listProfilePermissions([
    'nextToken' => '<string>',
    'profileName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'permissions' => [
        [
            'action' => '<string>',
            'principal' => '<string>',
            'profileVersion' => '<string>',
            'statementId' => '<string>',
        ],
        // ...
    ],
    'policySizeBytes' => <integer>,
    'revisionId' => '<string>',
]

Result Details

Errors

ValidationException:

You signing certificate could not be validated.

ResourceNotFoundException:

A specified resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

ListSigningJobs

$result = $client->listSigningJobs([/* ... */]);
$promise = $client->listSigningJobsAsync([/* ... */]);

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Parameter Syntax

$result = $client->listSigningJobs([
    'isRevoked' => true || false,
    'jobInvoker' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'platformId' => '<string>',
    'requestedBy' => '<string>',
    'signatureExpiresAfter' => <integer || string || DateTime>,
    'signatureExpiresBefore' => <integer || string || DateTime>,
    'status' => 'InProgress|Failed|Succeeded',
]);

Parameter Details

Result Syntax

[
    'jobs' => [
        [
            'createdAt' => <DateTime>,
            'isRevoked' => true || false,
            'jobId' => '<string>',
            'jobInvoker' => '<string>',
            'jobOwner' => '<string>',
            'platformDisplayName' => '<string>',
            'platformId' => '<string>',
            'profileName' => '<string>',
            'profileVersion' => '<string>',
            'signatureExpiresAt' => <DateTime>,
            'signedObject' => [
                's3' => [
                    'bucketName' => '<string>',
                    'key' => '<string>',
                ],
            ],
            'signingMaterial' => [
                'certificateArn' => '<string>',
            ],
            'source' => [
                's3' => [
                    'bucketName' => '<string>',
                    'key' => '<string>',
                    'version' => '<string>',
                ],
            ],
            'status' => 'InProgress|Failed|Succeeded',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

You signing certificate could not be validated.

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

ListSigningPlatforms

$result = $client->listSigningPlatforms([/* ... */]);
$promise = $client->listSigningPlatformsAsync([/* ... */]);

Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Parameter Syntax

$result = $client->listSigningPlatforms([
    'category' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'partner' => '<string>',
    'target' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'platforms' => [
        [
            'category' => 'AWSIoT',
            'displayName' => '<string>',
            'maxSizeInMB' => <integer>,
            'partner' => '<string>',
            'platformId' => '<string>',
            'revocationSupported' => true || false,
            'signingConfiguration' => [
                'encryptionAlgorithmOptions' => [
                    'allowedValues' => ['<string>', ...],
                    'defaultValue' => 'RSA|ECDSA',
                ],
                'hashAlgorithmOptions' => [
                    'allowedValues' => ['<string>', ...],
                    'defaultValue' => 'SHA1|SHA256',
                ],
            ],
            'signingImageFormat' => [
                'defaultFormat' => 'JSON|JSONEmbedded|JSONDetached',
                'supportedFormats' => ['<string>', ...],
            ],
            'target' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

You signing certificate could not be validated.

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

ListSigningProfiles

$result = $client->listSigningProfiles([/* ... */]);
$promise = $client->listSigningProfilesAsync([/* ... */]);

Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Parameter Syntax

$result = $client->listSigningProfiles([
    'includeCanceled' => true || false,
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'platformId' => '<string>',
    'statuses' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'profiles' => [
        [
            'arn' => '<string>',
            'platformDisplayName' => '<string>',
            'platformId' => '<string>',
            'profileName' => '<string>',
            'profileVersion' => '<string>',
            'profileVersionArn' => '<string>',
            'signatureValidityPeriod' => [
                'type' => 'DAYS|MONTHS|YEARS',
                'value' => <integer>,
            ],
            'signingMaterial' => [
                'certificateArn' => '<string>',
            ],
            'signingParameters' => ['<string>', ...],
            'status' => 'Active|Canceled|Revoked',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of the tags associated with a signing profile resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

InternalServiceErrorException:

An internal error occurred.

BadRequestException:

The request contains invalid parameters for the ARN or tags. This exception also occurs when you call a tagging API on a cancelled signing profile.

NotFoundException:

The signing profile was not found.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

PutSigningProfile

$result = $client->putSigningProfile([/* ... */]);
$promise = $client->putSigningProfileAsync([/* ... */]);

Creates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.

Parameter Syntax

$result = $client->putSigningProfile([
    'overrides' => [
        'signingConfiguration' => [
            'encryptionAlgorithm' => 'RSA|ECDSA',
            'hashAlgorithm' => 'SHA1|SHA256',
        ],
        'signingImageFormat' => 'JSON|JSONEmbedded|JSONDetached',
    ],
    'platformId' => '<string>', // REQUIRED
    'profileName' => '<string>', // REQUIRED
    'signatureValidityPeriod' => [
        'type' => 'DAYS|MONTHS|YEARS',
        'value' => <integer>,
    ],
    'signingMaterial' => [
        'certificateArn' => '<string>', // REQUIRED
    ],
    'signingParameters' => ['<string>', ...],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'profileVersion' => '<string>',
    'profileVersionArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

A specified resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ValidationException:

You signing certificate could not be validated.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

RemoveProfilePermission

$result = $client->removeProfilePermission([/* ... */]);
$promise = $client->removeProfilePermissionAsync([/* ... */]);

Removes cross-account permissions from a signing profile.

Parameter Syntax

$result = $client->removeProfilePermission([
    'profileName' => '<string>', // REQUIRED
    'revisionId' => '<string>', // REQUIRED
    'statementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'revisionId' => '<string>',
]

Result Details

Errors

ValidationException:

You signing certificate could not be validated.

ResourceNotFoundException:

A specified resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ConflictException:

The resource encountered a conflicting state.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

RevokeSignature

$result = $client->revokeSignature([/* ... */]);
$promise = $client->revokeSignatureAsync([/* ... */]);

Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.

Parameter Syntax

$result = $client->revokeSignature([
    'jobId' => '<string>', // REQUIRED
    'jobOwner' => '<string>',
    'reason' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

You signing certificate could not be validated.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

A specified resource could not be found.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

RevokeSigningProfile

$result = $client->revokeSigningProfile([/* ... */]);
$promise = $client->revokeSigningProfileAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->revokeSigningProfile([
    'effectiveTime' => <integer || string || DateTime>, // REQUIRED
    'profileName' => '<string>', // REQUIRED
    'profileVersion' => '<string>', // REQUIRED
    'reason' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

You signing certificate could not be validated.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

A specified resource could not be found.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

SignPayload

$result = $client->signPayload([/* ... */]);
$promise = $client->signPayloadAsync([/* ... */]);

Signs a binary payload and returns a signature envelope.

Parameter Syntax

$result = $client->signPayload([
    'payload' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'payloadFormat' => '<string>', // REQUIRED
    'profileName' => '<string>', // REQUIRED
    'profileOwner' => '<string>',
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    'jobOwner' => '<string>',
    'metadata' => ['<string>', ...],
    'signature' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

ValidationException:

You signing certificate could not be validated.

ResourceNotFoundException:

A specified resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

StartSigningJob

$result = $client->startSigningJob([/* ... */]);
$promise = $client->startSigningJobAsync([/* ... */]);

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

• You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the Amazon S3 Getting Started Guide.

• Your S3 source bucket must be version enabled.

• You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code.

• You specify the name of the source and destination buckets when calling the StartSigningJob operation.

• You must ensure the S3 buckets are from the same Region as the signing profile. Cross-Region signing isn't supported.

• You must also specify a request token that identifies your request to Signer.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see StartSigningJob.

Parameter Syntax

$result = $client->startSigningJob([
    'clientRequestToken' => '<string>', // REQUIRED
    'destination' => [ // REQUIRED
        's3' => [
            'bucketName' => '<string>',
            'prefix' => '<string>',
        ],
    ],
    'profileName' => '<string>', // REQUIRED
    'profileOwner' => '<string>',
    'source' => [ // REQUIRED
        's3' => [
            'bucketName' => '<string>', // REQUIRED
            'key' => '<string>', // REQUIRED
            'version' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'jobId' => '<string>',
    'jobOwner' => '<string>',
]

Result Details

Errors

ValidationException:

You signing certificate could not be validated.

ResourceNotFoundException:

A specified resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling.

Instead of this error, TooManyRequestsException should be used.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

InternalServiceErrorException:

An internal error occurred.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceErrorException:

An internal error occurred.

BadRequestException:

The request contains invalid parameters for the ARN or tags. This exception also occurs when you call a tagging API on a cancelled signing profile.

NotFoundException:

The signing profile was not found.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceErrorException:

An internal error occurred.

BadRequestException:

The request contains invalid parameters for the ARN or tags. This exception also occurs when you call a tagging API on a cancelled signing profile.

NotFoundException:

The signing profile was not found.

TooManyRequestsException:

The allowed number of job-signing requests has been exceeded.

This error supersedes the error ThrottlingException.