AWS Signer Data Plane 2017-08-25
- Client: Aws\SignerData\SignerDataClient
- Service ID: signer-data
- Version: 2017-08-25
This page describes the parameters and results for the operations of the AWS Signer Data Plane (2017-08-25), and shows how to use the Aws\SignerData\SignerDataClient object to call the described operations. This documentation is specific to the 2017-08-25 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- GetRevocationStatus ( array $params = [] )
- Retrieves the revocation status for a signed artifact by checking if the signing profile, job, or certificate has been revoked.
Operations
GetRevocationStatus
$result = $client->getRevocationStatus([/* ... */]); $promise = $client->getRevocationStatusAsync([/* ... */]);
Retrieves the revocation status for a signed artifact by checking if the signing profile, job, or certificate has been revoked.
Parameter Syntax
$result = $client->getRevocationStatus([
'certificateHashes' => ['<string>', ...], // REQUIRED
'jobArn' => '<string>', // REQUIRED
'platformId' => '<string>', // REQUIRED
'profileVersionArn' => '<string>', // REQUIRED
'signatureTimestamp' => <integer || string || DateTime>, // REQUIRED
]);
Parameter Details
Members
- certificateHashes
-
- Required: Yes
- Type: Array of strings
List of certificate hashes to check for revocation.
- jobArn
-
- Required: Yes
- Type: string
The ARN of the signing job that produced the signature.
- platformId
-
- Required: Yes
- Type: string
The platform identifier for the signing platform used.
- profileVersionArn
-
- Required: Yes
- Type: string
The ARN of the signing profile version used to sign the artifact.
- signatureTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the artifact was signed, in ISO 8601 format.
Result Syntax
[
'revokedEntities' => ['<string>', ...],
]
Result Details
Members
- revokedEntities
-
- Type: Array of strings
List of entity identifiers that have been revoked. Empty if no revocations found.
Errors
- ValidationException:
The request contains invalid parameters or is malformed.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- TooManyRequestsException:
The request was denied due to request throttling.
- InternalServiceErrorException:
An internal service error occurred.
Examples
Example 1: Check revocation status for a signed artifact
Checks if a signing profile, job, or certificate has been revoked for a given artifact.
$result = $client->getRevocationStatus([
'certificateHashes' => [
'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
],
'jobArn' => 'arn:aws:signer:us-east-1:123456789012:/signing-jobs/my-job-id',
'platformId' => 'Notation-OCI-SHA384-ECDSA',
'profileVersionArn' => 'arn:aws:signer:us-east-1:123456789012:/signing-profiles/my-profile/v1',
'signatureTimestamp' => ,
]);
Result syntax:
[
'revokedEntities' => [
],
]
Shapes
AccessDeniedException
Description
You do not have sufficient permissions to perform this action.
Members
- code
-
- Type: string
- message
-
- Type: string
InternalServiceErrorException
Description
An internal service error occurred.
Members
- code
-
- Type: string
- message
-
- Type: string
TooManyRequestsException
Description
The request was denied due to request throttling.
Members
- code
-
- Type: string
- message
-
- Type: string
ValidationException
Description
The request contains invalid parameters or is malformed.
Members
- code
-
- Type: string
- message
-
- Type: string