software.amazon.awssdk.services.signer.SignerAsyncClient Maven / Gradle / Ivy
Show all versions of signer Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.signer;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.signer.model.CancelSigningProfileRequest;
import software.amazon.awssdk.services.signer.model.CancelSigningProfileResponse;
import software.amazon.awssdk.services.signer.model.DescribeSigningJobRequest;
import software.amazon.awssdk.services.signer.model.DescribeSigningJobResponse;
import software.amazon.awssdk.services.signer.model.GetSigningPlatformRequest;
import software.amazon.awssdk.services.signer.model.GetSigningPlatformResponse;
import software.amazon.awssdk.services.signer.model.GetSigningProfileRequest;
import software.amazon.awssdk.services.signer.model.GetSigningProfileResponse;
import software.amazon.awssdk.services.signer.model.ListSigningJobsRequest;
import software.amazon.awssdk.services.signer.model.ListSigningJobsResponse;
import software.amazon.awssdk.services.signer.model.ListSigningPlatformsRequest;
import software.amazon.awssdk.services.signer.model.ListSigningPlatformsResponse;
import software.amazon.awssdk.services.signer.model.ListSigningProfilesRequest;
import software.amazon.awssdk.services.signer.model.ListSigningProfilesResponse;
import software.amazon.awssdk.services.signer.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.signer.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.signer.model.PutSigningProfileRequest;
import software.amazon.awssdk.services.signer.model.PutSigningProfileResponse;
import software.amazon.awssdk.services.signer.model.StartSigningJobRequest;
import software.amazon.awssdk.services.signer.model.StartSigningJobResponse;
import software.amazon.awssdk.services.signer.model.TagResourceRequest;
import software.amazon.awssdk.services.signer.model.TagResourceResponse;
import software.amazon.awssdk.services.signer.model.UntagResourceRequest;
import software.amazon.awssdk.services.signer.model.UntagResourceResponse;
import software.amazon.awssdk.services.signer.paginators.ListSigningJobsPublisher;
import software.amazon.awssdk.services.signer.paginators.ListSigningPlatformsPublisher;
import software.amazon.awssdk.services.signer.paginators.ListSigningProfilesPublisher;
/**
* Service client for accessing signer asynchronously. This can be created using the static {@link #builder()} method.
*
*
* With code signing for IoT, you can sign code that you create for any IoT device that is supported by Amazon Web
* Services (AWS). Code signing is available through Amazon FreeRTOS and AWS IoT Device Management, and integrated with AWS Certificate Manager (ACM). In order to sign code, you
* import a third-party code signing certificate with ACM that is used to sign updates in Amazon FreeRTOS and AWS IoT
* Device Management. For general information about using code signing, see the Code Signing for IoT Developer Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface SignerAsyncClient extends SdkClient {
String SERVICE_NAME = "signer";
/**
* Create a {@link SignerAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static SignerAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link SignerAsyncClient}.
*/
static SignerAsyncClientBuilder builder() {
return new DefaultSignerAsyncClientBuilder();
}
/**
*
* 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.
*
*
* @param cancelSigningProfileRequest
* @return A Java Future containing the result of the CancelSigningProfile operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A specified resource could not be found.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.CancelSigningProfile
* @see AWS
* API Documentation
*/
default CompletableFuture cancelSigningProfile(
CancelSigningProfileRequest cancelSigningProfileRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link CancelSigningProfileRequest.Builder} avoiding the
* need to create one manually via {@link CancelSigningProfileRequest#builder()}
*
*
* @param cancelSigningProfileRequest
* A {@link Consumer} that will call methods on {@link CancelSigningProfileRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CancelSigningProfile operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A specified resource could not be found.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.CancelSigningProfile
* @see AWS
* API Documentation
*/
default CompletableFuture cancelSigningProfile(
Consumer cancelSigningProfileRequest) {
return cancelSigningProfile(CancelSigningProfileRequest.builder().applyMutation(cancelSigningProfileRequest).build());
}
/**
*
* Returns information about a specific code signing job. You specify the job by using the jobId value
* that is returned by the StartSigningJob operation.
*
*
* @param describeSigningJobRequest
* @return A Java Future containing the result of the DescribeSigningJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A specified resource could not be found.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.DescribeSigningJob
* @see AWS API
* Documentation
*/
default CompletableFuture describeSigningJob(DescribeSigningJobRequest describeSigningJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about a specific code signing job. You specify the job by using the jobId value
* that is returned by the StartSigningJob operation.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSigningJobRequest.Builder} avoiding the
* need to create one manually via {@link DescribeSigningJobRequest#builder()}
*
*
* @param describeSigningJobRequest
* A {@link Consumer} that will call methods on {@link DescribeSigningJobRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeSigningJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A specified resource could not be found.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.DescribeSigningJob
* @see AWS API
* Documentation
*/
default CompletableFuture describeSigningJob(
Consumer describeSigningJobRequest) {
return describeSigningJob(DescribeSigningJobRequest.builder().applyMutation(describeSigningJobRequest).build());
}
/**
*
* Returns information on a specific signing platform.
*
*
* @param getSigningPlatformRequest
* @return A Java Future containing the result of the GetSigningPlatform operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A specified resource could not be found.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.GetSigningPlatform
* @see AWS API
* Documentation
*/
default CompletableFuture getSigningPlatform(GetSigningPlatformRequest getSigningPlatformRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information on a specific signing platform.
*
*
*
* This is a convenience which creates an instance of the {@link GetSigningPlatformRequest.Builder} avoiding the
* need to create one manually via {@link GetSigningPlatformRequest#builder()}
*
*
* @param getSigningPlatformRequest
* A {@link Consumer} that will call methods on {@link GetSigningPlatformRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetSigningPlatform operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A specified resource could not be found.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.GetSigningPlatform
* @see AWS API
* Documentation
*/
default CompletableFuture getSigningPlatform(
Consumer getSigningPlatformRequest) {
return getSigningPlatform(GetSigningPlatformRequest.builder().applyMutation(getSigningPlatformRequest).build());
}
/**
*
* Returns information on a specific signing profile.
*
*
* @param getSigningProfileRequest
* @return A Java Future containing the result of the GetSigningProfile operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A specified resource could not be found.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.GetSigningProfile
* @see AWS API
* Documentation
*/
default CompletableFuture getSigningProfile(GetSigningProfileRequest getSigningProfileRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information on a specific signing profile.
*
*
*
* This is a convenience which creates an instance of the {@link GetSigningProfileRequest.Builder} avoiding the need
* to create one manually via {@link GetSigningProfileRequest#builder()}
*
*
* @param getSigningProfileRequest
* A {@link Consumer} that will call methods on {@link GetSigningProfileRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetSigningProfile operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException A specified resource could not be found.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.GetSigningProfile
* @see AWS API
* Documentation
*/
default CompletableFuture getSigningProfile(
Consumer getSigningProfileRequest) {
return getSigningProfile(GetSigningProfileRequest.builder().applyMutation(getSigningProfileRequest).build());
}
/**
*
* 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, code signing 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 code signing returns in the nextToken parameter until all of your
* signing jobs have been returned.
*
*
* @param listSigningJobsRequest
* @return A Java Future containing the result of the ListSigningJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningJobs
* @see AWS API
* Documentation
*/
default CompletableFuture listSigningJobs(ListSigningJobsRequest listSigningJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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, code signing 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 code signing returns in the nextToken parameter until all of your
* signing jobs have been returned.
*
*
*
* This is a convenience which creates an instance of the {@link ListSigningJobsRequest.Builder} avoiding the need
* to create one manually via {@link ListSigningJobsRequest#builder()}
*
*
* @param listSigningJobsRequest
* A {@link Consumer} that will call methods on {@link ListSigningJobsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListSigningJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningJobs
* @see AWS API
* Documentation
*/
default CompletableFuture listSigningJobs(
Consumer listSigningJobsRequest) {
return listSigningJobs(ListSigningJobsRequest.builder().applyMutation(listSigningJobsRequest).build());
}
/**
*
* 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, code signing 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 code signing returns in the nextToken parameter until all of your
* signing jobs have been returned.
*
*
* @return A Java Future containing the result of the ListSigningJobs operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningJobs
* @see AWS API
* Documentation
*/
default CompletableFuture listSigningJobs() {
return listSigningJobs(ListSigningJobsRequest.builder().build());
}
/**
*
* 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, code signing 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 code signing returns in the nextToken parameter until all of your
* signing jobs have been returned.
*
*
*
* This is a variant of
* {@link #listSigningJobs(software.amazon.awssdk.services.signer.model.ListSigningJobsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningJobsPublisher publisher = client.listSigningJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningJobsPublisher publisher = client.listSigningJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.signer.model.ListSigningJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSigningJobs(software.amazon.awssdk.services.signer.model.ListSigningJobsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningJobs
* @see AWS API
* Documentation
*/
default ListSigningJobsPublisher listSigningJobsPaginator() {
return listSigningJobsPaginator(ListSigningJobsRequest.builder().build());
}
/**
*
* 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, code signing 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 code signing returns in the nextToken parameter until all of your
* signing jobs have been returned.
*
*
*
* This is a variant of
* {@link #listSigningJobs(software.amazon.awssdk.services.signer.model.ListSigningJobsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningJobsPublisher publisher = client.listSigningJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningJobsPublisher publisher = client.listSigningJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.signer.model.ListSigningJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSigningJobs(software.amazon.awssdk.services.signer.model.ListSigningJobsRequest)} operation.
*
*
* @param listSigningJobsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningJobs
* @see AWS API
* Documentation
*/
default ListSigningJobsPublisher listSigningJobsPaginator(ListSigningJobsRequest listSigningJobsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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, code signing 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 code signing returns in the nextToken parameter until all of your
* signing jobs have been returned.
*
*
*
* This is a variant of
* {@link #listSigningJobs(software.amazon.awssdk.services.signer.model.ListSigningJobsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningJobsPublisher publisher = client.listSigningJobsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningJobsPublisher publisher = client.listSigningJobsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.signer.model.ListSigningJobsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSigningJobs(software.amazon.awssdk.services.signer.model.ListSigningJobsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListSigningJobsRequest.Builder} avoiding the need
* to create one manually via {@link ListSigningJobsRequest#builder()}
*
*
* @param listSigningJobsRequest
* A {@link Consumer} that will call methods on {@link ListSigningJobsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningJobs
* @see AWS API
* Documentation
*/
default ListSigningJobsPublisher listSigningJobsPaginator(Consumer listSigningJobsRequest) {
return listSigningJobsPaginator(ListSigningJobsRequest.builder().applyMutation(listSigningJobsRequest).build());
}
/**
*
* Lists all signing platforms available in code signing that match the request parameters. If additional jobs
* remain to be listed, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
* @param listSigningPlatformsRequest
* @return A Java Future containing the result of the ListSigningPlatforms operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningPlatforms
* @see AWS
* API Documentation
*/
default CompletableFuture listSigningPlatforms(
ListSigningPlatformsRequest listSigningPlatformsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all signing platforms available in code signing that match the request parameters. If additional jobs
* remain to be listed, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
*
* This is a convenience which creates an instance of the {@link ListSigningPlatformsRequest.Builder} avoiding the
* need to create one manually via {@link ListSigningPlatformsRequest#builder()}
*
*
* @param listSigningPlatformsRequest
* A {@link Consumer} that will call methods on {@link ListSigningPlatformsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListSigningPlatforms operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningPlatforms
* @see AWS
* API Documentation
*/
default CompletableFuture listSigningPlatforms(
Consumer listSigningPlatformsRequest) {
return listSigningPlatforms(ListSigningPlatformsRequest.builder().applyMutation(listSigningPlatformsRequest).build());
}
/**
*
* Lists all signing platforms available in code signing that match the request parameters. If additional jobs
* remain to be listed, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
* @return A Java Future containing the result of the ListSigningPlatforms operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningPlatforms
* @see AWS
* API Documentation
*/
default CompletableFuture listSigningPlatforms() {
return listSigningPlatforms(ListSigningPlatformsRequest.builder().build());
}
/**
*
* Lists all signing platforms available in code signing that match the request parameters. If additional jobs
* remain to be listed, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
*
* This is a variant of
* {@link #listSigningPlatforms(software.amazon.awssdk.services.signer.model.ListSigningPlatformsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningPlatformsPublisher publisher = client.listSigningPlatformsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningPlatformsPublisher publisher = client.listSigningPlatformsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.signer.model.ListSigningPlatformsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSigningPlatforms(software.amazon.awssdk.services.signer.model.ListSigningPlatformsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningPlatforms
* @see AWS
* API Documentation
*/
default ListSigningPlatformsPublisher listSigningPlatformsPaginator() {
return listSigningPlatformsPaginator(ListSigningPlatformsRequest.builder().build());
}
/**
*
* Lists all signing platforms available in code signing that match the request parameters. If additional jobs
* remain to be listed, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
*
* This is a variant of
* {@link #listSigningPlatforms(software.amazon.awssdk.services.signer.model.ListSigningPlatformsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningPlatformsPublisher publisher = client.listSigningPlatformsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningPlatformsPublisher publisher = client.listSigningPlatformsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.signer.model.ListSigningPlatformsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSigningPlatforms(software.amazon.awssdk.services.signer.model.ListSigningPlatformsRequest)}
* operation.
*
*
* @param listSigningPlatformsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningPlatforms
* @see AWS
* API Documentation
*/
default ListSigningPlatformsPublisher listSigningPlatformsPaginator(ListSigningPlatformsRequest listSigningPlatformsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all signing platforms available in code signing that match the request parameters. If additional jobs
* remain to be listed, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
*
* This is a variant of
* {@link #listSigningPlatforms(software.amazon.awssdk.services.signer.model.ListSigningPlatformsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningPlatformsPublisher publisher = client.listSigningPlatformsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningPlatformsPublisher publisher = client.listSigningPlatformsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.signer.model.ListSigningPlatformsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSigningPlatforms(software.amazon.awssdk.services.signer.model.ListSigningPlatformsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListSigningPlatformsRequest.Builder} avoiding the
* need to create one manually via {@link ListSigningPlatformsRequest#builder()}
*
*
* @param listSigningPlatformsRequest
* A {@link Consumer} that will call methods on {@link ListSigningPlatformsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException You signing certificate could not be validated.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningPlatforms
* @see AWS
* API Documentation
*/
default ListSigningPlatformsPublisher listSigningPlatformsPaginator(
Consumer listSigningPlatformsRequest) {
return listSigningPlatformsPaginator(ListSigningPlatformsRequest.builder().applyMutation(listSigningPlatformsRequest)
.build());
}
/**
*
* 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, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
* @param listSigningProfilesRequest
* @return A Java Future containing the result of the ListSigningProfiles operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningProfiles
* @see AWS API
* Documentation
*/
default CompletableFuture listSigningProfiles(
ListSigningProfilesRequest listSigningProfilesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
*
* This is a convenience which creates an instance of the {@link ListSigningProfilesRequest.Builder} avoiding the
* need to create one manually via {@link ListSigningProfilesRequest#builder()}
*
*
* @param listSigningProfilesRequest
* A {@link Consumer} that will call methods on {@link ListSigningProfilesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListSigningProfiles operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningProfiles
* @see AWS API
* Documentation
*/
default CompletableFuture listSigningProfiles(
Consumer listSigningProfilesRequest) {
return listSigningProfiles(ListSigningProfilesRequest.builder().applyMutation(listSigningProfilesRequest).build());
}
/**
*
* 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, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
* @return A Java Future containing the result of the ListSigningProfiles operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningProfiles
* @see AWS API
* Documentation
*/
default CompletableFuture listSigningProfiles() {
return listSigningProfiles(ListSigningProfilesRequest.builder().build());
}
/**
*
* 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, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
*
* This is a variant of
* {@link #listSigningProfiles(software.amazon.awssdk.services.signer.model.ListSigningProfilesRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningProfilesPublisher publisher = client.listSigningProfilesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningProfilesPublisher publisher = client.listSigningProfilesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.signer.model.ListSigningProfilesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSigningProfiles(software.amazon.awssdk.services.signer.model.ListSigningProfilesRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningProfiles
* @see AWS API
* Documentation
*/
default ListSigningProfilesPublisher listSigningProfilesPaginator() {
return listSigningProfilesPaginator(ListSigningProfilesRequest.builder().build());
}
/**
*
* 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, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
*
* This is a variant of
* {@link #listSigningProfiles(software.amazon.awssdk.services.signer.model.ListSigningProfilesRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningProfilesPublisher publisher = client.listSigningProfilesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningProfilesPublisher publisher = client.listSigningProfilesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.signer.model.ListSigningProfilesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSigningProfiles(software.amazon.awssdk.services.signer.model.ListSigningProfilesRequest)}
* operation.
*
*
* @param listSigningProfilesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningProfiles
* @see AWS API
* Documentation
*/
default ListSigningProfilesPublisher listSigningProfilesPaginator(ListSigningProfilesRequest listSigningProfilesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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, code signing 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 code signing returns in the
* nextToken parameter until all of your signing jobs have been returned.
*
*
*
* This is a variant of
* {@link #listSigningProfiles(software.amazon.awssdk.services.signer.model.ListSigningProfilesRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningProfilesPublisher publisher = client.listSigningProfilesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.signer.paginators.ListSigningProfilesPublisher publisher = client.listSigningProfilesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.signer.model.ListSigningProfilesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of maxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listSigningProfiles(software.amazon.awssdk.services.signer.model.ListSigningProfilesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link ListSigningProfilesRequest.Builder} avoiding the
* need to create one manually via {@link ListSigningProfilesRequest#builder()}
*
*
* @param listSigningProfilesRequest
* A {@link Consumer} that will call methods on {@link ListSigningProfilesRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListSigningProfiles
* @see AWS API
* Documentation
*/
default ListSigningProfilesPublisher listSigningProfilesPaginator(
Consumer listSigningProfilesRequest) {
return listSigningProfilesPaginator(ListSigningProfilesRequest.builder().applyMutation(listSigningProfilesRequest)
.build());
}
/**
*
* Returns a list of the tags associated with a signing profile resource.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
* - 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the tags associated with a signing profile resource.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
* - 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsForResource(
Consumer listTagsForResourceRequest) {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* Creates a signing profile. A signing profile is a code signing template that can be used to carry out a
* pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html
*
*
* @param putSigningProfileRequest
* @return A Java Future containing the result of the PutSigningProfile operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.PutSigningProfile
* @see AWS API
* Documentation
*/
default CompletableFuture putSigningProfile(PutSigningProfileRequest putSigningProfileRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a signing profile. A signing profile is a code signing template that can be used to carry out a
* pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html
*
*
*
* This is a convenience which creates an instance of the {@link PutSigningProfileRequest.Builder} avoiding the need
* to create one manually via {@link PutSigningProfileRequest#builder()}
*
*
* @param putSigningProfileRequest
* A {@link Consumer} that will call methods on {@link PutSigningProfileRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutSigningProfile operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
* - ThrottlingException The signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.PutSigningProfile
* @see AWS API
* Documentation
*/
default CompletableFuture putSigningProfile(
Consumer putSigningProfileRequest) {
return putSigningProfile(PutSigningProfileRequest.builder().applyMutation(putSigningProfileRequest).build());
}
/**
*
* 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 Create a Bucket in the Amazon
* S3 Getting Started Guide.
*
*
* -
*
* Your S3 source bucket must be version enabled.
*
*
* -
*
* You must create an S3 destination bucket. Code signing 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 also specify a request token that identifies your request to code signing.
*
*
*
*
* 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 http://docs.aws.amazon.com/acm/latest/userguide/
*
*
* @param startSigningJobRequest
* @return A Java Future containing the result of the StartSigningJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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 signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.StartSigningJob
* @see AWS API
* Documentation
*/
default CompletableFuture startSigningJob(StartSigningJobRequest startSigningJobRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Create a Bucket in the Amazon
* S3 Getting Started Guide.
*
*
* -
*
* Your S3 source bucket must be version enabled.
*
*
* -
*
* You must create an S3 destination bucket. Code signing 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 also specify a request token that identifies your request to code signing.
*
*
*
*
* 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 http://docs.aws.amazon.com/acm/latest/userguide/
*
*
*
* This is a convenience which creates an instance of the {@link StartSigningJobRequest.Builder} avoiding the need
* to create one manually via {@link StartSigningJobRequest#builder()}
*
*
* @param startSigningJobRequest
* A {@link Consumer} that will call methods on {@link StartSigningJobRequest.Builder} to create a request.
* @return A Java Future containing the result of the StartSigningJob operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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 signing job has been throttled.
* - InternalServiceErrorException An internal 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.StartSigningJob
* @see AWS API
* Documentation
*/
default CompletableFuture startSigningJob(
Consumer startSigningJobRequest) {
return startSigningJob(StartSigningJobRequest.builder().applyMutation(startSigningJobRequest).build());
}
/**
*
* 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.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
* - 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(TagResourceRequest tagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on {@link TagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
* - 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.TagResource
* @see AWS API
* Documentation
*/
default CompletableFuture tagResource(Consumer tagResourceRequest) {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
* - 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(UntagResourceRequest untagResourceRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes one or more tags from a signing profile. To remove the tags, specify a list of tag keys.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on {@link UntagResourceRequest.Builder} to create a request.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - 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.
* - 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.
* - SignerException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SignerAsyncClient.UntagResource
* @see AWS API
* Documentation
*/
default CompletableFuture untagResource(Consumer untagResourceRequest) {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
}