Interface SignerDataAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface SignerDataAsyncClient
extends AwsClient
Service client for accessing AWS Signer Data Plane asynchronously. This can be created using the static
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
AWS Signer Data Plane service provides APIs for checking revocation status of signed artifacts.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic SignerDataAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aSignerDataAsyncClient.static SignerDataAsyncClientcreate()Create aSignerDataAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.getRevocationStatus(Consumer<GetRevocationStatusRequest.Builder> getRevocationStatusRequest) Retrieves the revocation status for a signed artifact by checking if the signing profile, job, or certificate has been revoked.getRevocationStatus(GetRevocationStatusRequest getRevocationStatusRequest) Retrieves the revocation status for a signed artifact by checking if the signing profile, job, or certificate has been revoked.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
getRevocationStatus
default CompletableFuture<GetRevocationStatusResponse> getRevocationStatus(GetRevocationStatusRequest getRevocationStatusRequest) Retrieves the revocation status for a signed artifact by checking if the signing profile, job, or certificate has been revoked.
- Parameters:
getRevocationStatusRequest- Request structure for checking revocation status.- Returns:
- A Java Future containing the result of the GetRevocationStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SignerDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRevocationStatus
default CompletableFuture<GetRevocationStatusResponse> getRevocationStatus(Consumer<GetRevocationStatusRequest.Builder> getRevocationStatusRequest) Retrieves the revocation status for a signed artifact by checking if the signing profile, job, or certificate has been revoked.
This is a convenience which creates an instance of the
GetRevocationStatusRequest.Builderavoiding the need to create one manually viaGetRevocationStatusRequest.builder()- Parameters:
getRevocationStatusRequest- AConsumerthat will call methods onGetRevocationStatusRequest.Builderto create a request. Request structure for checking revocation status.- Returns:
- A Java Future containing the result of the GetRevocationStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SignerDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aSignerDataAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aSignerDataAsyncClient.
-