AbstractAWSsigner (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.signer.AbstractAWSsigner

All Implemented Interfaces:

AWSsigner

Direct Known Subclasses:

AbstractAWSsignerAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSsigner
extends Object
implements AWSsigner
```
Abstract implementation of AWSsigner. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.signer.AWSsigner
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddProfilePermissionResult`	`addProfilePermission(AddProfilePermissionRequest request)` Adds cross-account permissions to a signing profile.
`CancelSigningProfileResult`	`cancelSigningProfile(CancelSigningProfileRequest request)` Changes the state of an `ACTIVE` signing profile to `CANCELED`.
`DescribeSigningJobResult`	`describeSigningJob(DescribeSigningJobRequest request)` Returns information about a specific code signing job.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetRevocationStatusResult`	`getRevocationStatus(GetRevocationStatusRequest request)` Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.
`GetSigningPlatformResult`	`getSigningPlatform(GetSigningPlatformRequest request)` Returns information on a specific signing platform.
`GetSigningProfileResult`	`getSigningProfile(GetSigningProfileRequest request)` Returns information on a specific signing profile.
`ListProfilePermissionsResult`	`listProfilePermissions(ListProfilePermissionsRequest request)` Lists the cross-account permissions associated with a signing profile.
`ListSigningJobsResult`	`listSigningJobs(ListSigningJobsRequest request)` Lists all your signing jobs.
`ListSigningPlatformsResult`	`listSigningPlatforms(ListSigningPlatformsRequest request)` Lists all signing platforms available in AWS Signer that match the request parameters.
`ListSigningProfilesResult`	`listSigningProfiles(ListSigningProfilesRequest request)` Lists all available signing profiles in your AWS account.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns a list of the tags associated with a signing profile resource.
`PutSigningProfileResult`	`putSigningProfile(PutSigningProfileRequest request)` Creates a signing profile.
`RemoveProfilePermissionResult`	`removeProfilePermission(RemoveProfilePermissionRequest request)` Removes cross-account permissions from a signing profile.
`RevokeSignatureResult`	`revokeSignature(RevokeSignatureRequest request)` Changes the state of a signing job to REVOKED.
`RevokeSigningProfileResult`	`revokeSigningProfile(RevokeSigningProfileRequest request)` Changes the state of a signing profile to REVOKED.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`SignPayloadResult`	`signPayload(SignPayloadRequest request)` Signs a binary payload and returns a signature envelope.
`StartSigningJobResult`	`startSigningJob(StartSigningJobRequest request)` Initiates a signing job to be performed on the code provided.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds one or more tags to a signing profile.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from a signing profile.
`AWSsignerWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addProfilePermission
```
public AddProfilePermissionResult addProfilePermission(AddProfilePermissionRequest request)
```
    Description copied from interface: AWSsigner
    
    Adds cross-account permissions to a signing profile.
    
    Specified by:
    
    addProfilePermission in interface AWSsigner
    
    Returns:
    
    Result of the AddProfilePermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelSigningProfile
```
public CancelSigningProfileResult cancelSigningProfile(CancelSigningProfileRequest request)
```
    Description copied from interface: AWSsigner
    
    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.
    
    Specified by:
    
    cancelSigningProfile in interface AWSsigner
    
    Returns:
    
    Result of the CancelSigningProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeSigningJob
```
public DescribeSigningJobResult describeSigningJob(DescribeSigningJobRequest request)
```
    Description copied from interface: AWSsigner
    
    Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.
    
    Specified by:
    
    describeSigningJob in interface AWSsigner
    
    Returns:
    
    Result of the DescribeSigningJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRevocationStatus
```
public GetRevocationStatusResult getRevocationStatus(GetRevocationStatusRequest request)
```
    Description copied from interface: AWSsigner
    
    Retrieves the revocation status of one or more of the signing profile, signing job, and signing certificate.
    
    Specified by:
    
    getRevocationStatus in interface AWSsigner
    
    Returns:
    
    Result of the GetRevocationStatus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSigningPlatform
```
public GetSigningPlatformResult getSigningPlatform(GetSigningPlatformRequest request)
```
    Description copied from interface: AWSsigner
    
    Returns information on a specific signing platform.
    
    Specified by:
    
    getSigningPlatform in interface AWSsigner
    
    Returns:
    
    Result of the GetSigningPlatform operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSigningProfile
```
public GetSigningProfileResult getSigningProfile(GetSigningProfileRequest request)
```
    Description copied from interface: AWSsigner
    
    Returns information on a specific signing profile.
    
    Specified by:
    
    getSigningProfile in interface AWSsigner
    
    Returns:
    
    Result of the GetSigningProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProfilePermissions
```
public ListProfilePermissionsResult listProfilePermissions(ListProfilePermissionsRequest request)
```
    Description copied from interface: AWSsigner
    
    Lists the cross-account permissions associated with a signing profile.
    
    Specified by:
    
    listProfilePermissions in interface AWSsigner
    
    Returns:
    
    Result of the ListProfilePermissions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSigningJobs
```
public ListSigningJobsResult listSigningJobs(ListSigningJobsRequest request)
```
    Description copied from interface: AWSsigner
    
    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.
    
    Specified by:
    
    listSigningJobs in interface AWSsigner
    
    Returns:
    
    Result of the ListSigningJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSigningPlatforms
```
public ListSigningPlatformsResult listSigningPlatforms(ListSigningPlatformsRequest request)
```
    Description copied from interface: AWSsigner
    
    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.
    
    Specified by:
    
    listSigningPlatforms in interface AWSsigner
    
    Returns:
    
    Result of the ListSigningPlatforms operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSigningProfiles
```
public ListSigningProfilesResult listSigningProfiles(ListSigningProfilesRequest request)
```
    Description copied from interface: AWSsigner
    
    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.
    
    Specified by:
    
    listSigningProfiles in interface AWSsigner
    
    Returns:
    
    Result of the ListSigningProfiles operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSsigner
    
    Returns a list of the tags associated with a signing profile resource.
    
    Specified by:
    
    listTagsForResource in interface AWSsigner
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putSigningProfile
```
public PutSigningProfileResult putSigningProfile(PutSigningProfileRequest request)
```
    Description copied from interface: AWSsigner
    
    Creates a signing profile. A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.
    
    Specified by:
    
    putSigningProfile in interface AWSsigner
    
    Returns:
    
    Result of the PutSigningProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeProfilePermission
```
public RemoveProfilePermissionResult removeProfilePermission(RemoveProfilePermissionRequest request)
```
    Description copied from interface: AWSsigner
    
    Removes cross-account permissions from a signing profile.
    
    Specified by:
    
    removeProfilePermission in interface AWSsigner
    
    Returns:
    
    Result of the RemoveProfilePermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - revokeSignature
```
public RevokeSignatureResult revokeSignature(RevokeSignatureRequest request)
```
    Description copied from interface: AWSsigner
    
    Changes the state of a signing job to REVOKED. This indicates that the signature is no longer valid.
    
    Specified by:
    
    revokeSignature in interface AWSsigner
    
    Returns:
    
    Result of the RevokeSignature operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - revokeSigningProfile
```
public RevokeSigningProfileResult revokeSigningProfile(RevokeSigningProfileRequest request)
```
    Description copied from interface: AWSsigner
    
    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.
    
    Specified by:
    
    revokeSigningProfile in interface AWSsigner
    
    Returns:
    
    Result of the RevokeSigningProfile operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - signPayload
```
public SignPayloadResult signPayload(SignPayloadRequest request)
```
    Description copied from interface: AWSsigner
    
    Signs a binary payload and returns a signature envelope.
    
    Specified by:
    
    signPayload in interface AWSsigner
    
    Returns:
    
    Result of the SignPayload operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startSigningJob
```
public StartSigningJobResult startSigningJob(StartSigningJobRequest request)
```
    Description copied from interface: AWSsigner
    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.
    Specified by:
    
    startSigningJob in interface AWSsigner
    
    Returns:
    
    Result of the StartSigningJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSsigner
    
    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.
    
    Specified by:
    
    tagResource in interface AWSsigner
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSsigner
    
    Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.
    
    Specified by:
    
    untagResource in interface AWSsigner
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSsigner
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSsigner
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSsigner
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSsigner
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AWSsignerWaiters waiters()
```
    Specified by:
    
    waiters in interface AWSsigner

AWS SDK for Java 1.x API Reference - 1.12.792

Class AbstractAWSsigner

Field Summary

Fields inherited from interface com.amazonaws.services.signer.AWSsigner

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addProfilePermission

cancelSigningProfile

describeSigningJob

getRevocationStatus

getSigningPlatform

getSigningProfile

listProfilePermissions

listSigningJobs

listSigningPlatforms

listSigningProfiles

listTagsForResource

putSigningProfile

removeProfilePermission

revokeSignature

revokeSigningProfile

signPayload

startSigningJob

tagResource

untagResource

shutdown

getCachedResponseMetadata

waiters